GET
/
v1
/
payouts
/
verify
/
{reference}
cURL
curl --request GET \
  --url https://api.paycashless.com/v1/payouts/verify/{reference} \
  --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,
  "initiation": {
    "actor": "user",
    "ip": "<string>",
    "user": {
      "email": "<string>"
    },
    "apiKey": {
      "description": "<string>"
    }
  },
  "approval": {
    "approvedBy": "<string>",
    "approvedAt": "2023-11-07T05:31:56Z"
  },
  "cancellation": {
    "cancelledBy": "<string>",
    "cancelledAt": "2023-11-07T05:31:56Z"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

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

reference
string
required

The reference of the payout to verify

Response

200 - application/json

Payout retrieved by reference

id
string
required
reference
string
required
amount
integer
required
currency
enum<string>
required
Available options:
NGN,
USD
status
enum<string>
required
Available options:
pending,
succeeded,
failed,
reversed,
sent,
cancelled
destinationAccountNumber
string
required
destinationBankId
string
required
fee
integer
required
vat
integer
required
networkSessionId
string | null
required
requiresConfirmation
boolean
required
confirmationState
enum<string>
required
Available options:
pending,
confirmed,
rejected
callbackUrl
string | null
required
receiptEmail
string | null
required
narration
string | null
required
metadata
object | null
required
failureCode
string | null
required
failureMessage
string | null
required
liveMode
boolean
required
initiation
object
required
approval
object | null
required
cancellation
object | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required