Get all payout transactions

Retrieves payout transaction details using the merchant transaction reference and user reference.

Endpoint

GET {{base_url}}/api/v1/payout/data

Authentication

Bearer Token

Headers

Header	Required	Description
`Authorization`	Yes	Bearer token used to authenticate the request.
`x-merchant-ref`	Yes	Merchant reference.

Query Parameters

Parameter	Type	Required	Description
`txn_merchant_ref`	string	Yes	Merchant reference assigned to the payout transaction.
`user_ref`	string	Yes	Unique reference identifying the user associated with the payout.

Example Request

curl --location -g '{{base_url}}/api/v1/payout/data?txn_merchant_ref=T123ASDEWSSSAQWES&user_ref={USER_REF}' \
--header 'Authorization: Bearer {{bearer_token}}' \
--header 'x-merchant-ref: {{x-merchant-ref}}'

Success Response

{
  "status": "success",
  "message": "Retrieved successfully",
  "data": {
    "amount": 1500,
    "currency": "NGN",
    "date": "2026-03-05 4:40",
    "payment_ref": "LBX344444",
    "payment_status": "SUCCESSFUL",
    "payout_data": {
      "account_name": "John Doe",
      "account_number": "0027320995",
      "bank_code": "067",
      "bank_name": "GTB",
      "narration": "payment for services",
      "session_id": "2333333333222"
    },
    "txn_merchant_ref": "T123XX"
  }
}

Response Fields

Field	Description
`status`	Indicates whether the request was successful.
`message`	Response message.
`data.amount`	Amount of the payout transaction.
`data.currency`	Currency of the payout.
`data.date`	Date and time the transaction was processed.
`data.payment_ref`	LedgerBlock payment reference for the transaction.
`data.payment_status`	Current status of the payout transaction.
`data.payout_data.account_name`	Name of the payout recipient.
`data.payout_data.account_number`	Recipient's bank account number.
`data.payout_data.bank_code`	Code identifying the recipient's bank.
`data.payout_data.bank_name`	Name of the recipient's bank.
`data.payout_data.narration`	Description or narration attached to the payout.
`data.payout_data.session_id`	Bank transaction session ID.
`data.txn_merchant_ref`	Merchant reference for the payout transaction.

Updated 21 days ago

Did this page help you?