Get All Payout Transactions

Retrieves payout transaction records for a specified user within a given date range. Supports pagination and sorting.

Request
GET {{base_url}}/api/v1/transaction/payout-query

Authentication & Headers

HeaderRequiredDescriptionExample
x-merchant-refYesUnique reference identifying the merchant.{{vault:x-merchant-ref}}

Query Parameters

ParameterTypeRequiredDescriptionExample
date_fromstringYesStart date for the payout query.2026-03-01
date_tostringYesEnd date for the payout query.2026-03-31
pageintegerYesPage number to retrieve.1
no_recordsintegerYesNumber of records to return per page.10
sortstringYesSort order. Accepts asc or desc.asc
user_refstringYesReference 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_784521

Headers

HeaderValue
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

FieldTypeDescription
statusstringIndicates whether the request was successful.
messagestringResponse message.
dataobjectPayout transaction details.
data.amountnumberAmount paid out.
data.currencystringCurrency of the payout.
data.datestringDate and time of the payout transaction.
data.payment_refstringUnique payment reference for the payout.
data.payment_statusstringCurrent status of the payout payment.
data.payout_dataobjectBank and payout details.
data.payout_data.account_namestringName of the recipient's bank account.
data.payout_data.account_numberstringRecipient's bank account number.
data.payout_data.bank_codestringBank code of the recipient's bank.
data.payout_data.bank_namestringName of the recipient's bank.
data.payout_data.narrationstringDescription or narration attached to the payout.
data.payout_data.session_idstringBank transaction session identifier.
data.txn_merchant_refstringMerchant reference for the payout transaction.

Did this page help you?