Payout Tracking Events

List payout tracking events

Changed on

Returns a paginated list of payout tracking events, newest first.

get/v1/payout_tracking_events

Request

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

Query parameters

limitinteger

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

cursorstring

Opaque cursor from a previous next_cursor.

payout_idstring uuid
Example:550e8400-e29b-41d4-a716-446655440003

Filter tracking events belonging to this payout.

milestone'initiated' | 'submitted' | 'sent' | 'failed' | 'returned' | 'accepted' | 'settled' | 'forwarded' | 'credited' | 'rejected' | 'returning' | 'visibility_lost' | 'other'
Example:credited

Filter by milestone.

is_terminalboolean

Filter by whether Augustus considers delivery finished.

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

Include tracking events 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 tracking events whose created_at is less than or equal to this ISO 8601 timestamp.

Response

List of payout tracking events

has_moreboolean required
next_cursorstring nullable required
has_previousboolean required
previous_cursorstring nullable required

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440008",
      "payout_id": "550e8400-e29b-41d4-a716-446655440003",
      "sequence": 4,
      "milestone": "credited",
      "scope": "end_to_end",
      "source": "swift_gpi",
      "occurred_at": "2026-01-15T10:30:00Z",
      "created_at": "2026-01-15T10:35:00Z",
      "institution": {
        "identifier": {
          "value": "CHASUS33XXX"
        }
      },
      "network_status": {
        "code": "ACCC",
        "reason_code": "G000"
      },
      "fee": {
        "amount": "10.00",
        "currency": "USD",
        "borne_by": "shared"
      },
      "beneficiary_amount": {
        "amount": "100.50",
        "currency": "USD"
      },
      "status_reason": {
        "code": "BENEFICIARY_ACCOUNT_CLOSED",
        "description": "The beneficiary bank reported the account as closed."
      }
    }
  ],
  "next_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0",
  "previous_cursor": "eyJsYXN0X2lkIjoiNTUwZTg0MDAtZTI5Yi00MWQ0LWE3MTYtNDQ2NjU1NDQwMDA2In0"
}

Changes