v1

latestOpenAPI 3.0.3Proprietary2026-07-2441103204.8 KB
Payouts

Email proof of payout

Create and send a proof of payout PDF by email to the specified recipients. Only successful payouts are supported; merchant recon email is added as CC.

post/merchants/{merchantId}/email-proof-of-payout/{payoutRequestId}/{payoutId}

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.

payoutRequestIdstring required

A valid v4 UUID expressed in lowercase with dashes.

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

A valid Payout Request ID expressed as a v4 UUIDin lowercase with dashes.

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.

Request body

tostring[] required

Email addresses to send the proof of payout to.

Example request

{
  "to": [
    "recipient@example.com",
    "other@example.com"
  ]
}

Response

Proof of payout email sent.

messagestring
tostring[]
ccstring

CC address used (recon email, primary as fallback).

Example response

{
  "message": "Proof of Payout sent",
  "to": [
    "recipient@example.com",
    "other@example.com"
  ],
  "cc": "recon@example.com"
}