QorePay logo
QorePay logo

Payouts with QorePay APIs

Introduction

You can effortlessly make payouts directly to your bank account using QorePay APIs.

Payout to Bank account

⚠️

Pro tips

  • When submitting an amount, append two zeros (00) to the end
  • To ensure precision in the amount specified for payouts through our banking APIs, it's important to follow this specific format. This indicates the local unit of kobo or cent, ensuring accurate representation.
  • Example: If your desired payout amount is NGN 5, represent it in the API request body as:500

Payout to Bank Account

  1. Create a new payout

    1 {
    2  "client": {
    3    "email": "[email protected]",
    4    "phone": "+2348181927251"
    5  },
    6  "payment": {
    7    "amount": 500,
    8    "currency": "NGN",
    9    "description": "This is a description Testing again"
    10  },
    11  "sender_name": "Sender Name",
    12  "brand_id": "{{brand_id}}"
    13}

    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/86027ffa-de3d-4b18-a1cb-804a2670ed31/sarepay_payouts/create/payout",
    4  "detail": {
    5        "success": true,
    6        "data": [
    7            {
    8                "code": "120001",
    9                "name": "9 PAYMENT SERVICE BANK"
    10            },
    11            {
    12                "code": "090270",
    13                "name": "AB MICROFINANCE BANK"
    14            },
    15            {
    16                "code": "090260",
    17                "name": "ABOVE ONLY MICROFINANCE BANK"
    18            },
    19            ...
    20        ]
    21    }
    22  }
  3. Make a Payout

    Next, copy out the payout_url from the response above. Make a POST request to the payout_url with the following parameters:

    1{
    2  "account_number": "0694635405",
    3  "bank_code": "044",
    4  "recipient_name": "Bank Account Holder"
    5}
  4. 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.
    RequestURL

    GET

    https://gate.qorepay.com/api/v1/payouts/your_payout_id

ON THIS PAGE

Create a new payout

Get Bank List

Make a payout

Check payout status