{"title":"Configure custom payout schedules","category":"default","creationDate":1779796135,"content":"<p>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.<\/p>\n<p>When setting up a custom scheduled payout, consider the <a href=\"\/payouts\/payout-service\/getting-paid#transfer-cutoff\">cutoff times<\/a> 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.<\/p>\n<h2>Requirements<\/h2>\n<p>Before you begin, take into account the following requirements:<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">You must have a Payouts integration.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/development-resources\/api-credentials\/roles\/\">API credential roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Your API credential for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfers\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfers API<\/a> must have the following <a href=\"\/payouts\/payout-service\/manage-access\/webservice-roles?tab=transfers_2\">role<\/a>:<ul><li markdown=\"1\"><strong>TransferService Webservice Initiate role<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/account\/user-roles\">Customer Area roles<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">You must have the following roles: <ul><li markdown=\"1\"><strong>Balance platform base role<\/strong><\/li><li markdown=\"1\"><strong>Configure scheduled payouts<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/development-resources\/webhooks\">Webhooks<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">To track fund movements in your platform, you can subscribe to the following webhooks: <ul><li markdown=\"1\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfer webhooks<\/a><\/li> <li markdown=\"1\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transaction-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transaction webhooks<\/a><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/payouts\/payout-service\/verification-overview\/capabilities\">Capabilities<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">Make sure that your user has the following capability:<ul><li markdown=\"1\"><span translate=\"no\"><strong>sendToTransferInstrument<\/strong><\/span><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Setup steps<\/strong><\/td>\n<td style=\"text-align: left;\">Before you begin: <ul><li markdown=\"1\">Make sure that the account holder and transfer instrument are linked to the same legal entity.<\/li><li markdown=\"1\">Contact our <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> if you want to configure a <a href=\"\/payouts\/payout-service\/payout-descriptions\">default transfer description<\/a> for your platform.<\/li><li markdown=\"1\">We recommend that you <a href=\"\/payouts\/payout-service\/custom-payouts\/transfer-routes\">calculate the available transfer routes<\/a>. 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.<\/li><\/ul><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>How it works<\/h2>\n<p>You can configure custom payout schedules on <a href=\"\/payouts\/payout-service\/account-structure-resources\">balance accounts<\/a> in your platform. When you create a schedule, you can define the conditions that must be met for a payout to be initiated.<\/p>\n<p>You can set the following conditions:<\/p>\n<ul>\n<li>Set a specific date and time.<\/li>\n<li>Transfer the entire <a href=\"\/payouts\/payout-service\/getting-paid\/payout-amount\">available amount<\/a> or a fixed amount.<\/li>\n<li>Maintain an amount on the balance account.<\/li>\n<li>Set an amount that triggers the payout.<\/li>\n<\/ul>\n<p>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.<\/p>\n<h2 id=\"create-custom-schedule\">Create a custom payout schedule (sweep)<\/h2>\n<p>To configure a custom payout schedule in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>:<\/p>\n<ol>\n<li>\n<p>Go to <strong>Accounts &amp; balances<\/strong> &gt; <strong>Account holders<\/strong>, and search for the account holder.<\/p>\n<\/li>\n<li>\n<p>Open the <strong>Balance accounts<\/strong> tab and select the relevant <strong>Balance account ID<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Under <strong>Scheduled transfers<\/strong>, select <strong>Add a schedule<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Choose <strong>Pay out to another account<\/strong> as the transfer type, and select <strong>Continue<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Enter and verify the required configuration details in their respective fields.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Currency<\/strong><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td style=\"text-align: left;\">Set the currency of the transfer.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>What should the payout do?<\/strong><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td style=\"text-align: left;\">Choose how the funds are to be paid out. Possible values are: <ul><li markdown=\"1\"><strong>Transfer all available balance from this account<\/strong><\/li><li markdown=\"1\"><strong>Maintain a specific balance in this account<\/strong><\/li><li markdown=\"1\"><strong>Transfer a specific amount from this account<\/strong><\/li><\/ul><\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Minimum balance for payout<\/strong><\/td>\n<td style=\"text-align: center;\"><\/td>\n<td style=\"text-align: left;\">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.<br>If you always want payouts to be sent automatically, regardless of the balance, enter <strong>0<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Transfer balance to<\/strong><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td style=\"text-align: left;\">Select the <strong>Transfer instrument<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Transfer instrument<\/strong><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td style=\"text-align: left;\">Select the ID of the transfer instrument.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p>Select <strong>Next to schedule<\/strong>.<\/p>\n<\/li>\n<li>\n<p>If you are setting up a schedule to pay out all available funds from the balance account, select <strong>Set a custom time to send a payout<\/strong>.<\/p>\n<\/li>\n<li>\n<p>Enter and verify the following configuration details in their respective fields.<\/p>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Field<\/th>\n<th style=\"text-align: center;\">Required<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>How frequently should the payout arrive?<\/strong><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td style=\"text-align: left;\">Set the payout frequency.<br>If you set the frequency to <strong>Monthly<\/strong> or <strong>Weekly<\/strong>, you must also specify the day in the next step.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>What time should the payout be sent?<\/strong><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td style=\"text-align: left;\">Specify the timing of the payout.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Description<\/strong><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Recommended\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Recommended\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/recommended\/recommended.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td style=\"text-align: left;\">An identifier for the transfer. <\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Reference for beneficiary<\/strong><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Recommended\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Recommended\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/recommended\/recommended.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td style=\"text-align: left;\">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, <a href=\"\/payouts\/payout-service\/custom-payouts\/scheduled-payouts\/?tab=API-1_2#optional-dynamic-transfer-statement-descriptions\">dynamic<\/a>, or a combination of both.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong>Transfer priorities<\/strong><\/td>\n<td style=\"text-align: center;\"><span class=\"hint--bottom\" data-hint=\"Required\" markdown=\"1\"><img style=\"width: 25px;\" alt=\"Required\" src=\"\/user\/pages\/reuse\/image-library\/01.icons\/required\/required.svg?decoding=auto&amp;fetchpriority=auto\" \/><\/span><\/td>\n<td style=\"text-align: left;\">Specify how fast you want the funds to arrive to your  bank account by setting a <a href=\"\/payouts\/payout-service\/getting-paid#payout-priority\">priority for the payout<\/a>. A payout with a higher priority incurs higher fees.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<\/li>\n<li>\n<p><strong>Review<\/strong> the information that you provided.<\/p>\n<\/li>\n<li>\n<p>Select <strong>Add<\/strong>.<\/p>\n<\/li>\n<\/ol>\n<p>The details of your scheduled payouts are shown under <strong>Scheduled transfers<\/strong>.<\/p>\n<p>The following example shows how to enter the configuration details.<\/p>\n<div class=\"accordion-shortcode adl-accordion adl-accordion--max-height-transition\" data-expand=\"true\" data-ignore=\"anchorjs-link\">\n    \n    <div class=\"adl-accordion__item\" style=\"\">\n        <div tabindex=\"0\" role=\"item\" aria-expanded=\"false\" class=\"adl-accordion__header\">\n            <i class=\"adl-accordion__toggle adl-icon-chevron-down\"><\/i>\n            <div class=\"adl-accordion__title-wrapper\" data-accordion=\"#example-\ufffd-pay-out-to-a-bank-account\">\n                                    <h3 class=\"adl-accordion__title\">Example \u2014 Pay out to a bank account<\/h3>\n                            <\/div>\n        <\/div>\n        <div role=\"region\" class=\"adl-accordion__content\">\n            \n<p>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.<\/p>\n<table>\n<thead>\n<tr>\n<th>Field<\/th>\n<th>Details<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td><strong>Currency<\/strong><\/td>\n<td><strong>USD<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>What should the payout do?<\/strong><\/td>\n<td><strong>Transfer a specific amount from this account<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>Transfer amount<\/strong><\/td>\n<td><strong>150 USD<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>Transfer balance to<\/strong><\/td>\n<td><strong>Transfer instrument<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>Transfer instrument<\/strong><\/td>\n<td><strong>SE00000000000000000000001<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>How frequently should the payout arrive?<\/strong><\/td>\n<td><strong>Monthly<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>Which day should the transfer arrive?<\/strong><\/td>\n<td><strong>1st<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>What time should the payout be sent?<\/strong><\/td>\n<td><strong>07:00<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>Description<\/strong><\/td>\n<td><strong>Monthly scheduled payout<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>Reference for beneficiary<\/strong><\/td>\n<td><strong>Payout001<\/strong><\/td>\n<\/tr>\n<tr>\n<td><strong>Transfer priorities<\/strong><\/td>\n<td><strong>Regular<\/strong><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n\n        <\/div>\n    <\/div>\n<\/div>\n\n<h2 id=\"get-updates\">Get updates when a sweep triggers a transfer request<\/h2>\n<p>You can view the status of funds transfers initiated by a payout in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>, or track them by listening to webhooks.<\/p>\n<p>To track the status of funds transfers initiated by a payout:<\/p>\n<ol>\n<li>Listen to the following webhooks:\n<ul>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transfer webhooks<\/a>:\n<ul>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/post\/balancePlatform.transfer.created\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.transfer.created<\/a> webhook events notify you that funds will be deducted from a balance accounts.<\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/post\/balancePlatform.transfer.updated\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.transfer.updated<\/a> webhook events notify of every status change of the funds transfer.\n<\/li>\n<\/ul><\/li>\n<li> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transaction-webhooks\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Transaction webhooks<\/a>: Adyen sends a  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transaction-webhooks\/latest\/post\/balancePlatform.transaction.created\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.transaction.created<\/a> webhook event to inform your server that funds have been deducted from a balance account.<\/li>\n<\/ul><\/li>\n<li>Acknowledge the webhooks.<\/li>\n<li>In the payload of the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/transfer-webhooks\/latest\/post\/balancePlatform.transfer.updated\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">balancePlatform.transfer.updated<\/a> webhook, note that:\n<ul>\n<li>The <code>event<\/code> array includes all previous transfer events.<\/li>\n<li>The <code>sequenceNumber<\/code> defines the number of webhooks sent for the transfer, including the current one.<\/li>\n<\/ul><\/li>\n<\/ol>\n<p>For more details and examples, see <a href=\"\/payouts\/payout-service\/getting-paid\/payout-webhooks\">Payout webhooks<\/a>.<\/p>\n<h2 id=\"sweep-details\">View sweep details<\/h2>\n<p>After you create a custom payout schedule, you can view the details of the resulting scheduled payout in your <a href=\"https:\/\/ca-test.adyen.com\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Customer Area<\/a>. These details include:<\/p>\n<ul>\n<li>Payout amount<\/li>\n<li>Source and destination of the payout<\/li>\n<li>Completed and upcoming scheduled payouts<\/li>\n<\/ul>\n<p>You can view the details of all payout schedules and <a href=\"\/payouts\/payout-service\/internal-fund-transfers\/scheduled-fund-transfers\/\">internal transfer schedules<\/a> on the <strong>Balance account details<\/strong> page, under <strong>Scheduled transfers<\/strong>.<\/p>\n<p>To view the details of a scheduled payout:<\/p>\n<ol>\n<li>Go to <strong>Accounts &amp; balances<\/strong> &gt; <strong>Balance accounts<\/strong>.<\/li>\n<li>In the <strong>Balance platform<\/strong> dropdown, select the balance platform. You can view balance accounts from one balance platform at a time.<\/li>\n<li>In the balance account table, select a balance account ID to open the <strong>Balance account details<\/strong> page.<\/li>\n<li>Under <strong>Scheduled transfers<\/strong>, select a scheduled payout.<\/li>\n<li>Open the <strong>Details<\/strong> tab to view information about the scheduled payout.<\/li>\n<\/ol>\n<h2>See also<\/h2>\n<div class=\"see-also-links output-inline\" id=\"see-also\">\n<ul><li><a href=\"\/payouts\/payout-service\/view-transfers-details\"\n                        target=\"_self\"\n                        >\n                    View transfer details\n                <\/a><\/li><li><a href=\"\/payouts\/payout-service\/getting-paid\/payout-webhooks\"\n                        target=\"_self\"\n                        >\n                    Payout webhooks\n                <\/a><\/li><\/ul><\/div>\n","url":"https:\/\/docs.adyen.com\/payouts\/payout-service\/getting-paid\/scheduled-payouts","articleFields":{"description":"Set up scheduled automatic payouts to your verified bank account.","feedback_component":true,"id":"25142905","type":"page","_expandable":null,"operations":"","status":"current","last_edit_on":"20-04-2022 10:24","cache_enable":false,"search_tags":["sweep","sweeps","push sweep","push sweeps"],"parameters":{"payoutType":"scheduled","directoryPath":"\/payouts\/payout-service","model":"platform","counterpartyType":"transferInstrument","integrationType":"payouts","transferType":"payout"},"page_id":"f9919d58-0e39-485c-b858-1adc789a2b24","filters_component":false,"decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/payouts\/payout-service\/getting-paid\/scheduled-payouts","title":"Configure custom payout schedules","content":"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.\nWhen setting up a custom scheduled payout, consider the cutoff times 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.\nRequirements\nBefore you begin, take into account the following requirements:\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nYou must have a Payouts integration.\n\n\nAPI credential roles\nYour API credential for the  Transfers API must have the following role:TransferService Webservice Initiate role\n\n\nCustomer Area roles\nYou must have the following roles: Balance platform base roleConfigure scheduled payouts\n\n\nWebhooks\nTo track fund movements in your platform, you can subscribe to the following webhooks:  Transfer webhooks  Transaction webhooks\n\n\nCapabilities\nMake sure that your user has the following capability:sendToTransferInstrument\n\n\nSetup steps\nBefore you begin: Make sure that the account holder and transfer instrument are linked to the same legal entity.Contact our Support Team if you want to configure a default transfer description for your platform.We recommend that you calculate the available 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.\n\n\n\nHow it works\nYou can configure custom payout schedules on balance accounts in your platform. When you create a schedule, you can define the conditions that must be met for a payout to be initiated.\nYou can set the following conditions:\n\nSet a specific date and time.\nTransfer the entire available amount or a fixed amount.\nMaintain an amount on the balance account.\nSet an amount that triggers the payout.\n\nWhen 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.\nCreate a custom payout schedule (sweep)\nTo configure a custom payout schedule in your Customer Area:\n\n\nGo to Accounts &amp; balances &gt; Account holders, and search for the account holder.\n\n\nOpen the Balance accounts tab and select the relevant Balance account ID.\n\n\nUnder Scheduled transfers, select Add a schedule.\n\n\nChoose Pay out to another account as the transfer type, and select Continue.\n\n\nEnter and verify the required configuration details in their respective fields.\n\n\n\nField\nRequired\nDescription\n\n\n\n\nCurrency\n\nSet the currency of the transfer.\n\n\nWhat should the payout do?\n\nChoose how the funds are to be paid out. Possible values are: Transfer all available balance from this accountMaintain a specific balance in this accountTransfer a specific amount from this account\n\n\nMinimum balance for payout\n\nSet 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.\n\n\nTransfer balance to\n\nSelect the Transfer instrument.\n\n\nTransfer instrument\n\nSelect the ID of the transfer instrument.\n\n\n\n\n\nSelect Next to schedule.\n\n\nIf 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.\n\n\nEnter and verify the following configuration details in their respective fields.\n\n\n\nField\nRequired\nDescription\n\n\n\n\nHow frequently should the payout arrive?\n\nSet the payout frequency.If you set the frequency to Monthly or Weekly, you must also specify the day in the next step.\n\n\nWhat time should the payout be sent?\n\nSpecify the timing of the payout.\n\n\nDescription\n\nAn identifier for the transfer. \n\n\nReference for beneficiary\n\nThe 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, or a combination of both.\n\n\nTransfer priorities\n\nSpecify how fast you want the funds to arrive to your  bank account by setting a priority for the payout. A payout with a higher priority incurs higher fees.\n\n\n\n\n\nReview the information that you provided.\n\n\nSelect Add.\n\n\nThe details of your scheduled payouts are shown under Scheduled transfers.\nThe following example shows how to enter the configuration details.\n\n    \n    \n        \n            \n            \n                                    Example \u2014 Pay out to a bank account\n                            \n        \n        \n            \nYou 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.\n\n\n\nField\nDetails\n\n\n\n\nCurrency\nUSD\n\n\nWhat should the payout do?\nTransfer a specific amount from this account\n\n\nTransfer amount\n150 USD\n\n\nTransfer balance to\nTransfer instrument\n\n\nTransfer instrument\nSE00000000000000000000001\n\n\nHow frequently should the payout arrive?\nMonthly\n\n\nWhich day should the transfer arrive?\n1st\n\n\nWhat time should the payout be sent?\n07:00\n\n\nDescription\nMonthly scheduled payout\n\n\nReference for beneficiary\nPayout001\n\n\nTransfer priorities\nRegular\n\n\n\n\n        \n    \n\n\nGet updates when a sweep triggers a transfer request\nYou can view the status of funds transfers initiated by a payout in your Customer Area, or track them by listening to webhooks.\nTo track the status of funds transfers initiated by a payout:\n\nListen to the following webhooks:\n\n Transfer webhooks:\n\n balancePlatform.transfer.created webhook events notify you that funds will be deducted from a balance accounts.\n balancePlatform.transfer.updated webhook events notify of every status change of the funds transfer.\n\n\n Transaction webhooks: Adyen sends a  balancePlatform.transaction.created webhook event to inform your server that funds have been deducted from a balance account.\n\nAcknowledge the webhooks.\nIn the payload of the  balancePlatform.transfer.updated webhook, note that:\n\nThe event array includes all previous transfer events.\nThe sequenceNumber defines the number of webhooks sent for the transfer, including the current one.\n\n\nFor more details and examples, see Payout webhooks.\nView sweep details\nAfter you create a custom payout schedule, you can view the details of the resulting scheduled payout in your Customer Area. These details include:\n\nPayout amount\nSource and destination of the payout\nCompleted and upcoming scheduled payouts\n\nYou can view the details of all payout schedules and internal transfer schedules on the Balance account details page, under Scheduled transfers.\nTo view the details of a scheduled payout:\n\nGo to Accounts &amp; balances &gt; Balance accounts.\nIn the Balance platform dropdown, select the balance platform. You can view balance accounts from one balance platform at a time.\nIn the balance account table, select a balance account ID to open the Balance account details page.\nUnder Scheduled transfers, select a scheduled payout.\nOpen the Details tab to view information about the scheduled payout.\n\nSee also\n\n\n                    View transfer details\n                \n                    Payout webhooks\n                \n","type":"page","locale":"en","boost":16,"hierarchy":{"lvl0":"Home","lvl1":"Adyen Payouts","lvl2":"Payouts and Payments","lvl3":"Getting paid","lvl4":"Configure custom payout schedules"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/","lvl1":"https:\/\/docs.adyen.com\/payouts","lvl2":"https:\/\/docs.adyen.com\/payouts\/payout-service","lvl3":"https:\/\/docs.adyen.com\/payouts\/payout-service\/getting-paid","lvl4":"\/payouts\/payout-service\/getting-paid\/scheduled-payouts"},"levels":5,"category":"","category_color":"","tags":["sweep","sweeps","push sweep","push sweeps"]}}