Payout to Bank account

Payout to Bank Account

1. Create a new payout

   Start the payout process by sending a POST request to https://gate.qorepay.com/api/v1/payouts/ with the request body similar to the one below:
   
   

   1 {
   2  "client": {
   3    "email": "[email protected]",
   4    "phone": "+2340100000000"
   5  },
   6  "payment": {
   7    "amount": 200000,
   8    "currency": "NGN",
   9    "description": "Your test product."
   10  },
   11  "sender_name": "Sender Name",
   12  "brand_id": "YOUR_BRAND_ID"
   13}
   14

   
   From the response, look for a field called execution_url which should look like this

   1"execution_url": "https://payments.qorepay.com/po/cafac0b4-8a93-4740-8e49-903a3e06e2e3/"

2. Get Bank List

   Get the list of accessible banks and the execution URL by making a GET request to the execution_url gotten above. This will return a list of banks and their codes.
   
   This will return a response similar to the truncated data below:
   
   

   1{
   2  "status": "pending",
   3  "payout_url": "https://gate.qorepay.com/po/xxxxxx/sarepay_payouts/validate",
   4  "detail": {
   5    "success": true,
   6    "data": [
   7      { "code": "120001", "name": "9 PAYMENT SERVICE BANK" },
   8      { "code": "090270", "name": "AB MICROFINANCE BANK" }
   9    ]
   10  }
   11}
   12

3. Validate Account Name

   Using a POST request, submit recipient’s bank info account_number andbank_code to confirm account name to the payout_url.
   
   

   1{
   2  "account_number": "1234567890",
   3  "bank_code": "305"
   4}

   From the response, look for a field called payout_url which should look like this

   1{
   2  "status": "pending",
   3  "payout_url": "https://gate.qorepay.com/po/xxxxxx/sarepay_payouts/create/payout",
   4  "detail": {
   5    "success": true,
   6    "data": {
   7      "account_number": "1234567890",
   8      "account_name": "Anthony"
   9    },
   10    "message": "Action was Succesfull"
   11  }
   12}
   13

4. Make a Payout

   Next, copy out the payout_url from the response above. Make a POST request to the payout_url with no request body
   
   

   1{}

5. Get Payout Status

   Making a payout will return a status of "status": "pending" and when the payout is successful, the status will change to "code": "already_executed"
   
   Alternatively, you can make a GET request to the the URL below using the payout ID gotten from step 1 above to check the status of the payout.

   Request	URL
   GET	https://gate.qorepay.com/api/v1/payouts/your_payout_id