Skip to main content
GET
Retrieve payout tracking event

Authorizations

Authorization
string
header
required

Bearer token for authentication with Augustus Banking API

Path Parameters

id
string<uuid>
required

Unique identifier of the tracking event.

Example:

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

Response

200 - application/json

The payout tracking event resource

id
string<uuid>
required

Unique identifier of the tracking event.

Example:

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

type
enum<string>
required

Resource type discriminator.

Available options:
payout_tracking_event
payout_id
string<uuid>
required

ID of the payout this event belongs to.

Example:

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

sequence
integer
required

Gap-free counter per payout, in the order Augustus recorded the events. A gap means you missed a recorded event, such as a dropped webhook. A sequence without gaps does not mean every network step was observed.

Required range: 0 < x <= 9007199254740991
Example:

4

milestone
enum<string>
required

Normalized point in the payout journey. New values may be added.

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

"credited"

scope
enum<string>
required

How far Augustus can follow the payout: end_to_end when the rail confirms the beneficiary credit, network when it only confirms settlement. New values may be added.

Available options:
network,
end_to_end
Example:

"end_to_end"

source
enum<string>
required

Where Augustus learned this step: augustus for steps Augustus records itself, swift_gpi for SWIFT gpi statuses, other for any other source. New values may be added.

Available options:
augustus,
swift_gpi,
other
Example:

"swift_gpi"

is_terminal
boolean
required

Whether Augustus considers delivery finished. A later event, such as returned, can still follow.

occurred_at
string<date-time> | null
required

ISO 8601 UTC timestamp when the step happened. Null when the source has no timestamp. Can be out of order with sequence.

Example:

"2026-01-15T10:30:00Z"

created_at
string<date-time>
required

ISO 8601 UTC timestamp when Augustus recorded the event.

Example:

"2026-01-15T10:35:00Z"

institution
object | null
required

Institution that acted on or reported this step. Null when unknown.

network_status
object | null
required

Raw network status. Null when the step has none.

fee
object | null
required

Fee deducted at this step. Null when none was reported.

beneficiary_amount
object | null
required

Amount credited to the beneficiary. Set only on a credited event, otherwise null.

status_reason
object | null
required

Reason for the current state. Null when none applies.