Skip to navigation

Get a Transaction by ID

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.

Authentication

AuthorizationBearer

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

See Authentication for more details.

Path parameters

txnIdstringRequiredformat: "uuid"

Response

OK
idstringformat: "uuid"

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

failureReasonstring or null

Why a tokenConversion failed: BLOCKED_WALLET, EXPIRED, INSUFFICIENT_FUNDS, OTHER, PROVIDER_UNAVAILABLE, or SLIPPAGE. Null unless type is tokenConversion and status is failed. Open enum; tolerate unknown values.

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.
refundFailureReasonstring or null

Why returning a failed tokenConversion’s deposit also failed, so it will not come back on its own: AMOUNT_TOO_LOW, MANUAL_REVIEW, or OTHER. Null unless type is tokenConversion and status is failed. Open enum; tolerate unknown values.

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. Always settled unless type is tokenConversion. A tokenConversion starts pending (deposit received, conversion not yet sent), moves to submitted (conversion sent on the destination chain), and ends settled, refunded (deposit returned), or failed (see failureReason and refundFailureReason). A failed conversion can still move to settled or refunded. Open enum; tolerate unknown values.

typestring

Customer-facing transaction type: mint, redeem, bridge, reward, return, or tokenConversion. 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