Sign in

v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Bulk Payouts

Get error file URL for a bulk payout upload

Returns a presigned URL to download the error file for a specific bulk upload, if available.

get/merchants/{merchantId}/payouts/upload/{bulkPayoutId}/error

Path parameters

merchantIdstring required

A unique merchant ID provided by Peach Payments in hexadecimal format.

Example:d0bf5a6a909111f0aabf02d14af18cff

A unique merchant ID provided by Peach Payments.

bulkPayoutIdstring required

A valid v4 UUID expressed in lowercase with dashes.

Example:6e029f3f-21bf-425d-8f65-4eef2b5d8bb2

The unique identifier for the bulk upload.

Response

Error file URL and result code for the bulk upload

bulkPayoutIdstring required
errorFileURLstring uri required
resultCodestring string required

The result code indicating the status or error of the payout.

Example response

{
  "bulkPayoutId": "012346-1234-4321-123456789012",
  "errorFileURL": "http://example.com/error-file.xlsx",
  "resultCode": "2000.000.000"
}