Get Specific Payout

Retrieves the details of a specific payout transaction using the transaction merchant reference and user reference.

Request

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

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
`txn_merchant_ref`	string	Yes	Unique merchant reference of the payout transaction.	`POT_001245`
`user_ref`	string	Yes	Reference of the user associated with the payout.	`USR_784521`

Example Request

{{base_url}}/api/v1/payout/data?txn_merchant_ref=POT_001245&user_ref=USR_784521

Headers

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	Details of the requested payout transaction.
`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 20 days ago

Did this page help you?