Skip to main content
GET
Look up a transaction by external reference

Authorizations

Authorization
string
header
required

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

rail
string
required

External system / network identifier.

kind
string
required

Type of identifier within the rail.

value
string
required

The identifier value.

expand
enum<string>[]

Comma-separated. postings.account inlines each posting's account object; balances adds the post-commit balance of every touched account.

Available options:
postings.account,
balances

Response

Matching transaction

object
enum<string>
required

Discriminator naming the shape of this resource (e.g. account, transaction).

Available options:
transaction
Example:

"account"

id
string<uuid>
required
Example:

"3061ec4e-c959-49ba-a0f6-99186a7bd5d8"

postings
object[]
required
idempotency_key
string
Example:

"pi_acme_1234_capture"

reverses
string<uuid> | null

Set when this transaction reverses another.

reversed_by
string<uuid> | null

Set when this transaction has been reversed.

refunds
string<uuid> | null

Set when this transaction refunds another (partial or full).

refund_amount
string | null

Minor units refunded, as a decimal string. Parse with a big-integer or decimal type, never a JS number. Present only on refund transactions.

Pattern: ^-?\d+$
exchange_rate
string | null

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.

Example:

"1.0823"

base_currency
string | null

Currency that the exchange rate quotes from. Set with exchange_rate.

Example:

"USD"

quote_currency
string | null

Currency that the exchange rate quotes to. Set with exchange_rate.

Example:

"USDC"

metadata
object
Example:
balances
object[]

Returned only when ?expand=balances.

value_date
string<date-time>
booking_date
string<date-time>
created_at
string<date-time>
updated_at
string<date-time>