Skip to content
Developer home

Interacting with the API

  Less than to read

First Steps

Before interacting with the API, please check the mandatory fields page. If mandatory fields are missing, or malformed, the Transaction Import will be rejected.

A development team should first become familiar with the API reference that describes the RESTful API. Some of the more common flows and interactions with the Transaction Import Connector can be explored in more detail in Use cases

Ensure it’s easy for you to switch between environments that you’re targeting, as from time to time you may want to switch from QA or Pre-Prod. As a delivery date approaches you will need to seamlessly switch between environments, ultimately into Production.

Environments

API

The root endpoint for all calls made to the API is:

[Domain URL]/api-v1/
Environment Region (Data-hosting) Domain Name Default 'primaryCountry'*
Sandbox N/A TBC N/A
QA US
EU
https://r7p2vcpz2b.execute-api.eu-west-1.amazonaws.com
https://r7p2vcpz2b.execute-api.eu-west-1.amazonaws.com/
USA
GBR
Pre-Production US
EU
https://bnkc-transactionimport.pp-fabric.sage.com
https://bnkc-transactionimport.pp-fabric.sage.com/
USA
GBR
Production US
EU
TBC USA
GBR

Banking Service has environments located in different geographical regions, to support legal requirements from the Banks, or the country they are located in, that specify in which region their data must be hosted. As a result, connecting products are required to make use of the currency/country code selected by the consumer within the UI so the bank account can be created within the correct region when onboarding.

Sandbox

TBC - Sandbox environment is coming to Banking Service and all other services. More on this will be available when it reaches the Transaction Import Connector.

QA

The “QA” environment will always contain the latest features currently being developed. Application Teams are welcome to target this environment should they wish, however it must be understood that the stability of this environment (and possibly its data) cannot always be guaranteed; the Banking Service team regularly use this environment to test the latest changes to functionality and/or configuration.

For updates on deployments and the state of this environment, please follow the “Deployment (QA)” channel on our Microsoft Teams team. This channel is used to announce all QA deployments to Banking Service and related services.

Pre-Production

Also referred to as “Pre-Prod” or “PP”, this is the primary environment for Application Teams to test their integration with the Transaction Import Connector.

This environment is semi-regularly updated to make completed, stable work available to Application Teams.

For updates on deployments and the state of this environment, please follow the “Deployment (Pre-Prod)” channel on our Microsoft Teams team. This channel is used to announce all PP deployments to Banking Service and related services.

Production

TBC