Introduction
The Payouts API lets you retrieve a payout, including its fees, amounts, and statuses.
Payout states
A payout can be in one of the following states:
sent
The money request has been sent to the bank. This is the starting point.
It moves to paid within hours/days.
paid
The payout is assumed to be successful.
Important: this status can change up to 5 business days later if the money is returned by the merchant’s receiving bank.
unpaid
The payout failed after it was thought to be successful.
A credit adjustment has been provided to the merchant’s account. The merchant must check their bank details in the Yoco App to fix the issue.
failed
The payout was rejected right away. This is usually due to a clear error like incorrect bank details.
The merchant must check their Yoco App dashboard to fix the issue.
For payouts, the updated_at timestamp may change to reflect changes in the payout status. Use
the updated_at field to detect changes after payout status changes.
