Payouts

List payouts

Changed on

Lists payouts for the merchant with cursor-based pagination.

get/v1/payouts

Request

  • Base URL
    https://api.augustus.com
  • URL
    https://api.augustus.com/v1/payouts
  • Auth
    HTTP bearer

Query parameters

limitinteger

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

cursorstring

Opaque cursor from a previous next_cursor.

status'initiated' | 'submitted' | 'sent' | 'failed' | 'returned'
Example:sent

Filter by payout status.

created_at.gtestring date-time
Example:2026-01-01T00:00:00Z

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

created_at.ltestring date-time
Example:2026-02-01T00:00:00Z

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

currenciesstring[]

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

[
  "USD"
]
rail'sepa' | 'sepa_instant' | 'faster_payments' | 'swift' | 'internal' | 'target' | 'ach' | 'fedwire' | 'bitcoin' | 'bitcoin_testnet4' | 'ethereum' | 'ethereum_sepolia' | 'solana' | 'solana_devnet' | 'polygon' | 'polygon_amoy'

Filter by payout rail.

Response

Paginated list of payouts

has_moreboolean required
next_cursorstring nullable required
has_previousboolean required
previous_cursorstring nullable required

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440003",
      "status": "sent",
      "account_id": "550e8400-e29b-41d4-a716-446655440001",
      "amount": "100.50",
      "currency": "USD",
      "counterparty_id": "550e8400-e29b-41d4-a716-446655440000",
      "unstructured_remittance_information": "INV-2026-0042",
      "tracking_reference": {
        "type": "uetr",
        "value": "550e8400-e29b-41d4-a716-446655440000"
      },
      "metadata": {
        "invoice_id": "INV-2026-0042"
      },
      "initiated_at": "2026-01-15T10:30:00Z",
      "sent_at": "2026-01-15T10:35:00Z",
      "rail": "ach"
    }
  ],
  "next_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0",
  "previous_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0"
}

Changes