Skip to main content
GET
List payout tracking events

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.

payout_id
string<uuid>

Filter tracking events belonging to this payout.

Example:

"550e8400-e29b-41d4-a716-446655440003"

milestone
enum<string>

Filter by milestone.

Available options:
initiated,
submitted,
sent,
failed,
returned,
accepted,
settled,
forwarded,
credited,
rejected,
returning,
visibility_lost,
other
Example:

"credited"

is_terminal
boolean

Filter by whether Augustus considers delivery finished.

created_at.gte
string<date-time>

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

Example:

"2026-01-01T00:00:00Z"

created_at.lte
string<date-time>

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

Example:

"2026-02-01T00:00:00Z"

Response

200 - application/json

List of payout tracking events

data
object[]
required
has_more
boolean
required
next_cursor
string | null
required
Example:

"eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0"

has_previous
boolean
required
previous_cursor
string | null
required
Example:

"eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0"