{"title":"Split payments at authorization","category":"default","creationDate":1676564580,"content":"

When you authorize an online payment on behalf of your user, you can split the payment amount between the balance accounts in your platform by including the split instructions in your authorization request. This allows you to separately book the sale amount, your platform's commission, transaction fees, and the leftover amount after currency conversion.<\/p>\n

Requirements<\/h2>\n

Take into account the following requirements, limitations, and preparations to start processing payments.<\/p>\n\n\n\n\n\n\n\n\n\n\n
Requirement<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
Integration type<\/strong><\/td>\nYou must have an Adyen online payments integration and a checkout UI<\/a>.<\/td>\n<\/tr>\n
API credentials<\/a><\/strong><\/td>\nYou must have credentials for the following APIs:
Webhooks<\/a><\/strong><\/td>\nEnsure that your server can receive and accept standard webhooks<\/a>.
Subscribe to any of the following webhooks:
Capabilities<\/a><\/strong><\/td>\nMake sure that your account holders have the following capabilities:
  • receivePayments<\/strong><\/li>
  • receiveFromPlatformPayments<\/strong><\/li>
  • sendToTransferInstrument<\/strong><\/li><\/ul><\/td>\n<\/tr>\n
Limitations<\/strong><\/td>\nIf an account holder does not have the receiveFromPlatformPayments<\/strong> capability in a valid<\/strong> state, the funds cannot be allocated to their balance account. The full amount is booked to your liable balance account.<\/td>\n<\/tr>\n
<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

Split a payment between balance accounts<\/h2>\n

To split the payment amount at the time of authorization:<\/p>\n

    \n
  1. \n

    Add a splits<\/code> array to your POST \/payments<\/a> or POST \/sessions<\/a> request.<\/p>\n

    For each item in the \/payments splits array<\/a> or the \/sessions splits array<\/a>, specify the following fields:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n
    Parameter<\/th>\nRequired<\/th>\nDescription<\/th>\n<\/tr>\n<\/thead>\n
    account<\/code><\/td>\n\"Required\"<\/span><\/td>\nThe account that will receive (or be charged) the split amount. This is the balanceAccountId<\/code> of one of your user's balance accounts or your platform's liable balance account. You do not need to specify this field when type<\/code> is Commission<\/strong>.<\/td>\n<\/tr>\n
    amount.currency<\/code><\/td>\n\"Required\"<\/span><\/td>\nRequired for currency conversion
    The currency of the part of the payment you want to the specified account<\/code>.<\/td>\n<\/tr>\n
    amount.value<\/code><\/td>\n\"Required\"<\/span><\/td>\nThe value of the part of the payment you want to the specified account<\/code>. You do not need to specify this field for transaction fees or the remainder, because they are not known at the time of payment.<\/td>\n<\/td>\n<\/tr>\n
    store<\/code><\/td>\n\"Required\"<\/span><\/td>\nThe reference<\/a> of the store through which you want to process the payment.<\/td>\n<\/td>\n<\/tr>\n
    type<\/code><\/td>\n\"Required\"<\/span><\/td>\nDefines the part of the payment you want to book to the specified account<\/code>.
    Possible values:
    reference<\/code><\/td>\n\"Conditionally<\/span><\/td>\nRequired if type<\/code> is BalanceAccount<\/strong>
    Your unique identifier for the part of the payment you want to book to the specified account<\/code>. You need this for reconciliation, as explained under Best practices<\/a>.<\/td>\n<\/tr>\n
    description<\/code><\/td>\n<\/td>\nYour description for the part of the payment you want to booking to the specified account<\/code>, returned in our reports.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

    The following example shows how to split the payment amount at the time of payment, when a customer pays USD 80.00:<\/p>\n