Skip to content

Provider API - Retrieve a batch of payments

  Less than to read

To retrieve the current status and other information about a batch of payments that has been sent to your provider from a Sage product, you can send a GET request to the Payments Out provider API with the batch id of the payments like:

{GET} api-provider-v1/batchpayments/{batchId}

where the {batchId} is the guid of the batch of payments that you want to retrieve information about.

Note - Electronic payment batches are stored for 365 days and File based payments are stored for 35 days before they are deleted.

For more details such as which headers are required on the request and an example response for this request, see the following page: Provider API - Retrieve a batch of payments