Adyen-for-platform icon

In-person payments

Process in-person payments on behalf of your users.

After you configure the payment methods for the stores in your platform, your users can start accepting payments from their customers. To make sure that the pay-in, settlement, and payout processes run smoothly, you must book the incoming funds and fees to the correct balance accounts.

This means that in each individual payment, capture, and refund request that you send on behalf of your users, you have to include information on how to split the funds between your user's balance accounts and your platform's liable balance account.

In your requests, you can include specific instructions on booking:

Your platform's commission is always booked to your liable balance account.

Requirements

To process in-person payments for your users, you must:

Splitting transactions

Transactions processed through Adyen must be split between the balance accounts in your platform: your liable balance account and your users' balance accounts.

You can split funds into any number of balance accounts in your platform. For example, when a customer pays, you can split the funds into:

  • The sale amount, which goes to your user's balance account.
  • Your platform's commission, which goes to your platform's liable account.
  • The transaction fees, which can be charged to your user's balance account.
  • The remainder after currency conversion, which can be booked to your user's balance account.

You must send the split instructions with every payment, capture, or refund request, or configure automatic splits.

When you apply a split configuration profile to your user's store, Adyen evaluates the rules in the split configuration for all the transactions processed through that store. If you need to change the split information for specific transactions, you can send split data in the payment or capture API request. Any split data that you send through individual API requests overrides the automatic split configuration.

If you do not provide any split information, the whole transaction is booked to your platform's liable balance account, including all associated fees.

Split types

When you split a transaction between multiple balance accounts, each split serves a different purpose. For example, a part of the transaction goes to your liable balance account as your platform's commission, and a part goes to your user's balance account as the sale amount.

When you send an API request for a transaction, you must define split instructions for each split of the full transaction amount. In each set of split instructions, you must use the type field to define the purpose of that split.

Certain split types also require you to define other values in the split instructions. For example, when you want to book the split amount to your user's balance account (type is BalanceAccount), you must specify the ID of that balance account using the account parameter.

The following table shows the possible split type values you can send in your request, and whether you must send another parameter (account, amount, or reference) in the split instruction.

Split type Description Required additional parameters Recommended additional parameters
BalanceAccount Books the sale amount of the transaction to the specified account. This is the amount after all fees and commissions are deducted from the total transaction amount. account

amount

reference
Commission Books your platform's commission to your liable balance account. amount reference
Interchange Books the fee paid to the issuer to the specified account. If you do not specify an account, the fee is booked to your liable balance account. account

reference
SchemeFee Books the scheme fee to the specified account. If you do not specify an account, the fee is booked to your liable balance account. account

reference
AcquiringFees Books the aggregated amount of the interchange and scheme fees to the specified account. If you do not specify an account, the fee is booked to your liable balance account. account

reference
AdyenCommission Books the transaction fee due to Adyen under blended rates to the specific account. If you do not specify an account, the fee is booked to your liable balance account. account

reference
AdyenMarkup Books the transaction fee due to Adyen under Interchange ++ pricing to the specified account. If you do not specify an account, the fee is booked to your liable balance account. account

reference
AdyenFees Books the aggregated amount of Adyen's commission and markup to the specified balance account. If you do not specify an account, the fee is booked to your liable balance account. account

reference
PaymentFee Books the aggregated amount of all the transaction fees to the specified account. If you do not specify an account, the fee is booked to your liable balance account. account

reference
VAT Books the value-added tax (VAT) incurred on a payment to the specified account, allowing you to book this tax separately from the sale amount. If you do not specify an account, the VAT is booked to your liable balance account. amount account

reference
Surcharge Books the surcharge paid by the customer to the specified account. If you do not specify an account, the surcharge is booked to your liable balance account. account

reference
Tip Books the tip (gratuity) paid by the customer to the specified account. If you do not specify an account, the tip is booked to your liable balance account. The tip amount is provided by the customer on the terminal. account

reference

Next steps