Sign in

v2

latestSwagger 2.02026-08-0610101.9 MB
Transactions

Get transaction

Yields a bank account transaction

get/v0/bank/transactions/{transaction-id}

Path parameters

transaction-idstring required

Response

OK

processed-atstring date-time required

When the transaction was entered into the account ledger.

post-datetimestring date-time

Deprecated. Please use processed-at instead.

balance-change-direction'credit' | 'debit' required

Specifies the direction of a balance change.

origin-metadataobject

Identifiers from the system that originated the hold or transaction. Keys and values are originator-specific.

effective-atstring date-time required

When the transaction actually takes effect on the account balance.

transaction-origin-type'interest' | 'deposit' | 'manual-payment' | 'card-transaction' | 'fee' | 'transfer' | 'payment' | 'commission' required

Indicates the source of the transaction. For a description of each origin type, see our guide to transactions.

payment-urlstring

Link to the payment resource.

referencestring

This field is provided by the person or entity who made the payment.

descriptionstring

This field is provided by the bank to help customers understand the nature of the transaction.

Example response

{
  "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
  "reference": "Restaurant Charge - Sushi Palace",
  "balance-change": {
    "currency": "GBP",
    "value": "1000.00"
  },
  "account-balance": {
    "currency": "GBP",
    "value": "1000.00"
  },
  "description": "Interest earned in April from Alexa account."
}