Sign in
Transactions

Get a Transaction by ID

<Callout intent="warning"> The endpoints exposed here are currently in **Beta**! As we continue to build our initial offering, these endpoints may implement breaking changes. Be sure to check back for our change log regularly as a precaution. </Callout>

Retrieve one settled transaction by id, with its per-leg breakdown. Each leg carries a direction (FROM_AGORA or TO_AGORA) and a rail-specific detail keyed by type: token (transactionHash), wire (Fedwire imad), bookTransfer, or instantPayment (confirmationNumber). A fee leg is a manual accounting entry and carries no rail reference. A 404 means no such transaction exists for your organization.

get/v0/transactions/{txnId}

Path parameters

txnIdstring uuid required

Headers

Authorizationstring required

Session JWT from POST /v0/auth/token, sent as Authorization: Bearer <sessionJwt>.

See Authentication for more details.

Response

OK

idstring uuid required

Stable UUID identifying this transaction; pass to the detail endpoint to fetch legs.

initiatedAtstring date-time required

ISO-8601 timestamp of the first leg.

isInstantSettlementboolean required

True if this transaction used Agora's instant-settlement path rather than standard settlement.

legCountinteger required

Number of customer-facing legs in this transaction.

settledAtstring date-time nullable required

ISO-8601 timestamp when the transaction settled. Null until settled.

statusstring required

Lifecycle status. v1 emits only "settled". This is an open, extensible enum; future values (e.g. pending) may appear, so clients must tolerate unknown values.

typestring required

Customer-facing transaction type: mint, redeem, bridge, reward, or return. Treated as an open enum; tolerate unknown values.

Changes

Changed in 1 of the 3 revisions of this API.2

  • 8525bfff76342See the full diff
    • ●

      added the new account_not_provisioned enum value to the code response property for the response status 403

      response-property-enum-value-added

    • ●

      added the new account_verification_pending enum value to the code response property for the response status 403

      response-property-enum-value-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog