Retrieves details for a specific payout transaction.

Method: GET

Endpoint:

{{base_url}}/api/v1/payout/data?txn_merchant_ref=TXN-REF-001&user_ref=USER-REF-001

Headers

Header	Value
Authorization	`Bearer <token>`
x-merchant-ref	`<merchant-ref>`
Content-Type	`application/json`

Query Parameters

Parameter	Required	Description
`txn_merchant_ref`	Yes	Merchant reference for the payout transaction
`user_ref`	Yes	Reference of the user who initiated the payout

Response

{
  "status": "success",
  "message": "Retrieved successfully",
  "data": {
    "amount": 5000,
    "currency": "NGN",
    "date": "2026-04-10 14:30",
    "payment_ref": "PAY-REF-001",
    "payment_status": "SUCCESSFUL",
    "payout_data": {
      "account_name": "Test User",
      "account_number": "0123456789",
      "bank_code": "000001",
      "bank_name": "Test Bank",
      "narration": "Payment for services",
      "session_id": "SESSION-REF-001"
    },
    "txn_merchant_ref": "TXN-REF-001"
  }
}

Response Fields

Field	Description
`amount`	Amount paid out
`currency`	Currency of the payout
`date`	Date and time the payout was processed
`payment_ref`	LedgerBlock payment reference
`payment_status`	Current status of the payout
`payout_data.account_name`	Recipient's account name
`payout_data.account_number`	Recipient's account number
`payout_data.bank_code`	Recipient bank code
`payout_data.bank_name`	Recipient bank name
`payout_data.narration`	Payout narration
`payout_data.session_id`	Bank/payment session reference
`txn_merchant_ref`	Merchant reference for the transaction

Query Payout

Retrieves multiple payout transactions based on date range, pagination, sorting, and optionally a user reference.

Method: GET

Endpoint:

{{base_url}}/api/v1/transaction/payout-query?date_from=2026-01-01&date_to=2026-02-01&page=1&no_records=10&sort=asc&user_ref=USER-REF-001

Headers

Header	Value
Authorization	`Bearer <token>`
x-merchant-ref	`<merchant-ref>`
Content-Type	`application/json`

Query Parameters

Parameter	Required	Description
`date_from`	Yes	Start date for the search
`date_to`	Yes	End date for the search
`page`	Yes	Page number
`no_records`	Yes	Number of records to return
`sort`	Yes	Sort order: `asc` or `desc`
`user_ref`	No	User reference used to filter payouts for a specific user

Response

{
  "status": "success",
  "message": "Retrieved successfully",
  "data": [
    {
      "amount": 5000,
      "currency": "NGN",
      "date": "2026-04-10 14:30",
      "payment_ref": "PAY-REF-001",
      "payment_status": "SUCCESSFUL",
      "payout_data": {
        "account_name": "Test User",
        "account_number": "0123456789",
        "bank_code": "000001",
        "bank_name": "Test Bank",
        "narration": "Payment for services",
        "session_id": "SESSION-REF-001"
      },
      "txn_merchant_ref": "TXN-REF-001"
    }
  ]
}

Response Fields

The response contains the same payout transaction details as the Get Payout endpoint, but returns them as an array under data. This allows multiple payout transactions to be retrieved in a single request.