Skip to content
Developer home

Provider API reference

  Less than to read

Payments Out Service has 3 provider APIs. These are:

  • Provider API
  • Provider messaging API
  • Provider webhook notifications API

There’s a separate API for obtaining authentication tokens, this is the Sage Cloud Identity Service API.


Provider API

You can use this API to:

  • Retrieve and process batches of payments.
  • Update a batch’s status and each payment in a batch to show if it’s processed successfully or failed.

Take a look at the Provider API reference.


Provider messaging API

You can use this API to:

  • Update creditors (e.g. suppliers, vendors or employees)
  • Update debtors (e.g. bank accounts)
  • Create responses to creditor or debtor account queries

Take a look at the Provider messaging API reference.


Provider webhook notifications API

This API allows you to process webhooks sent by the Consumer API.

Go to the Provider webhook notifications API.


Sage Cloud Identity Service API

This service issues access tokens. These allow applications to access and use the Provider API.

Take a look at the Sage Cloud Identity Service API.