List Transfers

This displays the list of all the initiated transfers.

Initialization.

GET /payouts

The snippet below outlines the parameters you can use when fetching the list of transactions.

Field Name
Description
Data Type
Required?

after

A cursor identifying the position to start after

String

No

before

A cursor identifying the position to start before

String

No

limit

The maximum number of records to return

Integer

No

Responses

Code
Description

200

Beneficiary Response

{
  "data": [
    {
      "beneficiary": {
        "account_name": "string",
        "account_number": "string",
        "account_type": "string",
        "bank_name": "string",
        "id": "string",
        "type": "string"
      },
      "beneficiary_type": "bank_account",
      "created_at": "2024-04-05T15:06:43.600Z",
      "destination_amount": 100000,
      "destination_currency": "AUD",
      "id": "string",
      "source_amount": 100000,
      "source_currency": "AUD",
      "status": "string",
      "updated_at": "2024-04-05T15:06:43.600Z"
    }
  ],
  "pagination": {
    "after": "string",
    "before": "string",
    "limit": 0
  }
}

Last updated