Look up a transaction by external reference
Returns the transaction that previously recorded a given
external reference (e.g. a blockchain tx hash, a custody
deposit id, a settlement confirmation id). All three of rail,
kind, value are required and form the lookup tuple.
Use this to verify whether an external event has already been booked before deciding to write a new transaction.
Authorizations
OAuth 2.0 client_credentials grant. Send client_id:client_secret
as HTTP Basic, or as form fields. Tokens are HS256 JWTs valid for
one hour (configurable). Decode them at jwt.io.
Query Parameters
External system / network identifier.
Type of identifier within the rail.
The identifier value.
Comma-separated. postings.account inlines each posting's
account object; balances adds the post-commit balance of every
touched account.
postings.account, balances Response
Matching transaction
Discriminator naming the shape of this resource (e.g. account, transaction).
transaction "account"
"3061ec4e-c959-49ba-a0f6-99186a7bd5d8"
"pi_acme_1234_capture"
Set when this transaction reverses another.
Set when this transaction has been reversed.
Set when this transaction refunds another (partial or full).
Minor units refunded, as a decimal string. Parse with a big-integer or decimal type, never a JS number. Present only on refund transactions.
^-?\d+$Decimal string. Present only when the transaction has postings in more than one currency. The rate that was in effect at write time. It is persisted for audit and restatement, never recomputed.
"1.0823"
Currency that the exchange rate quotes from. Set with exchange_rate.
"USD"
Currency that the exchange rate quotes to. Set with exchange_rate.
"USDC"
Returned only when ?expand=balances.