We are no longer accepting new integrations with the Payout API; use the Transfers API instead. With the Transfers API, you can:
- Handle multiple payout use cases with a single API.
- Use new payout functionalities, such as instant payouts.
- Receive webhooks with more details and defined transfer states.
- Building a new integration, refer to Webhook structure and types to integrate with the Transfers API.
- Already integrated with the Payout API, reach out to your Adyen contact for information on how to migrate to the Transfers API.
Payouts to bank accounts or wallets
To know whether a payout to a bank account or wallet was successful, you need to set up a webhook. The response to a /submitThirdParty
request only indicates that the request has been received, not whether the payout was successful.
The following eventCode
s are important when you make payouts to bank accounts or wallets:
-
PAYOUT_THIRDPARTY: The user reviewing the payout confirmed it. The
success
field indicates whether we received the payout request. Possible values:success
: true. We received your payout request, and will send it to the financial institution. When approved, the funds are paid out within 2 business days. In case the financial institution rejects the request, you will receive a webhook event witheventCode
: PAIDOUT_REVERSED.success
: false. The request failed. Thereason
field includes a short description of the issue. Review the reason, fix the issue if possible, and resubmit the payout request.
-
PAYOUT_DECLINE: The user reviewing the payout declined it. The
success
field of this webhook event is always set to true. -
PAYOUT_EXPIRE: 7 days have passed since the payout was submitted, and the reviewer has neither confirmed nor declined it. The
success
field of this webhook event is always set to true. -
PAIDOUT_REVERSED: The financial institution rejected the payout. We will return the funds back to your account.
Instant payouts
When making instant payouts to a card, you will get a response to your /payout
request with resultCode
: Received. For a successful payout, you will then receive a webhook event with:
eventCode
: PAYOUT_THIRDPARTYsuccess
: true
If the issuer refuses the payout, you will receive a webhook event with:
eventCode
: PAYOUT_THIRDPARTYsuccess
: false
Code examples
The following example shows a PAYOUT_THIRDPARTY webhook event with success
: true.