Skip to content
Developerhome

2. Get set up

  Less than to read

The Provider API and your needs

Integrating with Payments Out Service allows Sage customers to make payments through your service.

Payments Out Service is product agnostic. This means customers of a range of products will be able to use this service.

For more information about Payments Out Service and the Provider API go to What is Payments Out Service?.

If you’re looking for integration with a specific product, be aware that some features may be implemented differently across products.


The provider requirements

Review the requirements for a successful integration with the API. You can still integrate if some items are not complete, but you may need further assessment before integrating.

Partner requirements

  • Updates should be sent in near real time and in accordance with our status flows.
  • The Provider API will throttle requests at a rate agreed with the commercial team (default 10 requests per second). 429 responses may be returned if the provider exceeds the throttling rate and the provider should implement an appropriate backoff before retrying.

Authentication requirements

  • Use Sage ID access token until they expire. You don’t need new tokens for each new request.
  • Your integration should ensure client credentials and API keys are stored securely.
  • You should notify us immediately of any breach of credentials.
  • Providers who support the notification endpoint must validate the API key header and Sage ID token.

Technical requirements

You are responsible for maintaining the provider connector.

The integration you build must include:

  • Authorisation endpoint URL (sandbox and production)
  • Preferred method of sending API key and client secret (to be agreed with Live Services Management)

The following are optional:

  • Notification endpoint URL (sandbox and production)
  • Notification header name and value required by the bank (this will be sent to their endpoint with all notifications)

Register with Sage

Prerequisites

To access our REST APIs you need to be using the following encryption protocol:

  • Transport Layer Security (TLS) 1.2

Contact Sage to register

As a payment service provider you’ll need to register with Sage to request your service is connected. After this, app registry and key provisioning is handled by Sage.

To register, go to our Partners page, and select “Request access”.


Getting set up

Resources we will provide to you

After registration, you will receive these resources:

  • Access to our sandbox environment.
  • A provider-specific Postman environment. This contains your client credentials and keys to allow you run the Postman collections. You can find out more about this in Stage 3: Integrate.
  • An assigned contact from the Enablement team for setup queries.
  • Communication channels established for support.

Next steps

Find out what you need to do to integrate.