View payout executions

A payout initiated by a payout schedule is called an execution. You can view all executions of a managed payout schedule on your balance account in your Customer Area, or by making a Configuration API request.

Requirements

Before you begin, take into account the following requirements, limitations, and preparations:

View payout schedule executions in Customer Area

To view the executions of a managed payout schedule in your Customer Area:

1. Go to Accounts & balances > Account holders, and search for the account holder.
2. Open the Balance accounts tab and select the relevant balance account ID.
3. Under Scheduled transfers, select the managed payout schedule.
   A managed payout schedule specifies the estimated arrival time of the payout, while a custom schedule specifies the transfer schedule.
4. Open the Events tab to view the payout timeline, where you can:
   • View the date of the next payout.
   • Review past payout events, including execution dates and statuses.

Execution event statuses and reasons

The table below explains the statuses you may see in the Events tab for each pre-configured payout schedule:

View payout schedule executions using the API

To view the executions of a managed payout schedule applied to a balance account using the Configuration API:

1. Make a GET  /balanceAccounts/{balanceAccountId}/payoutSchedules/{id}/executions request, specifying the balance account ID and the managed payout schedule ID in the path.

2. The response includes the payoutScheduleExecutions array, which contains all the executions of the payout schedule.

Execution results and reasons

When a payout is supposed to be triggered according to the managed payout schedule, Adyen sends a webhook to notify you of the success or failure of the execution.

The webhook payload includes a result which corresponds to the webhook type.

Successful payout execution

If the execution is successful, Adyen sends a balancePlatform.balanceAccountPayoutScheduleExecution.succeeded webhook. The payload contains:

• id: The unique identifier of the execution.
• balanceAccountPayoutScheduleId: The unique identifier of the managed payout schedule.
• resultDetails: An object containing the transferId of the resulting funds transfer.

Failed or skipped payout execution

If the execution is skipped or failed, the resultDetails object contains a reasonCode and a reason.

The following table contains all possible combinations of result and reasonCode values.

The following tabs show example webhooks for both skipped and failed executions.

Track fund movements

When a managed payout execution is successful, it triggers a funds transfer. To track the lifecycle of the funds as they move from the balance account to the bank account (transfer instrument) of your user, you can monitor the Transfer webhooks.

These webhooks provide real-time updates on the status of the funds movement, such as when the transfer is authorized, captured, or if it is eventually returned by the bank.

Testing

Before going live with managed payout schedules, we recommend that you test the scenarios described in the following table.

Bank details for testing

Use the bank details in the following table to create transfer instruments to test your managed payout schedules.

See also