v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB

Bulk Payouts

Get today's bulk payout uploads for a merchant

Returns all bulk payout uploads created today. No filtering or searching is supported; only today's uploads are returned.

get/merchants/{merchantId}/payouts/upload

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.

Response

List of today's bulk payout uploads

resultCodestring string required

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

Example response

{
  "bulkPayouts": [
    {
      "bulkPayoutId": "123e4567-e89b-42d3-a456-426614174000",
      "originalFilename": "customer-refunds-for-july.xlsx",
      "filename": "bulk_payout-2024-07-23T09:00:00.000Z.xlsx",
      "errorFilename": "bulk_payout_error-2024-07-23T09:00:00.000Z.xlsx",
      "state": "submitted_with_errors",
      "createdAt": "2024-07-23T09:00:00.000Z",
      "modifiedAt": "2024-07-23T09:05:00.000Z"
    },
    {
      "bulkPayoutId": "123e4567-e89b-42d3-a456-426614174001",
      "originalFilename": "salary-june.xslx",
      "filename": "bulk_payout-2024-07-23T10:00:00.000Z.xlsx",
      "state": "submitted",
      "createdAt": "2024-07-23T10:00:00.000Z",
      "modifiedAt": "2024-07-23T10:00:00.000Z"
    }
  ],
  "resultCode": "2000.000.000"
}