Get transaction
Returns a single transaction by UUID. Responds 404 when the transaction does not belong to the
company in X-On-Behalf-Of or sits in an account the API key’s member cannot access.
Authorizations
Short-lived access token. Obtain with your api_key.
Path Parameters
Transaction UUID.
Query Parameters
true includes a user object when the transaction has a user_id.
true includes a card object when the transaction has a card_token.
Response
The transaction.
A transaction on one of the company's accounts. Optional fields are omitted from the JSON when they have no value.
Amounts are signed: debit transactions carry negative values, credit transactions positive values.
Transaction UUID. Stable across status changes and matches the data.id in transaction webhooks.
Identifier of the payment in the originating source system.
Company UUID that owns the transaction.
UUID of the account the transaction belongs to.
Human-readable label (merchant, payee, or sender name).
Lifecycle status. pending transitions to completed, declined, or reversed; the other states are terminal.
pending, completed, declined, reversed Transaction type.
card, atm, refund, credit, out, in, fee, exchange_out, exchange_in, transfer_out, transfer_in, chargeback, reversal, adjustment, loyalty_in, loyalty_out, points_in, points_out, trophy, referral, direct_debit, direct_credit, direct_credit_return, recall debit for money leaving the account, credit for money arriving.
debit, credit When the transaction occurred. Default sort key.
Signed amount in the account currency. null only for rows with no amount yet.
Posted ledger balance of the account immediately after this transaction, ordered by transaction_at. Excludes pending holds.
When the transaction record was created.
When the transaction record was last updated.
(Optional) For transfer_* and exchange_* types, the other company account involved.
(Optional) Free-text payment reference.
(Optional) Payee identifier for outbound payments.
(Optional) Payment rail used, for example local.
(Optional) Payment purpose code where the rail requires one.
(Optional) Underlying payment provider.
(Optional) Reconciliation reference from the provider.
(Optional) When the transaction was authorised.
(Optional) When the transaction settled. Set once status is completed.
(Optional) For scheduled payments, when the payment is due to execute.
(Optional) Fee charged, as a negative amount in the account currency. Omitted when zero.
(Optional) Signed amount in the currency the transaction was made in.
(Optional) Signed amount in the company's base currency.
(Optional) transaction_amount / account_amount, present only when the two currencies differ. Six decimal places.
(Optional) Reward points earned or redeemed.
(Optional) Merchant details as received from the card network.
(Optional) Incard merchant identifier once the merchant has been recognised.
(Optional) Display details for a recognised merchant.
(Optional) Spend category UUID.
(Optional) Accounting code assigned to the transaction.
(Optional) UUID of the user who initiated the transaction.
(Optional) Included when user=true and user_id is set.
(Optional) Token of the card used, for card and atm types.
(Optional) Included when card=true and card_token is set.
(Optional) Trophy UUID for trophy rewards.
(Optional) Reason the transaction was declined.
(Optional) Note added by a team member.