Fetch payout info

Returns one payout by its ID (PYT-...), with the recipient's name and account, the amount and currency, the reason, and the current status.

status is Processing until the payout settles, then Processed. It can also be Failed, Held by bank, or null for a local payout the beneficiary bank rejected. Processed is not final: a processed payout can later move to Held by bank, Failed or a bank rejection. To be notified instead of polling, use the payout.processed and payout.failed webhooks; only those two changes send one. See the Payout object.

If no payout with that ID belongs to your business, the call returns 404 with RECORD_NOT_FOUND.

Recipes
💸
Pay a recipient
Open Recipe
🏪
Run a marketplace: collect, hold, split and pay sellers
Open Recipe
Path Params
string
required
Defaults to PYT-5E6F7A8B9C

Payout ID

Responses

429

Too many requests. You sent more than 100 requests in 30 seconds from one IP address. This response has no JSON body. See Rate limits.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json