Skip to content

3. Integrate

  Less than to read

Postman environment and collection

The following Postman collections and environment variables should be used:

  • _Auth Service.postman_collection.json
  • _Banking Cloud.postman_collection.json
  • PaymentsQA + Banking QA.postman_environment.json

We recommend using our stable QA environment.

They can be found on our Banking Service GitHub. For access to the GitHub repository, contact us using the Banking Service forum.

Consumer flows

For a successful integration with Banking Service, it is important to understand the data flows.

There are 5 flows for consumers connecting to Banking Service:

  • Authorisation
  • Re-authorisation
  • Multi-account linking
  • Pushing of transactions
  • Rule creation
  • Disconnect

The flows also include 4 participants:

  • Product – The Sage product which is currently integrated with Banking Service UI using the consumer API.
  • UI – The user interface which allows the Sage user to search for a bank and allows them to authenticate.
  • Banking Service – Banking Service handles the calls from the consuming API which Sage products use to interact with Banking Service. Also handling the provider API which handles the connection from any 3rd party provider.
  • Provider – This refers to the 3rd party integrating with Banking Service. This 3rd party connector will need to contain the connector API endpoints to be able to handle the Banking Service flows and recieve data.

API specification

Our API reference provides detail of the full API. Use this to understand how the API calls and how responses will look when implemented. The endpoints correspond to the domain model and business flow of interactions that you can expect with Banking Service. All data is in JSON format.

Swagger document

The Swagger document is primarily for web products.

Our Swagger document is deployed on our QA environment. This provides up-to-date implementation detail on how the API works. This should be used as the primary reference when integrating with the platform.

Engineering support

Your team will be able to contact our engineers for support. The channels for contacting our engineers were agreed in Stage 2: Get set up.

It is important that you get in touch with us if you have any issues during development such as:

  • Issues accessing the sandbox environment
  • Documentation issues
  • Updates to endpoints or provider names
  • Delays to agreed go-live dates
  • Knowledge support for provider flows and API specifications

What’s next?

Find out what you need to do for your integration to go live after you’ve completed your internal testing.