Appearance
PayPal payouts
Possible states
WARNING
this documentation requires verification (it's generated by ChatGPT)
| State | Description |
|---|---|
| BLOCKED | Indicates that the payout item has been prevented from being processed, usually due to a hold or restriction on the sender's account. May require further action or review. |
| CANCELED | Indicates that the payout item has been stopped by the sender before it was processed. No funds will be transferred. |
| DENIED | The payout item was not allowed due to issues with the recipient's account, such as it being unverified or restricted. |
| FAILED | There was an issue processing the payout, and it could not be completed. This could be due to various reasons like insufficient funds, a technical error, etc. |
| HELD | The payout item is temporarily on hold, often for security or regulatory reasons. Might require further verification or action. |
| REFUNDED | Funds from the payout item have been returned to the sender. This could be due to a request from the recipient or if the payout was unclaimed for a certain period. |
| RETURNED | The payout item couldn’t be delivered to the recipient because their account could not accept it. The funds are returned to the sender's account. |
| SUCCEEDED | The payout item has been successfully processed, and the funds have been transferred to the recipient. |
| UNCLAIMED | The payout has been processed, but the funds have not been accepted or claimed by the recipient. This could be because the recipient has not yet signed up for a PayPal account or has not confirmed their email address. |
Possible State Transitions
- BLOCKED can transition to:
- CANCELED
- DENIED
- FAILED
- SUCCEEDED
- CANCELED is a terminal state; it does not have further transitions.
- DENIED can transition to:
- SUCCEEDED
- FAILED
- FAILED is a terminal state; it does not have further transitions.
- HELD can transition to:
- BLOCKED
- SUCCEEDED
- FAILED
- REFUNDED can be a result of:
- SUCCEEDED (meaning a successfully completed payout was later refunded)
- RETURNED can transition to:
- SUCCEEDED
- FAILED
- SUCCEEDED is a terminal state but can lead to REFUNDED if a refund occurs.
- UNCLAIMED can transition to:
- RETURNED
- SUCCEEDED
Read more about PayPal batch payouts.