v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Payouts

Download proof of payout

Build and return a proof of payout PDF for a specific payout.

get/merchants/{merchantId}/proof-of-payout/{payoutId}/download

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.

payoutIdstring required

A valid v4 UUID expressed in lowercase with dashes.

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

A valid Payout ID expressed as a v4 UUID in lowercase with dashes.

Headers

Accept'application/pdf' required
Example:application/pdf

Must be application/pdf to receive the PDF response.

Response

A PDF file containing the proof of payout.