GET
/
v1
/
payouts
/
{id}
curl --request GET \
  --url https://api.paycashless.com/v1/payouts/{id} \
  --header 'Request-Signature: <request-signature>' \
  --header 'Request-Timestamp: <request-timestamp>'
{
  "id": "<string>",
  "reference": "<string>",
  "amount": 123,
  "currency": "NGN",
  "status": "pending",
  "destinationAccountNumber": "<string>",
  "destinationBankId": "<string>",
  "fee": 123,
  "vat": 123,
  "networkSessionId": "<string>",
  "requiresConfirmation": true,
  "confirmationState": "pending",
  "callbackUrl": "<string>",
  "receiptEmail": "<string>",
  "narration": "<string>",
  "metadata": {},
  "failureCode": "<string>",
  "failureMessage": "<string>",
  "liveMode": true,
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Headers

​
Request-Signature
string
required

SHA-512 HMAC signature of the request payload using the API secret

Minimum length: 1
Example:

"5e73d044c44d733fcf819ad3409aaaddca840d421b69cb0b04e2c750fc62ece7526d36296237663ad1f06f62a730c0466516507196b3ce6567493cc52a7cf63d"

​
Request-Timestamp
string
required

UNIX timestamp when the request was created (in seconds)

Example:

"1712336881"

Path Parameters

​
id
string
required
Example:

"po_ff0c3z37zi40pvc82g74bgsm4q7fubbw"

Response

200 - application/json

Payout retrieved

The response is of type object.