Dive into our API reference
The Banking Circle API is designed to provide your company and your customers with easy and secure access to bank accounts, effective and secure management of money transfers and payments, and other services.
Start by being authorized to get your certificates, username, passwords etc. from Banking Circle Client Services team here.
As per RESTful design patterns, you can use the following HTTP verbs:
GET = Retrieve a resource
POST = Create a new resource
PUT = Modify an existing resource
DELETE = Remove a resource
The API enables you to read and perform operations on Banking Circle accounts, where your company’s funds are placed. The “Balances” endpoint allows you to read how much funding is left on the account. The “Bookings” endpoint details spending and money influx. You can also use an account to distribute and collect funds – e.g. to pay suppliers or to collect payments from customers.
To use the Account API, you send a GET accounts request with a valid token to check if you have permission to access all the accounts you need. Contact Client Services if you are missing account access. After finding out what accounts are associated with which account IDs, you can request account details, balances, and booking per account.
The Authorization Service has a single endpoint that requires the use of a pre-registered certificate. When you are authenticated, you will get a JSON Web Token (JWT) that is your authorization key to access every other endpoint at Banking Circle. For machine-to machine users, we use a standard signed OAuth2 token.
The access token is valid for 5 minutes and must be in the header for the remaining calls to the API. Please note that we do not currently support refresh tokens.
The Payment API allows you to manage payments as Single Payments or as Payment Bulks. For example, if your workflow or automation process is designed to initiate payments every 10 minutes and you would like them executed as soon as possible, you would choose Single Payments.
In other cases, you can choose to send payments in bulk, where a collection of payments is processed at the same time.
You can also use the Payment id to request further details for example, if a payment has an FX rate attached. The API uses Straight-Through-Processing, where valid payments go directly to the core system for processing. Once a payment has been initiated, it can only be cancelled if the value date is not today.
When your company is onboarded the Real-time FX trading platform, the FX API endpoint gives you an overview of all events and the trades that are “in waiting”. The FX endpoint data includes pure or row FX (trading currency).
You can access all fees, look through the pages, and get details for each FX id such as status, sold and bought account, amount, value date and exchange rate.
The Fee interface enables you to access real-time overview of the entries your company has made against your fee account such as the fees you need to pay, due date etc.
You can use the Report API to request any of the following reports, no matter which channel you have used for payment instruction:
- Reconciliation - details of all account movements in the requested date range for reconciliation purposes
- Rejection - information on all rejected payments with rejection date on the requested date
- Account Balance – the latest available balances for all accounts
- Account Activity – all activity for a specific account in the requested date range