Skip to content

Provider API - Update a batch of payments

  Less than to read

If you need to update information about a batch of payments, such as changing the status of the batch and payments, adding or changing extendedStatus or adding AdditionalData, this can be done by sending a PATCH request to the Payments Out Provider API like:

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

where the {batchId} is the guid of the batch of payments that you want to update.

Note - Electronic payment batches are stored for 365 days before they are deleted.

For more details such as which headers and request body fields are required on the request to be successful and an example payload and example response for this request, see the following page: Provider API - Update a batch of payments