Skip to main content
GET
/
v1
/
payouts
cURL
curl --request GET \
  --url https://api.paycashless.com/v1/payouts \
  --header 'Request-Signature: <request-signature>' \
  --header 'Request-Timestamp: <request-timestamp>'
{
  "hasMore": true,
  "cursor": "<string>",
  "data": [
    {
      "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>",
      "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"
      },
      "liveMode": true,
      "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 string length: 1
Example:

"5e73d044c44d733fcf819ad3409aaaddca840d421b69cb0b04e2c750fc62ece7526d36296237663ad1f06f62a730c0466516507196b3ce6567493cc52a7cf63d"

​
Request-Timestamp
string
required

UNIX timestamp when the request was created (in seconds)

Example:

"1712336881"

Query Parameters

​
limit
integer
default:10

The number of payouts to return

Required range: 1 <= x <= 100
Example:

10

​
cursor
string
​
destinationAccountNumber
string
​
status
Available options:
pending,
succeeded,
failed,
reversed,
sent,
cancelled
​
createdAt.gte
integer

Minimum UNIX timestamp(in seconds) of when the payout was created (inclusive)

Required range: x > 0
Example:

1712336881

​
createdAt.lte
integer

Maximum UNIX timestamp(in seconds) of when the payout was created (inclusive)

Required range: x > 0
Example:

1712336881

​
createdAt.lt
integer

Maximum UNIX timestamp(in seconds) of when the payout was created (exclusive)

Required range: x > 0
Example:

1712336881

​
createdAt.gt
integer

Minimum UNIX timestamp(in seconds) of when the payout was created (exclusive)

Required range: x > 0
Example:

1712336881

Response

200 - application/json

Payout retrieved

​
hasMore
boolean
required
​
cursor
string | null
required
​
data
object[]
required