Agora Public APIEndpointsTransactions

Get a Transaction by ID

Beta
<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 `404` means no such transaction exists for your organization.

Authentication

AuthorizationBearer

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

Path parameters

txnIdstringRequiredformat: "uuid"

Response

OK
idstringformat: "uuid"

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

initiatedAtdatetime

ISO-8601 timestamp of the first leg.

isInstantSettlementboolean

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

legCountinteger

Number of customer-facing legs in this transaction.

recipientobject
The counterparty receiving value, with the totals it received.
settledAtdatetime or null

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

sourceobject
The counterparty sending value, with the totals it sent.
statusstring

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

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

legslist of objects

The customer-facing legs that make up this transaction.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error