ADadyen
Custom payout schedules (sweeps)

Create a sweep

Changed on

Creates a sweep that results in moving funds from or to a balance account.

A sweep pulls in or pushes out funds based on a defined schedule, amount, currency, and a source or a destination.

post/balanceAccounts/{balanceAccountId}/sweeps

Request

  • Base URL
    https://balanceplatform-api-test.adyen.com/bcl/v2
  • URL
    https://balanceplatform-api-test.adyen.com/bcl/v2/balanceAccounts/{balanceAccountId}/sweeps
  • Auth
    • API key in query parameter clientKey
    • or HTTP basic
    • or API key in header X-API-Key

Path parameters

balanceAccountIdstring required

The unique identifier of the balance account.

Request body

category'bank' | 'internal' | 'platformPayment'

The type of transfer that results from the sweep.

Possible values:

Required when setting priorities.

currencystring required

The three-character ISO currency code in uppercase. For example, EUR.

The sweep currency must match any of the balances currencies.

descriptionstring

The message that will be used in the sweep transfer's description body with a maximum length of 140 characters.

If the message is longer after replacing placeholders, the message will be cut off at 140 characters.

prioritiesstring[]

The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on.

The request will be accepted as long as at least one of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide ["wire","regular"], and wire is not supported but regular is, the request will still be accepted and processed.

Possible values:

  • regular: For normal, low-value transactions.

  • fast: A faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.

  • wire: The fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.

  • instant: For instant funds transfers within the United States and in SEPA locations.

  • crossBorder: For high-value transfers to a recipient in a different country.

  • internal: For transfers to an Adyen-issued business bank account (by bank account number/IBAN).

Set category to bank. For more details, see optional priorities setup for marketplaces or platforms.

reason'accountHierarchyNotActive' | 'amountLimitExceeded' | 'approved' | 'counterpartyAccountBlocked' | 'counterpartyAccountClosed' | 'counterpartyAccountNotFound' | 'counterpartyAddressRequired' | 'counterpartyBankTimedOut' | 'counterpartyBankUnavailable' | 'directDebitNotSupported' | 'error' | 'notEnoughBalance' | 'refusedByCounterpartyBank' | 'routeNotFound' | 'transferInstrumentDoesNotExist' | 'unknown'

The reason for disabling the sweep.

reasonDetailstring

The human readable reason for disabling the sweep.

referencestring

Your reference for the sweep configuration.

referenceForBeneficiarystring

The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.

status'active' | 'inactive'

The status of the sweep. If not provided, by default, this is set to active.

Possible values:

  • active: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration.

  • inactive: the sweep is disabled and cannot be triggered.

type'pull' | 'push'

The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to push.

Possible values:

  • push: push out funds to a destination balance account or transfer instrument.

  • pull: pull in funds from a source merchant account, transfer instrument, or balance account.

Response

OK - the request has succeeded.

category'bank' | 'internal' | 'platformPayment'

The type of transfer that results from the sweep.

Possible values:

Required when setting priorities.

currencystring required

The three-character ISO currency code in uppercase. For example, EUR.

The sweep currency must match any of the balances currencies.

descriptionstring

The message that will be used in the sweep transfer's description body with a maximum length of 140 characters.

If the message is longer after replacing placeholders, the message will be cut off at 140 characters.

idstring required

The unique identifier of the sweep.

prioritiesstring[]

The list of priorities for the bank transfer. This sets the speed at which the transfer is sent and the fees that you have to pay. You can provide multiple priorities, ordered by your preference. Adyen will try to pay out using the priorities in the given order. If the first priority is not currently supported or enabled for your platform, the system will try the next one, and so on.

The request will be accepted as long as at least one of the provided priorities is valid (i.e., supported by Adyen and activated for your platform). For example, if you provide ["wire","regular"], and wire is not supported but regular is, the request will still be accepted and processed.

Possible values:

  • regular: For normal, low-value transactions.

  • fast: A faster way to transfer funds, but the fees are higher. Recommended for high-priority, low-value transactions.

  • wire: The fastest way to transfer funds, but this has the highest fees. Recommended for high-priority, high-value transactions.

  • instant: For instant funds transfers within the United States and in SEPA locations.

  • crossBorder: For high-value transfers to a recipient in a different country.

  • internal: For transfers to an Adyen-issued business bank account (by bank account number/IBAN).

Set category to bank. For more details, see optional priorities setup for marketplaces or platforms.

reason'accountHierarchyNotActive' | 'amountLimitExceeded' | 'approved' | 'counterpartyAccountBlocked' | 'counterpartyAccountClosed' | 'counterpartyAccountNotFound' | 'counterpartyAddressRequired' | 'counterpartyBankTimedOut' | 'counterpartyBankUnavailable' | 'directDebitNotSupported' | 'error' | 'notEnoughBalance' | 'refusedByCounterpartyBank' | 'routeNotFound' | 'transferInstrumentDoesNotExist' | 'unknown'

The reason for disabling the sweep.

reasonDetailstring

The human readable reason for disabling the sweep.

referencestring

Your reference for the sweep configuration.

referenceForBeneficiarystring

The reference sent to or received from the counterparty. Only alphanumeric characters are allowed.

status'active' | 'inactive'

The status of the sweep. If not provided, by default, this is set to active.

Possible values:

  • active: the sweep is enabled and funds will be pulled in or pushed out based on the defined configuration.

  • inactive: the sweep is disabled and cannot be triggered.

type'pull' | 'push'

The direction of sweep, whether pushing out or pulling in funds to the balance account. If not provided, by default, this is set to push.

Possible values:

  • push: push out funds to a destination balance account or transfer instrument.

  • pull: pull in funds from a source merchant account, transfer instrument, or balance account.

Changes

  • v287544766dc8eRevision changes
    • info

      api tag Custom payout schedules (sweeps) added

    • info

      api tag Balance accounts removed

  • v20d06f978a8b5Revision changes
    • info

      removed the enum value approvalExpired of the request read-only property reason

    • info

      removed the enum value balanceAccountTemporarilyBlockedByTransactionRule of the request read-only property reason

    • info

      removed the enum value declined of the request read-only property reason

    • info

      removed the enum value declinedByTransactionRule of the request read-only property reason

    • info

      removed the enum value pending of the request read-only property reason

    • info

      removed the enum value pendingApproval of the request read-only property reason

    • info

      removed the enum value pendingExecution of the request read-only property reason

    • info

      removed the enum value refusedByCustomer of the request read-only property reason

    • info

      removed the enum value scaFailed of the request read-only property reason

    • info

      removed the enum value schemeAdvice of the request read-only property reason

    • info

      removed the approvalExpired enum value from the response property for the response status

    • info

      removed the balanceAccountTemporarilyBlockedByTransactionRule enum value from the response property for the response status

    • info

      removed the declined enum value from the response property for the response status

    • info

      removed the declinedByTransactionRule enum value from the response property for the response status

    • info

      removed the pending enum value from the response property for the response status

    • info

      removed the pendingApproval enum value from the response property for the response status

    • info

      removed the pendingExecution enum value from the response property for the response status

    • info

      removed the refusedByCustomer enum value from the response property for the response status

    • info

      removed the scaFailed enum value from the response property for the response status

    • info

      removed the schemeAdvice enum value from the response property for the response status