APG PayAPG Paydocs

API reference

Payouts

6 endpoints

A payout is money the platform sent to a merchant's bank account. Payouts are raised on the merchant's schedule; you can also raise one by hand.

amounts carries what moved and the merchant's balance either side of it, closingBalance is openingBalance less amount, which is the arithmetic a reconciliation checks. What the payout is *made of* is composition, broken down by entry type, and it is present on a by-id read only.

status is the external status: a payout whose first payment attempt failed reads as InTransit while the platform retries, not Pending. When a payout has not arrived, disbursement.attempts is the field that says why.

A paid payout has a statement. The documents made for it, and where each got to, are at GET /payouts/{payoutId}/documents, and the statement itself, as the file, is at GET /payouts/{payoutId}/documents/{format}. PATCH makes the statement again or mails it again.