--- title: "Configure custom payout schedules" description: "Set up scheduled automatic payouts to your verified bank account." url: "https://docs.adyen.com/payouts/payout-service/getting-paid/scheduled-payouts" source_url: "https://docs.adyen.com/payouts/payout-service/getting-paid/scheduled-payouts.md" canonical: "https://docs.adyen.com/payouts/payout-service/getting-paid/scheduled-payouts" last_modified: "2022-04-20T10:24:00+02:00" language: "en" --- # Configure custom payout schedules Set up scheduled automatic payouts to your verified bank account. [View source](/payouts/payout-service/getting-paid/scheduled-payouts.md) You can automate payouts from a balance account to your verified bank accounts by configuring a custom payout schedule. The schedule automatically initiates a payout from a balance account to your bank account based on a pre-defined frequency, trigger amount, and source or destination. When setting up a custom scheduled payout, consider the [cutoff times](/payouts/payout-service/getting-paid#transfer-cutoff) for each bank transfer method in each region. Cutoff times affect the expected time for your users to receive the funds in their bank account. ## Requirements Before you begin, take into account the following requirements: | Requirement | Description | | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Integration type** | You must have a Payouts integration. | | **[API credential roles](/development-resources/api-credentials/roles/)** | Your API credential for the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) must have the following [role](/payouts/payout-service/manage-access/webservice-roles?tab=transfers_2):- **TransferService Webservice Initiate role** | | **[Customer Area roles](/account/user-roles)** | You must have the following roles:- **Balance platform base role** - **Configure scheduled payouts** | | **[Webhooks](/development-resources/webhooks)** | To track fund movements in your platform, you can subscribe to the following webhooks:- [Transfer webhooks](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/overview) - [Transaction webhooks](https://docs.adyen.com/api-explorer/transaction-webhooks/latest/overview) | | **[Capabilities](/payouts/payout-service/verification-overview/capabilities)** | Make sure that your user has the following capability:- **sendToTransferInstrument** | | **Setup steps** | Before you begin:- Make sure that the account holder and transfer instrument are linked to the same legal entity. - Contact our [Support Team](https://ca-test.adyen.com/ca/ca/contactUs/support.shtml?form=other) if you want to configure a [default transfer description](/payouts/payout-service/payout-descriptions) for your platform. - We recommend that you [calculate the available transfer routes](/payouts/payout-service/custom-payouts/transfer-routes). This can enable you to design a configuration that optimally aligns with your use case and minimizes the risk of transfer failures by proactively identifying supported routes and highlighting any necessary parameters. | ## How it works You can configure custom payout schedules on [balance accounts](/payouts/payout-service/account-structure-resources) in your platform. When you create a schedule, you can define the conditions that must be met for a payout to be initiated. You can set the following conditions: * Set a specific date and time. * Transfer the entire [available amount](/payouts/payout-service/getting-paid/payout-amount) or a fixed amount. * Maintain an amount on the balance account. * Set an amount that triggers the payout. When all the conditions of the payout schedule are met, a transfer request is triggered automatically. Adyen sends webhooks to your server when a transfer request is triggered from a custom payout schedule. ## Create a custom payout schedule (sweep) To configure a custom payout schedule in your [Customer Area](https://ca-test.adyen.com/): 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 **Add a schedule**. 4. Choose **Pay out to another account** as the transfer type, and select **Continue**. 5. Enter and verify the required configuration details in their respective fields. | Field | Required | Description | | ------------------------------ | ------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **Currency** | ![Required](/user/pages/reuse/image-library/01.icons/required/required.svg?decoding=auto\&fetchpriority=auto) | Set the currency of the transfer. | | **What should the payout do?** | ![Required](/user/pages/reuse/image-library/01.icons/required/required.svg?decoding=auto\&fetchpriority=auto) | Choose how the funds are to be paid out. Possible values are:- **Transfer all available balance from this account** - **Maintain a specific balance in this account** - **Transfer a specific amount from this account** | | **Minimum balance for payout** | | Set a trigger amount. The trigger amount is the minimum balance needed to send a payout. If the balance is lower than this amount, the funds will not be paid out. If you always want payouts to be sent automatically, regardless of the balance, enter **0**. | | **Transfer balance to** | ![Required](/user/pages/reuse/image-library/01.icons/required/required.svg?decoding=auto\&fetchpriority=auto) | Select the **Transfer instrument**. | | **Transfer instrument** | ![Required](/user/pages/reuse/image-library/01.icons/required/required.svg?decoding=auto\&fetchpriority=auto) | Select the ID of the transfer instrument. | 6. Select **Next to schedule**. 7. If you are setting up a schedule to pay out all available funds from the balance account, select **Set a custom time to send a payout**. 8. Enter and verify the following configuration details in their respective fields. | Field | Required | Description | | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **How frequently should the payout arrive?** | ![Required](/user/pages/reuse/image-library/01.icons/required/required.svg?decoding=auto\&fetchpriority=auto) | Set the payout frequency. If you set the frequency to **Monthly** or **Weekly**, you must also specify the day in the next step. | | **What time should the payout be sent?** | ![Required](/user/pages/reuse/image-library/01.icons/required/required.svg?decoding=auto\&fetchpriority=auto) | Specify the timing of the payout. | | **Description** | ![Recommended](/user/pages/reuse/image-library/01.icons/recommended/recommended.svg?decoding=auto\&fetchpriority=auto) | An identifier for the transfer. | | **Reference for beneficiary** | ![Recommended](/user/pages/reuse/image-library/01.icons/recommended/recommended.svg?decoding=auto\&fetchpriority=auto) | The identifier, for example an invoice number, that appears on the recipient's bank statement. This value must be alphanumeric with no spaces and can be static, [dynamic](/payouts/payout-service/custom-payouts/scheduled-payouts/?tab=API-1_2#optional-dynamic-transfer-statement-descriptions), or a combination of both. | | **Transfer priorities** | ![Required](/user/pages/reuse/image-library/01.icons/required/required.svg?decoding=auto\&fetchpriority=auto) | Specify how fast you want the funds to arrive to your bank account by setting a [priority for the payout](/payouts/payout-service/getting-paid#payout-priority). A payout with a higher priority incurs higher fees. | 9. **Review** the information that you provided. 10. Select **Add**. The details of your scheduled payouts are shown under **Scheduled transfers**. The following example shows how to enter the configuration details. ** ### Example — Pay out to a bank account You want to pay out USD 150 to your transfer instrument at the beginning of each month if the balance in your balance account is higher than USD 250. | Field | Details | | -------------------------------------------- | ------------------------------------------------ | | **Currency** | **USD** | | **What should the payout do?** | **Transfer a specific amount from this account** | | **Transfer amount** | **150 USD** | | **Transfer balance to** | **Transfer instrument** | | **Transfer instrument** | **SE00000000000000000000001** | | **How frequently should the payout arrive?** | **Monthly** | | **Which day should the transfer arrive?** | **1st** | | **What time should the payout be sent?** | **07:00** | | **Description** | **Monthly scheduled payout** | | **Reference for beneficiary** | **Payout001** | | **Transfer priorities** | **Regular** | ## Get updates when a sweep triggers a transfer request You can view the status of funds transfers initiated by a payout in your [Customer Area](https://ca-test.adyen.com/), or track them by listening to webhooks. To track the status of funds transfers initiated by a payout: 1. Listen to the following webhooks: * [Transfer webhooks](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/overview): * [balancePlatform.transfer.created](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.created) webhook events notify you that funds will be deducted from a balance accounts. * [balancePlatform.transfer.updated](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.updated) webhook events notify of every status change of the funds transfer. * [Transaction webhooks](https://docs.adyen.com/api-explorer/transaction-webhooks/latest/overview): Adyen sends a [balancePlatform.transaction.created](https://docs.adyen.com/api-explorer/transaction-webhooks/latest/post/balancePlatform.transaction.created) webhook event to inform your server that funds have been deducted from a balance account. 2. Acknowledge the webhooks. 3. In the payload of the [balancePlatform.transfer.updated](https://docs.adyen.com/api-explorer/transfer-webhooks/latest/post/balancePlatform.transfer.updated) webhook, note that: * The `event` array includes all previous transfer events. * The `sequenceNumber` defines the number of webhooks sent for the transfer, including the current one. For more details and examples, see [Payout webhooks](/payouts/payout-service/getting-paid/payout-webhooks). ## View sweep details After you create a custom payout schedule, you can view the details of the resulting scheduled payout in your [Customer Area](https://ca-test.adyen.com/). These details include: * Payout amount * Source and destination of the payout * Completed and upcoming scheduled payouts You can view the details of all payout schedules and [internal transfer schedules](/payouts/payout-service/internal-fund-transfers/scheduled-fund-transfers/) on the **Balance account details** page, under **Scheduled transfers**. To view the details of a scheduled payout: 1. Go to **Accounts & balances** > **Balance accounts**. 2. In the **Balance platform** dropdown, select the balance platform. You can view balance accounts from one balance platform at a time. 3. In the balance account table, select a balance account ID to open the **Balance account details** page. 4. Under **Scheduled transfers**, select a scheduled payout. 5. Open the **Details** tab to view information about the scheduled payout. ## See also * [View transfer details](/payouts/payout-service/view-transfers-details) * [Payout webhooks](/payouts/payout-service/getting-paid/payout-webhooks)