Skip to main content
GET
JavaScript

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.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
created_at.lte
string<date-time>

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

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
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
has_more
boolean
required
next_cursor
string | null
required