What you'll be doing

Once you're all setup by our Integration team, you're ready test an end-to-end flow using our APIs. Let's go through a typical flow:

1. Authenticate
2. Check your accounts
3. Make your first payment
4. Receive a payment
5. Check your payment
6. Run a reconciliation report

Before you begin, you'll need to have your authentication credentials. You can read more about getting those in the guide on how to Connect to our APIs.

Authenticate

1. Initiate a GET request to the Authorization endpoint
2. Store the access_token (JsonWebToken) and expires_in values (in seconds) from the response body
3. Check the expiration time of the token before every subsequent request:
   1. If the token hasn’t expired, then use the currently stored token in the new request
   2. If the token has expired, then follow the steps again to request a new token

Here's an example 200 success response containing the access token and expiry: {"access_token": "eyJ0eXAi...", "expires_in": "300"} (the access_token has been shortened to make it more readable).

Note that the Sandbox and Production environments are separate and require distinct certificates for authorization. The method is similar across the two environments.

📘

URLs

The Sandbox base URL is https://sandbox.bankingcircleconnect.com and for the authorization endpoint it is https://authorizationsandbox.bankingcircleconnect.com/.

The Production base URL is https://www.bankingcircleconnect.com and for the authorization endpoint it is https://authorization.bankingcircleconnect.com/.

Check your accounts

Let's examine your bank accounts. Call the GET/api/v1/accounts to list all your accounts. Pay attention to the AccountId, IBAN, and Company Owner.

We also provide dedicated endpoints to check balances and movements. Read more about those in Accounts and balances.

Make your first payment

Send payments using our Payments API. Both 'Single' and 'Bulk' payments are supported, use POST/api/v1/payments/singles or POST/api/v1/payments/bulks.

The Sandbox uses the payment amount to simulate different payment statuses.

Receive your first payment

To simulate an incoming payment, send a payment from one of your accounts to another. Payments within the same Company are labeled 'Own,' while payments between different companies are labeled 'Outgoing' on the sender's account and 'Incoming' on the receiver's account. This is why you've been granted two Companies when Integration team set you up. Thus, you must send a payment between two accounts with two different Company Owner .

It is not possible to simulate an incoming payment from other banks.

Check your payment

You can check payments using the our endpoints GET/api/v1/payments/singles/{payment-id}/ or GET/api/v1/payments/singles/{payment-id}/status .

Run a reconciliation report

The most interesting report is our Reconciliation report which gives you the details of all account movements. Report generation involves three steps:

1. Request a report
2. Check status of your request
3. Download your report

The details are described in this chapter How to generate a report.

Congratulations!

Congratulations, you have now completed an end to end payment flow!