Accounts

Accounts hold funds used to send payments.

You can:

• Retrieve available accounts
• Check current balances
• View account activity (debits and credits)

Retrieve accounts

Retrieve the list of accounts available to your organisation.

GET /api/account

For full request and response details, see Retrieve Accounts.

Retrieve account balances

Retrieve the current balances for all accounts.

GET /api/accountBalances

For full request and response details, see Retrieve account balances.

Retrieve a specific account balance

Retrieve the balance for a single account.

GET /api/accountBalances/{accountId}

For full request and response details, see Retrieve a specific account balance.

Retrieve account entries

Retrieve the transaction history for a specific account.

GET /api/account/{accountId}

For full request and response details, see Retrieve account entries.

Understanding account entries

Account entries represent all debits (IsDebit = true) and credits (IsDebit = false) recorded against a specific account.

Each entry includes:

• The transaction amount
• The resulting account balance
• The account entry type, for example Payout or Merchant Liquidity
  For more information, see AccountEntryType.
• A timestamp when the entry occurred

Account entries are returned in reverse chronological order, with the most recent activity first. The first entry in an account is always the initial balance (EntryNumber = 0).

Transaction linkage

When a transaction is processed, the corresponding account entry:

• Includes the TransactionRequestId
• May include additional details such as exchange rate and converted values

Running balance

Each entry includes a Balance field showing the account balance after that entry is recorded.

This allows you to track how the balance changes over time.

Pagination

Account entries are returned in pages.

Use query parameters to control pagination:

• count – number of entries to return (maximum 100)
• maxId – return entries with IDs less than this value

If more results are available, the response includes a Links object with a Next Page URL.

When to use each endpoint

Use the following endpoints depending on what you need to retrieve: