List payouts

Lists payouts for the merchant with cursor-based pagination.

GET /v1/payouts

JavaScript

JavaScript

import Augustus from '@augustusbank/typescript-sdk';

const client = new Augustus({
  apiKey: process.env['AUGUSTUS_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const payoutListResponse of client.payouts.list()) {
  console.log(payoutListResponse.id);
}

200

{
  "data": [
    {
      "id": "<string>",
      "source_account_id": "<string>",
      "amount": "<string>",
      "destination": {
        "iban": "<string>",
        "account_holder_name": "<string>",
        "bic": "<string>"
      },
      "reference": "<string>",
      "failure": {
        "message": "<string>",
        "retry": true
      },
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer token for authentication with Augustus Banking API

Query Parameters

limit · integer · default: 10

Number of results per page (1-100). Defaults to 10.

Required range: 1 < x < 100

cursor · string

Opaque cursor from a previous next_cursor.

status · enum<string>

Filter by payout status.

Available options: pending, paid, failed

created_at.gte · string<date-time>

Include payouts whose created_at is greater than or equal to this ISO 8601 timestamp.

created_at.lte · string<date-time>

Include payouts whose created_at is less than or equal to this ISO 8601 timestamp.

currencies · enum<string>[]

Filter to these currency codes. Use a separate currencies query parameter for each value (e.g. ?currencies=EUR&currencies=USD).

Minimum array length: 1

Available options: EUR, GBP, USD, USDC

Response

200 - application/json

Paginated list of payouts

data · object[] · required

Show child attributes

has_more · boolean · required

next_cursor · string | null · required