Get Bulk Payout

Retrieves the results of a bulk bank payout batch using the batch reference generated when the payout batch was uploaded.

The response provides the total number of payout records, successful and failed transactions, and the transaction details for each payout in the batch.

Request

Method: GET

Endpoint:

{{base_url}}/api/v1/payout/wallet-bank/batch?batch_reference=LBREF-2CC2032A-7CB2-4FAF-974A-D9FD1541FB35-003C6

Authentication & Headers

Header	Type	Required	Description
`x-merchant-ref`	String	Yes	Your unique merchant reference.

Query Parameters

Parameter	Type	Required	Description
`batch_reference`	String	Yes	Unique reference identifying the bulk payout batch.

Example Request

curl --location -g '{{base_url}}/api/v1/payout/wallet-bank/batch?batch_reference=LBREF-2CC2032A-7CB2-4FAF-974A-D9FD1541FB35-003C6' \
--header 'x-merchant-ref: MREFA7B012B203854910AA20F9EA8A2BA7D400B0M'

Response

Success Response

{
  "total": 1000,
  "failed": 0,
  "success": 1000,
  "list": [
    {
      "upload_id": 1,
      "account_number": "1234567890",
      "bank_code": "058",
      "amount": 2000,
      "currency": "NGN",
      "status": "SUCCESSFUL",
      "meta": {}
    }
  ]
}

Response Fields

Field	Type	Description
`total`	Integer	Total number of payout transactions in the batch.
`failed`	Integer	Number of payout transactions that failed.
`success`	Integer	Number of payout transactions that were successful.
`list`	Array	Contains the individual payout transaction records in the batch.
`list[].upload_id`	Integer	Unique identifier for the uploaded payout record.
`list[].account_number`	String	Recipient's bank account number.
`list[].bank_code`	String	Bank code of the recipient's bank or financial institution.
`list[].amount`	Number	Amount processed for the payout.
`list[].currency`	String	Currency of the payout.
`list[].status`	String	Current status of the payout transaction.
`list[].meta`	Object	Additional metadata associated with the payout transaction.

How It Works

Upload a bulk payout CSV using the Bulk Payout endpoint.
Obtain the batch_reference generated for the uploaded batch.
Send a GET request to this endpoint with the batch_reference.
Use the response to view the overall batch results and individual payout statuses.

Updated 25 days ago

Did this page help you?