Sign in

v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Get all Payouts

This API lets you view all your payouts

get/disbursements/payouts

Request body

businessstring required

The unique Identifier of the parent business

sourceCurrencystring

The currency which was used to fund the payout

destinationCurrencystring

The currency which the recipient received the payout in

subAccountstring

The unique Identifier of the sub account

statusstring[]

The status of the transactions

pagestring

Specify exactly what page you want to retrieve

perPagestring

Specify exactly what page you want to retrieve per page

dateFromstring

The start date.This must be in ISO 8601 date format(YYYY-MM-DD)

dateTostring

The end date.This must be in ISO 8601 date format(YYYY-MM-DD)

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Payouts fetched successfully",
  "data": {
    "results": [
      {
        "id": 23224,
        "_id": "23224",
        "amountSent": 1000,
        "amountReceived": 1000,
        "sourceCurrency": "NGN",
        "destinationCurrency": "NGN",
        "fee": 100,
        "beneficiaryName": "Hassan Sarz",
        "status": "successful",
        "reference": "3b20fa8e3c324305",
        "businessName": "Lokey Inc",
        "createdAt": "2022-10-25T11:29:35.000Z",
        "updatedAt": "2022-10-25T11:29:43.000Z"
      }
    ],
    "total": 88
  }
}