/ Guides / Payments / Send batch payments / Download a payment batch

Download a payment batch

Retrieve and download submitted payment files along with any associated errors or warnings to review or correct issues. The downloaded file includes additional columns for errors or warnings, allowing you to address issues and re-upload corrected files. You can filter the data by payment statuses or specific order references.

Post/v2/batches/{paymentBatchId}/payments/download

Request

Use this endpoint to download a file containing all payments submitted within a payment batch.

Sample requestRequest structure
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments/download?accountId=F50091&statuses=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'content-type: text/csv' \
Copy
Copied
curl -i -X POST \
  'https://api.equalsmoney.com/v2/payment-batches/{paymentBatchId}/payments/download?accountId=F50091&statuses=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'content-type: text/csv' \

Path parameters

Parameter Description
paymentBatchId
integer
required		 The unique ID of the payment Batch.

Allowable values:
>= 1

Query parameters

Parameter Description
accountId
string
required		 The ID of the account that this payment is associated with.

Allowable values:
An existing accountId (<= 36 characters)
statuses
string		 A list of statuses to filter by.

Allowable values:
draft, validated, confirmed, started, completed, failed, cancelled

Response

If the request is successful, you'll receive a 200 OK status, indicating that the file has been successfully generated and returned.

For more detailed information about this request and its response, see API reference.