Pay out to bank accounts

After an account holder starts receiving funds to their account, these funds can be paid out according to the current payout tier of the account holder. For more information on possible tiers and Know Your Customer (KYC) checks required for payouts, refer to Verification checks.

You can support the following payout methods:

• Automatic payouts to bank accounts.
• Manual payouts to bank accounts or eligible cards.

Automatic payouts

By default, your marketplace account is configured to automatically send payouts daily to all eligible account holders. If you want to change the default schedule for your marketplace, contact Support Team.

You receive an ACCOUNT_HOLDER_PAYOUT notification after automatic payouts are initiated. Refer to Payout notifications to learn about payout status codes.

Update automatic payout schedule for an account holder

In addition, you can set a new payout schedule for a particular account holder. To do this, make an /updateAccount call and pass a new schedule in the payoutSchedule object.

Possible schedule values are:

 curl https://cal-test.adyen.com/cal/services/Account/v6/updateAccount \
  -H "x-API-key: YOUR_X-API-KEY" \
  -H "content-type: application/json" \
  -d '{
    "accountCode": "198360329",
    "payoutSchedule": {
        "{hint:Optional. How to handle previously scheduled payouts.}action{/hint}": "CLOSE",
        "{hint:Required when the schedule parameter is set to HOLD.}reason{/hint}": "Update the payout schedule",
        "schedule": "WEEKLY"
    }
}'

{
    "invalidFields": [],
    "pspReference": "8515659450108985",
    "accountCode": "198360329",
    "payoutSchedule": {
        "schedule": "WEEKLY"
    }
}

You receive a response that may contain any of the following status codes:

• HTTP 200: You can use the information returned in API response but wait for the ACCOUNT_UPDATED notification to confirm when the resource has been updated in our central database.
• HTTP 202: The request has been acknowledged and added to the queue. Use the response to check and confirm the changes you made. Wait for the ACCOUNT_UPDATED notification to confirm if the payout schedule has been successfully updated.

Manual payouts

Make a /payoutAccountHolder request to manually trigger payouts to your account holder's bank account or to a card eligible for payouts.

curl https://cal-test.adyen.com/cal/services/Fund/v6/payoutAccountHolder \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
   "accountCode":"118731451",
   "amount":{
      "currency":"EUR",
      "value":99792
   },
   "accountHolderCode":"TestAccountHolder877209",
   "description":"12345 – Test",
   "bankAccountUUID":"000b81aa-ae7e-4492-aa7e-72b2129dce0c"
}'

{
   "invalidFields": [],
   "pspReference":"9914719437810080",
   "bankAccountUUID":"000b81aa-ae7e-4492-aa7e-72b2129dce0c"
}

{
  "invalidFields": [
    {
      "errorCode": 29,
      "errorDescription": "Account code does not exist or invalid",
      "fieldType": {
        "field": "accountCode",
        "fieldName": "accountCode"
      }
    }
  ],
  "pspReference": "8515659454939302",
  "resultCode": "Failed"
}

Wait for the ACCOUNT_HOLDER_PAYOUT notification to confirm the status of the payout. Refer to Payout notifications to learn about payout status codes.

Payout notifications

After you make a /payoutAccountHolder request, wait for the ACCOUNT_HOLDER_PAYOUT notification to confirm the status of the payout.

The ACCOUNT_HOLDER_PAYOUT may contain any of the following status.statusCode:

Refund last transactions

With the /refundNotPaidOutTransfers call, you can schedule a refund for all of the transactions that have occurred since the last payout and have not been paid out yet.

curl https://cal-test.adyen.com/cal/services/Fund/v6/refundNotPaidOutTransfers \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
   "accountHolderCode":"TestAccountHolder502924",
   "accountCode":"189184578"
}'

{
   "pspReference":"9914764308750114",
   "resultCode":"Received"
}

Wait for the SCHEDULED_REFUNDS notification to confirm the status of the request.

See also