{"title":"Schedule internal funds transfers","category":"default","creationDate":1571779920,"content":"

Automate internal funds transfers by configuring sweeps<\/em>, in the same manner as setting up scheduled payouts. A sweep automatically pushes out or pulls in funds from a balance account based on a pre-defined schedule, amount, and source or destination. For more information, refer to How sweeps work<\/a>.<\/p>\n

Configure a push<\/em> or pull<\/em> sweep depending on the scenario. For example, to maintain balances, you can set up a pull sweep to pull funds from another balance account when the balance goes below a certain amount. If you want to automate sending bonuses from your liable balance account, you can set up a push sweep to push funds from the liable balance account to your user's balance account.<\/p>\n

This page explains how to configure sweeps to schedule automatic transfers between balance accounts.<\/p>\n

Requirements<\/h2>\n

Before you begin, take into account the following requirements and preparations:<\/p>\n\n \n \n \n <\/colgroup>\n \n \n \n \n \n \n \n \n \n
Requirement<\/th>\n Description<\/th>\n <\/tr>\n <\/thead>\n
\n

Integration type<\/strong><\/p>\n<\/td>\n

\n

You need an Adyen for Platforms<\/a> integration.<\/p>\n<\/td>\n <\/tr>\n

\n

API credentials<\/a><\/strong><\/p>\n<\/td>\n

\n Your API credential for the Transfers API<\/a> must have the following role<\/a>:
\n
    \n
  • \n

    TransferService Webservice Initiate role<\/strong><\/p>\n<\/li>\n <\/ul>\n <\/td>\n <\/tr>\n

\n

Customer Area roles<\/a><\/strong><\/p>\n<\/td>\n

You need the following roles:
\n
    \n
  • \n

    Initiate internal transfers<\/strong><\/p>\n<\/li>\n

  • \n

    Balance platform base role<\/strong><\/p>\n<\/li>\n <\/ul>\n <\/td>\n <\/tr>\n

\n

Webhooks<\/a><\/strong><\/p>\n<\/td>\n

\n
    \n
  1. \n

    Make sure that your server receives and accepts webhooks.<\/p>\n<\/li>\n

  2. \n

    In your Customer Area, subscribe to Transfer webhooks<\/a>.<\/p>\n<\/li>\n <\/ol>\n <\/td>\n <\/tr>\n

\n

Capabilities<\/a><\/strong><\/p>\n<\/td>\n

\n If the balance accounts involved in the transfer do not belong to the same account holder<\/em>, check the capabilities<\/a> of the account holders:\n
    \n
  • \n

    The account holder of the balance account that sends the the transfer request must have the sendToBalanceAccount<\/strong> capability.<\/p>\n<\/li>\n

  • \n

    The account holder of the balance account that receives the transfer request must have the receiveFromBalanceAccount<\/strong> capability.<\/p>\n<\/li>\n <\/ul>\n <\/td>\n <\/tr>\n

\n

Setup steps<\/strong><\/p>\n<\/td>\n

\n

Before you begin your integration, contact our Support Team<\/a> to enable transfers for the source balance account.<\/p>\n<\/td>\n <\/tr>\n <\/tbody>\n<\/table>\n

Create a sweep<\/h2>\n

Configure sweeps by using your Customer Area<\/a>, or making a POST \/balanceAccounts\/{balanceAccountId}\/sweeps<\/a> request. In this example, we will use a push<\/em> sweep to push funds out of a balance account.<\/p>\n\n

\n
\n \n <\/tabs>\n <\/div>\n<\/div>\n\n

Step 2. Get updates when a transfer results from a sweep<\/h2>\n

For every internal transfer request that results from a sweep, Adyen sends multiple webhooks<\/a> to your server: a series of webhooks for the balance account where the transfer is an outgoing request, and a series of webhooks for the balance account where the transfer is an incoming request.<\/p>\n

Using these webhooks, you can track the status of the transfer: received<\/strong>, then authorised<\/strong>, and finally booked<\/strong>. The webhooks also inform you if the transfer failed.<\/p>\n

You can also view the transfer details in your Customer Area<\/a>. Each transfer of funds between balance accounts appears in the Customer Area as two transfer entries: one for the balance account that is credited, and one for the balance account that is debited.<\/p>\n

Troubleshooting<\/h2>\n

If an internal fund transfer fails, verify if there are enough funds in the source balance account:<\/p>\n

    \n
  1. Make a GET \/balanceAccounts\/{id}<\/a> request, specifying the source balance account's ID in the path.<\/li>\n
  2. Check the available<\/a> balance.<\/li>\n
  3. If the amount is lower than the transfer amount, you can:\n