Adyen-for-platform icon

Payment facilitators

Learn what additional information you must send in your requests if you are a payment facilitator.

Card schemes require you to send certain data points with each transaction. These data points must refer to your user, who is considered the Merchant of Record when a transaction is facilitated by your platform.

If you have set up stores in your balance platform, you do not need to perform the actions described on this page. Adyen sends the required data automatically in your payment request.

Requirements

Requirement Description
Integration type You must have an Adyen online payments integration and a checkout UI.
API credentials You must have credentials for the Checkout API.
Limitations You only need to send additional data in your payment requests if you are a registered payment facilitator, and didn't configure stores in your balance platform.

Send user data points with a transaction

During the /sessions or /payments authorization for each transaction, card schemes require data points that specify the following information about your user:

  • Unique identifier: You must assign a unique identifier to each of your users.
  • Name: You must provide an accurate name for the user that is present on the shopper's statement. For Mastercard, this includes an aggregator prefix.
  • Location: You must provide the user's location as the location of the transaction.

Required parameters

You must send additionalData parameters with the /sessions or /payments authorization. For cancellations, captures, and refunds, Adyen automatically populates your user's details from the initial payment.

Submit your request using AdditionalDataSubMerchant parameters.

The [subSellerNr] is always 1. Submit all additionalData parameters as:
additionalData.subMerchant.subSeller1.[parameter]

Required additional parameters Description
additionalData.subMerchant.numberOfSubSellers The number of users in the transaction. Set this to 1.
additionalData.subMerchant.subSeller[subSellerNr].id A unique identifier you assigned to your user.
additionalData.subMerchant.subSeller[subSellerNr].name The name of your user.
additionalData.subMerchant.subSeller[subSellerNr].street The street name and house number of your user's address.
additionalData.subMerchant.subSeller[subSellerNr].postalCode The postal code of your user's address, without dashes.
Required only in Canada and the United States.
additionalData.subMerchant.subSeller[subSellerNr].city The city of your user's address.
additionalData.subMerchant.subSeller[subSellerNr].state The state code of your user's address, if applicable.
additionalData.subMerchant.subSeller[subSellerNr].country The three-letter ISO country code of your user's address.

Before going live, confirm with your Adyen contact that the paymentFacilitatorIds and aggregatorPrefix is configured for your platform.

Here is an example of a split payment request facilitated on behalf of your user:

Split the funds of the payment
Expand view
Copy link to code block
Copy code
Copy code
curl https://checkout-test.adyen.com/checkout/v71/payments \
-H 'x-api-key: ADYEN_API_KEY' \
-H 'content-type: application/json' \
-X POST \
-d '{
"paymentMethod": {
"type": "scheme",
"number": "4111111111111111",
"cvc": "737",
"expiryMonth": "03",
"expiryYear": "2030",
"holderName": "John Smith"
},
"amount": {
"value": 40000,
"currency": "EUR"
},
"reference": "YOUR_ORDER_NUMBER",
"merchantAccount": "YOUR_MERCHANT_ACCOUNT",
"returnUrl": "https://your-company.com/...",
"splits":[
{
"amount": {
"value": 39600
},
"type": "BalanceAccount",
"account": "BA00000000000000000000001",
"reference": "Your reference for the sale amount.",
"description": "Your description for the sale amount."
},
{
"amount": {
"value": 400
},
"type": "Commission",
"reference": "Your reference for the commission.",
"description": "Your description for the commission."
},
{
"type": "PaymentFee",
"account": "BA00000000000000000000001",
"reference": "Your reference for the transaction fees.",
"description": "Your description for the transaction fees."
}
],
"additionalData" : {
"subMerchant.numberOfSubSellers" : 1,
"subMerchant.subSeller1.id" : "12345",
"subMerchant.subSeller1.name" : "Test Merchant",
"subMerchant.subSeller1.street" : "Street Address",
"subMerchant.subSeller1.postalCode" : "POSTAL_CODE",
"subMerchant.subSeller1.city" : "CITY",
"subMerchant.subSeller1.state" : "STATE",
"subMerchant.subSeller1.country" : "COUNTRY"
}
}'

As a payment facilitator, most payment methods allow you to facilitate ecommerce payments using an aggregated MID (your platform's scheme account), instead of requiring a MID per user.

Shopper statement

When shoppers check their bank statements, they need to be able to easily identify the charges they see. The text that describes charges is known as a transaction  description, statement descriptor, shopper statement, or billing descriptor. If shoppers do not recognize a transaction by its description:

  • There is a higher chance your shopper issues a chargeback.
  • You can get a fine from the relevant card scheme related to your chargeback rate.

To prevent these issues, ensure that your transaction description contains your brand or the (chain) merchant name that is most recognizable to the cardholder (as required by the card schemes), and optionally customize your transaction description.

If you are not using stores in your platform, you must configure the transaction description that appears on the shopper statement. Depending on this configuration, you can additionally provide a transaction-specific shopperStatement in your payment request. For more information, see Transaction description.