Scope: accounting:banks.read https://api.alladdin.com/api/v2/treasury/accounts

Returns a cursor-paginated list of banking accounts in your account.
Use archived=true to retrieve only archived accounts, archived=false for only active accounts, or omit the parameter to return both. Use the cursor returned by ApiListResponse to fetch the next page; limit defaults to the standard list page size and is capped at the API-wide maximum.

Parameters

Query parameters

cursor string optional

Opaque cursor for pagination

limit integer optional = 50

Maximum number of banking accounts to return per page

type string optional

Filter banking accounts by account type. Allowed values: bank (bank account), card (credit or debit card), gateway (payment gateway such as Stripe or PayPal), cash (cash register / petty cash).

"bank" "card" "gateway" "cash" archived boolean optional

Filter by archived state. true returns only archived accounts, false returns only active accounts. Omit to return both (default).

Request

import requests

url = "https://api.alladdin.com/api/v2/treasury/accounts?cursor=value&limit=50&type=value"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "name": "Main bank account",
      "type": "bank",
      "currency": "EUR",
      "balance": "15230.50",
      "iban": "ES9121000418450200051332",
      "bic": "CAIXESBBXXX",
      "account_number": "string",
      "creditor_id": "string",
      "issuer_id": "string",
      "archived": false,
      "synced_at": "2024-01-15T10:30:00Z",
      "transactions_pending_to_reconcile": 148
    }
  ],
  "cursor": "string",
  "has_more": false
}

Success responses

200 List of banking accounts application/json object items[] object[] id string

Unique identifier of the banking account

name string

Display name of the banking account

type string

Type of banking account

Enum: bank card gateway cash currency string

ISO 4217 currency code of the account

balance string

Decimal as string for precision

iban string | null

IBAN number of the bank account

bic string | null

SWIFT/BIC code of the bank

account_number string | null

Bank account number when IBAN is not available

creditor_id string | null

SEPA creditor identifier for direct debits

issuer_id string | null

Issuer identifier used in remittances

archived boolean

Whether the banking account is archived

synced_at string<date-time> | null

Timestamp of the last bank synchronization

transactions_pending_to_reconcile integer

Number of transactions pending reconciliation in the last 12 months for this account (precomputed, not a live count).

cursor string | null has_more boolean

Error responses

400 Bad request application/json 401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json

← PreviousCreate one or multiple manual bank movements →

Next →Create a banking account →