For the complete documentation index, see llms.txt. This page is also available as Markdown.
🏦How to get your account, balance, and transaction data
The Account information API allows you access to your account and transaction data. It can be used to retrieve things like account details and balances.
Using Postman
If you’re new to APIs and want to get familiar with using the endpoints, we recommend you create a Postman account (it's free) and use the Postman collections provided to test things out.
It includes collections for the 🏦 Private Banking, 🧰 Corporate Investment Banking (CIB) and 💳Programmable card APIs.
1. Get your accounts and account ID with Postman
Follow these steps for 🏦 Private Banking and 🧰 CIB, using the appropriate Postman collection and API endpoints as above.
Ensure have authenticated and pasted in your bearer token into the "Variables" tables.
Navigate to the Accounts folder and the GET Accountsquery
Hit Send to make a call to the account information API endpoint (no additional parameters need to be set).
The Accounts query will returns accountID as well as account balance for 🧰 CIB.
The JSON response will include all of your accounts and each account has a unique ID (accountID) that you will use when transacting against it.
Example response for 🏦 Private BankingExample response for 🧰 CIB
2. Get your account balance with Postman
Follow these steps for 🏦 Private Banking using the appropriate Postman collection and API endpoints as above. The account balance for 🧰 CIB is included in the Get Accounts request.
Retrieve the accountID from your previous call to get accounts.
Head over to the "Variables" table to insert your accountID. You can also set it under the Params tab on the query page.
Navigate to the Accounts folder and the GET Account Balance query .
Hit Send to make a call to the API endpoint.
Example response for 🏦 Private Banking
3. Get your transaction data with Postman
Follow these steps for 🏦 Private Banking and 🧰 CIB, using the appropriate Postman collection and API endpoints as above.
Ensure you have added your accountID to the "Variables" table
Navigate to the GET Account transactions query and set the dates for which you would like to view the transactions by selecting fromDate and toDate in the Query params table and adding the dates.
fromDate and toDate can be any formatted ISO 8601 date [Example of formatted date: 1999-09-09]].
Hit Send to make a call to the API endpoint.
Example response for 🏦 Private BankExample response for 🧰 CIB
Pro Tips:
You may have noticed, the endpoint accepts a pagination parameter for when you need to iterate through a longer transaction history.
Filtering can be done using the postingdate
postingdate is the date at which the transaction affects your balance
transactiondate is the date on which the transaction took place (day the card was physically swiped)
