APG PayAPG Paydocs

Payouts

Get payout document

GET/payouts/{payoutId}/documents/{format}
Request
GEThttps://api.tst.au.apgpay.dev/payouts/{payoutId}/documents/{format}
curl -X GET https://api.tst.au.apgpay.dev/payouts/{payoutId}/documents/{format} \
  -H "Authorization: Bearer $API_KEY"

Return the payout's statement as the file itself, under its own media type: text/csv for Csv, application/pdf for Pdf, application/xml for Xml. Content-Disposition names the file; the name is stated here too, because generated clients drop headers. A statement not made yet is a 404.

Permissions

Required permission
merchantFinancials:query

Requires the `query` action on `merchantFinancials` for the supplied runtime context

Path parameters

payoutIdstring
required
formatPayoutStatementFormat
required

Which document. It also fixes the response's Content-Type.

CsvPdfXmlUnknown

Responses

Example response
"string"

Error responses