Payout Tracking Events

Retrieve payout tracking event

Changed on

Retrieves a payout tracking event by ID.

get/v1/payout_tracking_events/{id}

Request

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

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440008

Unique identifier of the tracking event.

Response

The payout tracking event resource

idstring uuid required

Unique identifier of the tracking event.

type'payout_tracking_event' required

Resource type discriminator.

payout_idstring uuid required

ID of the payout this event belongs to.

sequenceinteger 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.

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

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

scope'network' | 'end_to_end' 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.

source'augustus' | 'swift_gpi' | 'other' 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.

is_terminalboolean required

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

occurred_atstring date-time nullable required

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

created_atstring date-time required

ISO 8601 UTC timestamp when Augustus recorded the event.

Example response

{
  "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."
  }
}

Changes