Get All Payout Transactions
Retrieves payout transaction records for a specified user within a given date range. Supports pagination and sorting.
RequestGET {{base_url}}/api/v1/transaction/payout-query
Authentication & Headers
| Header | Required | Description | Example |
|---|---|---|---|
x-merchant-ref | Yes | Unique reference identifying the merchant. | {{vault:x-merchant-ref}} |
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
date_from | string | Yes | Start date for the payout query. | 2026-03-01 |
date_to | string | Yes | End date for the payout query. | 2026-03-31 |
page | integer | Yes | Page number to retrieve. | 1 |
no_records | integer | Yes | Number of records to return per page. | 10 |
sort | string | Yes | Sort order. Accepts asc or desc. | asc |
user_ref | string | Yes | Reference of the user associated with the payout. | USR_784521 |
Example Request
{{base_url}}/api/v1/transaction/payout-query?date_from=2026-03-01&date_to=2026-03-31&page=1&no_records=10&sort=asc&user_ref=USR_784521Headers
| Header | Value |
|---|---|
x-merchant-ref | {{vault:x-merchant-ref}} |
Example Response
{
"status": "success",
"message": "Retrieved successfully",
"data": {
"amount": 2750,
"currency": "NGN",
"date": "2026-03-15 14:40",
"payment_ref": "PAY_784521",
"payment_status": "SUCCESSFUL",
"payout_data": {
"account_name": "Michael Adeyemi",
"account_number": "0123456789",
"bank_code": "058",
"bank_name": "Example Bank",
"narration": "Payment for consulting services",
"session_id": "SES_839274615"
},
"txn_merchant_ref": "POT_001245"
}
}Response
| Field | Type | Description |
|---|---|---|
status | string | Indicates whether the request was successful. |
message | string | Response message. |
data | object | Payout transaction details. |
data.amount | number | Amount paid out. |
data.currency | string | Currency of the payout. |
data.date | string | Date and time of the payout transaction. |
data.payment_ref | string | Unique payment reference for the payout. |
data.payment_status | string | Current status of the payout payment. |
data.payout_data | object | Bank and payout details. |
data.payout_data.account_name | string | Name of the recipient's bank account. |
data.payout_data.account_number | string | Recipient's bank account number. |
data.payout_data.bank_code | string | Bank code of the recipient's bank. |
data.payout_data.bank_name | string | Name of the recipient's bank. |
data.payout_data.narration | string | Description or narration attached to the payout. |
data.payout_data.session_id | string | Bank transaction session identifier. |
data.txn_merchant_ref | string | Merchant reference for the payout transaction. |
Updated about 1 month ago
Did this page help you?
