GET
/
api
/
bank
/
/
accounts
/
{accountId}
/
transactions
curl --request GET \
  --url https://api.atoa.me/api/bank//accounts/{accountId}/transactions \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "txn_001",
      "date": "2024-01-14T11:45:00Z",
      "type": "DEBIT",
      "amount": 89.99,
      "currency": "GBP",
      "description": "Amazon Marketplace",
      "reference": "INV-4321-A",
      "transactionCategory": "E-commerce",
      "status": "BOOKED"
      "balance": {"amount": 2.37, "currency": "GBP"}
    }
  ],
  "totalCount": 1,
  "page": 0,
  "itemsPerPage": 30
}

Once bank account access is authorized, use the following API to fetch transaction data.

AUTHORIZATION: Bearer <token>

REQUEST SCHEMA

accountId
string
required

ID of the user’s bank account.

from, before
string
required

Date range for transactions.

page
number
required

Page number.

itemsPerPage
number
required

Number of records per page.

RESPONSE

id
string

A unique identifier for the transaction. Use this to deduplicate or track individual transactions.

date
string

The most recent date associated with the transaction. This may be the booking date or value date depending on the bank.

type
string

Indicates whether the transaction is a CREDIT (money received) or DEBIT (money sent).

amount
number

The monetary value of the transaction. This can be positive or negative based on the type.

currency
string

The currency code (e.g., GBP, EUR) in which the transaction was made

description
string

Any additional information or context provided by the bank. This could include metadata, internal codes, or bank-provided notes.

merchantName
string

The name of the merchant involved in the transaction, if provided by the bank.

transactionCategory
string

A high-level category indicating the nature of the transaction (e.g., Payments, Transfers, ATM, etc.). Helps in transaction classification.

status
string

The current state of the transaction. Can be BOOKED (processed and settled) or PENDING (initiated but not yet fully processed).

balance
object

The account balance immediately after the transaction. Note: This field might not be available for some banks. Includes:

Initiate Account Authorization FlowFetch Bank Account Details