{"title":"Payment facilitators","category":"default","creationDate":1776961628,"content":"<p>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.<\/p>\n<h2>Requirements<\/h2>\n<table>\n<thead>\n<tr>\n<th style=\"text-align: left;\">Requirement<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"><strong>Integration type<\/strong><\/td>\n<td style=\"text-align: left;\">You must have an Adyen <a href=\"\/pt\/online-payments\/build-your-integration\">online payments integration and a checkout UI<\/a>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"><strong><a href=\"\/pt\/development-resources\/api-credentials\/\">API credentials<\/a><\/strong><\/td>\n<td style=\"text-align: left;\">You must have credentials for the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/overview\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">Checkout API<\/a>.<\/td>\n<td><\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h2>Send user data points with a transaction<\/h2>\n<p>During the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/sessions\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/sessions<\/a> or  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> authorization for each transaction, card schemes require data points that specify the following information about your user:<\/p>\n<ul>\n<li><strong>Unique identifier<\/strong>: You must assign a unique identifier to each of your users.<\/li>\n<li><strong>Name<\/strong>: You must provide an accurate name for the user that is present on the shopper's statement. For Mastercard, this includes an aggregator prefix.<\/li>\n<li><strong>Location<\/strong>: You must provide the user's location as the location of the transaction.<\/li>\n<\/ul>\n<h3>Required parameters<\/h3>\n<p>You must send <code>additionalData<\/code> parameters with the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/sessions\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/sessions<\/a> or  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> authorization request. For cancellations, captures, and refunds, Adyen automatically populates your user's details from the initial payment.<\/p>\n<p>Submit your request using  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">AdditionalDataSubMerchant<\/a> parameters.<\/p>\n<div class=\"sc-notice info\"><div>\n<p>The <code>[subSellerNr]<\/code> is always <strong>1<\/strong>. Submit all <code>additionalData<\/code> parameters as:<br \/>\n<code>additionalData.subMerchant.subSeller1.[parameter]<\/code><\/p>\n<\/div><\/div>\n<table>\n<thead>\n<tr>\n<th>Required additional parameters<\/th>\n<th>Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-numberOfSubSellers\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.numberOfSubSellers<\/a><\/td>\n<td>The number of users in the transaction. Set this to <strong>1<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-id\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].id<\/a><\/td>\n<td>A unique identifier you assigned to your user.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-name\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].name<\/a><\/td>\n<td>The name of your user.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-street\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].street<\/a><\/td>\n<td>The street name and house number of your user's address.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-postalCode\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].postalCode<\/a><\/td>\n<td>The postal code of your user's address, without dashes.<br\/><i class=\"adl-icon-info-circle\"><\/i> Required only in Canada and the United States.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-city\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].city<\/a><\/td>\n<td>The city of your user's address.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-state\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].state<\/a><\/td>\n<td>The state code of your user's address, if applicable.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-country\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].country<\/a><\/td>\n<td>The three-letter <a href=\"https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1_alpha-3\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">ISO<\/a> country code of your user's address.<\/td>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-email\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].email<\/a><\/td>\n<td>The email address of the user.<\/td>\n<\/tr>\n<tr>\n<\/tr>\n<tr>\n<td> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-phoneNumber\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].phoneNumber<\/a><\/td>\n<td>The phone number of the user.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<div class=\"notices green\">\n<p>Before going live, confirm with your Adyen contact that the <code>paymentFacilitatorIds<\/code>, <code>aggregatorPrefix<\/code> and <code>amexCapnSubmitterId<\/code> are configured for your platform.<\/p>\n<\/div>\n<p>Here is an example of a split payment request facilitated on behalf of your user:<\/p>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Split the funds of the payment'\" :id=\"'payfac-split-payment-request'\" :code-data=\"[{&quot;language&quot;:&quot;bash&quot;,&quot;tabTitle&quot;:&quot;curl&quot;,&quot;content&quot;:&quot;curl https:\\\/\\\/checkout-test.adyen.com\\\/v72\\\/payments \\\\\\n-H 'x-api-key: ADYEN_API_KEY' \\\\\\n-H 'content-type: application\\\/json' \\\\\\n-X POST \\\\\\n-d '{\\n      \\&quot;paymentMethod\\&quot;: {\\n          \\&quot;type\\&quot;: \\&quot;scheme\\&quot;,\\n          \\&quot;number\\&quot;: \\&quot;4111111111111111\\&quot;,\\n          \\&quot;cvc\\&quot;: \\&quot;737\\&quot;,\\n          \\&quot;expiryMonth\\&quot;: \\&quot;03\\&quot;,\\n          \\&quot;expiryYear\\&quot;: \\&quot;2030\\&quot;,\\n          \\&quot;holderName\\&quot;: \\&quot;John Smith\\&quot;\\n      },\\n      \\&quot;amount\\&quot;: {\\n          \\&quot;value\\&quot;: 40000,\\n          \\&quot;currency\\&quot;: \\&quot;USD\\&quot;\\n      },\\n      \\&quot;reference\\&quot;: \\&quot;YOUR_ORDER_NUMBER\\&quot;,\\n      \\&quot;merchantAccount\\&quot;: \\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;,\\n      \\&quot;returnUrl\\&quot;: \\&quot;https:\\\/\\\/your-company.example.com\\\/...\\&quot;,\\n      \\&quot;splits\\&quot;:[\\n          {\\n              \\&quot;amount\\&quot;: {\\n                  \\&quot;value\\&quot;: 39600\\n              },\\n              \\&quot;type\\&quot;: \\&quot;BalanceAccount\\&quot;,\\n              \\&quot;account\\&quot;: \\&quot;BA00000000000000000000001\\&quot;,\\n              \\&quot;reference\\&quot;: \\&quot;Your reference for the sale amount.\\&quot;,\\n              \\&quot;description\\&quot;: \\&quot;Your description for the sale amount.\\&quot;\\n          },\\n          {\\n              \\&quot;amount\\&quot;: {\\n                  \\&quot;value\\&quot;: 400\\n              },\\n              \\&quot;type\\&quot;: \\&quot;Commission\\&quot;,\\n              \\&quot;reference\\&quot;: \\&quot;Your reference for your commission.\\&quot;,\\n              \\&quot;description\\&quot;: \\&quot;Your description for your commission.\\&quot;\\n          },\\n          {\\n              \\&quot;type\\&quot;: \\&quot;PaymentFee\\&quot;,\\n              \\&quot;account\\&quot;: \\&quot;BA00000000000000000000001\\&quot;,\\n              \\&quot;reference\\&quot;: \\&quot;Your reference for the transaction fees.\\&quot;,\\n              \\&quot;description\\&quot;: \\&quot;Your description for the transaction fees.\\&quot;\\n          }\\n      ],\\n      \\&quot;additionalData\\&quot; : {\\n          \\&quot;subMerchant.numberOfSubSellers\\&quot; : 1,\\n          \\&quot;subMerchant.subSeller1.id\\&quot; : \\&quot;12345\\&quot;,\\n          \\&quot;subMerchant.subSeller1.name\\&quot; : \\&quot;Test Merchant\\&quot;,\\n          \\&quot;subMerchant.subSeller1.street\\&quot; : \\&quot;Street Address\\&quot;,\\n          \\&quot;subMerchant.subSeller1.postalCode\\&quot; : \\&quot;POSTAL_CODE\\&quot;,\\n          \\&quot;subMerchant.subSeller1.city\\&quot; : \\&quot;CITY\\&quot;,\\n          \\&quot;subMerchant.subSeller1.state\\&quot; : \\&quot;STATE\\&quot;,\\n          \\&quot;subMerchant.subSeller1.country\\&quot; : \\&quot;COUNTRY\\&quot;\\n      }\\n}'&quot;},{&quot;language&quot;:&quot;java&quot;,&quot;tabTitle&quot;:&quot;Java&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Java API Library v25.0.0\\nimport com.adyen.Client;\\nimport com.adyen.enums.Environment;\\nimport com.adyen.model.checkout.*;\\nimport java.time.OffsetDateTime;\\nimport java.util.*;\\nimport com.adyen.model.RequestOptions;\\nimport com.adyen.service.checkout.*;\\n\\n\\\/\\\/ For the live environment, additionally include your liveEndpointUrlPrefix.\\nClient client = new Client(\\&quot;ADYEN_API_KEY\\&quot;, Environment.TEST);\\n\\n\\\/\\\/ Create the request object(s)\\nSplitAmount splitAmount1 = new SplitAmount()\\n  .value(39600L);\\n\\nSplitAmount splitAmount2 = new SplitAmount()\\n  .value(400L);\\n\\nAmount amount = new Amount()\\n  .currency(\\&quot;USD\\&quot;)\\n  .value(40000L);\\n\\nSplit split1 = new Split()\\n  .reference(\\&quot;Your reference for the sale amount.\\&quot;)\\n  .amount(splitAmount1)\\n  .description(\\&quot;Your description for the sale amount.\\&quot;)\\n  .type(Split.TypeEnum.BALANCEACCOUNT)\\n  .account(\\&quot;BA00000000000000000000001\\&quot;);\\n\\nSplit split2 = new Split()\\n  .reference(\\&quot;Your reference for your commission.\\&quot;)\\n  .amount(splitAmount2)\\n  .description(\\&quot;Your description for your commission.\\&quot;)\\n  .type(Split.TypeEnum.COMMISSION);\\n\\nSplit split3 = new Split()\\n  .reference(\\&quot;Your reference for the transaction fees.\\&quot;)\\n  .description(\\&quot;Your description for the transaction fees.\\&quot;)\\n  .type(Split.TypeEnum.PAYMENTFEE)\\n  .account(\\&quot;BA00000000000000000000001\\&quot;);\\n\\nCardDetails cardDetails = new CardDetails()\\n  .number(\\&quot;4111111111111111\\&quot;)\\n  .cvc(\\&quot;737\\&quot;)\\n  .holderName(\\&quot;John Smith\\&quot;)\\n  .expiryMonth(\\&quot;03\\&quot;)\\n  .expiryYear(\\&quot;2030\\&quot;)\\n  .type(CardDetails.TypeEnum.SCHEME);\\n\\nPaymentRequest paymentRequest = new PaymentRequest()\\n  .reference(\\&quot;YOUR_ORDER_NUMBER\\&quot;)\\n  .amount(amount)\\n  .splits(Arrays.asList(split1, split2, split3))\\n  .merchantAccount(\\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;)\\n  .paymentMethod(new CheckoutPaymentMethod(cardDetails))\\n  .additionalData(new HashMap&lt;String, String&gt;(Map.of(\\n    \\&quot;subMerchant.subSeller1.postalCode\\&quot;, \\&quot;POSTAL_CODE\\&quot;,\\n    \\&quot;subMerchant.subSeller1.id\\&quot;, \\&quot;12345\\&quot;,\\n    \\&quot;subMerchant.subSeller1.street\\&quot;, \\&quot;Street Address\\&quot;,\\n    \\&quot;subMerchant.subSeller1.country\\&quot;, \\&quot;COUNTRY\\&quot;,\\n    \\&quot;subMerchant.subSeller1.city\\&quot;, \\&quot;CITY\\&quot;,\\n    \\&quot;subMerchant.subSeller1.state\\&quot;, \\&quot;STATE\\&quot;,\\n    \\&quot;subMerchant.numberOfSubSellers\\&quot;, \\&quot;1\\&quot;,\\n    \\&quot;subMerchant.subSeller1.name\\&quot;, \\&quot;Test Merchant\\&quot;\\n  )))\\n  .returnUrl(\\&quot;https:\\\/\\\/your-company.example.com\\\/...\\&quot;);\\n\\n\\\/\\\/ Make the API call\\nPaymentsApi service = new PaymentsApi(client);\\nPaymentResponse response = service.payments(paymentRequest, new RequestOptions().idempotencyKey(\\&quot;UUID\\&quot;));&quot;},{&quot;language&quot;:&quot;php&quot;,&quot;tabTitle&quot;:&quot;PHP&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen PHP API Library v17.4.0\\nuse Adyen\\\\Client;\\nuse Adyen\\\\Environment;\\nuse Adyen\\\\Model\\\\Checkout\\\\Amount;\\nuse Adyen\\\\Model\\\\Checkout\\\\Split;\\nuse Adyen\\\\Model\\\\Checkout\\\\CheckoutPaymentMethod;\\nuse Adyen\\\\Model\\\\Checkout\\\\SplitAmount;\\nuse Adyen\\\\Model\\\\Checkout\\\\PaymentRequest;\\nuse Adyen\\\\Service\\\\Checkout\\\\PaymentsApi;\\n\\n$client = new Client();\\n$client-&gt;setXApiKey(\\&quot;ADYEN_API_KEY\\&quot;);\\n\\\/\\\/ For the live environment, additionally include your liveEndpointUrlPrefix.\\n$client-&gt;setEnvironment(Environment::TEST);\\n\\n\\n\\\/\\\/ Create the request object(s)\\n$splitAmount1 = new SplitAmount();\\n$splitAmount1\\n  -&gt;setValue(39600);\\n\\n$splitAmount2 = new SplitAmount();\\n$splitAmount2\\n  -&gt;setValue(400);\\n\\n$amount = new Amount();\\n$amount\\n  -&gt;setCurrency(\\&quot;USD\\&quot;)\\n  -&gt;setValue(40000);\\n\\n$split1 = new Split();\\n$split1\\n  -&gt;setReference(\\&quot;Your reference for the sale amount.\\&quot;)\\n  -&gt;setAmount($splitAmount1)\\n  -&gt;setDescription(\\&quot;Your description for the sale amount.\\&quot;)\\n  -&gt;setType(\\&quot;BalanceAccount\\&quot;)\\n  -&gt;setAccount(\\&quot;BA00000000000000000000001\\&quot;);\\n\\n$split2 = new Split();\\n$split2\\n  -&gt;setReference(\\&quot;Your reference for your commission.\\&quot;)\\n  -&gt;setAmount($splitAmount2)\\n  -&gt;setDescription(\\&quot;Your description for your commission.\\&quot;)\\n  -&gt;setType(\\&quot;Commission\\&quot;);\\n\\n$split3 = new Split();\\n$split3\\n  -&gt;setReference(\\&quot;Your reference for the transaction fees.\\&quot;)\\n  -&gt;setDescription(\\&quot;Your description for the transaction fees.\\&quot;)\\n  -&gt;setType(\\&quot;PaymentFee\\&quot;)\\n  -&gt;setAccount(\\&quot;BA00000000000000000000001\\&quot;);\\n\\n$checkoutPaymentMethod = new CheckoutPaymentMethod();\\n$checkoutPaymentMethod\\n  -&gt;setNumber(\\&quot;4111111111111111\\&quot;)\\n  -&gt;setCvc(\\&quot;737\\&quot;)\\n  -&gt;setHolderName(\\&quot;John Smith\\&quot;)\\n  -&gt;setExpiryMonth(\\&quot;03\\&quot;)\\n  -&gt;setExpiryYear(\\&quot;2030\\&quot;)\\n  -&gt;setType(\\&quot;scheme\\&quot;);\\n\\n$paymentRequest = new PaymentRequest();\\n$paymentRequest\\n  -&gt;setReference(\\&quot;YOUR_ORDER_NUMBER\\&quot;)\\n  -&gt;setAmount($amount)\\n  -&gt;setSplits(array($split1, $split2, $split3))\\n  -&gt;setMerchantAccount(\\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;)\\n  -&gt;setPaymentMethod($checkoutPaymentMethod)\\n  -&gt;setAdditionalData(\\n    array(\\n      \\&quot;subMerchant.subSeller1.postalCode\\&quot; =&gt; \\&quot;POSTAL_CODE\\&quot;,\\n      \\&quot;subMerchant.subSeller1.id\\&quot; =&gt; \\&quot;12345\\&quot;,\\n      \\&quot;subMerchant.subSeller1.street\\&quot; =&gt; \\&quot;Street Address\\&quot;,\\n      \\&quot;subMerchant.subSeller1.country\\&quot; =&gt; \\&quot;COUNTRY\\&quot;,\\n      \\&quot;subMerchant.subSeller1.city\\&quot; =&gt; \\&quot;CITY\\&quot;,\\n      \\&quot;subMerchant.subSeller1.state\\&quot; =&gt; \\&quot;STATE\\&quot;,\\n      \\&quot;subMerchant.numberOfSubSellers\\&quot; =&gt; \\&quot;1\\&quot;,\\n      \\&quot;subMerchant.subSeller1.name\\&quot; =&gt; \\&quot;Test Merchant\\&quot;\\n    )\\n  )\\n  -&gt;setReturnUrl(\\&quot;https:\\\/\\\/your-company.example.com\\\/...\\&quot;);\\n\\n$requestOptions['idempotencyKey'] = 'UUID';\\n\\n\\\/\\\/ Make the API call\\n$service = new PaymentsApi($client);\\n$response = $service-&gt;payments($paymentRequest, $requestOptions);&quot;},{&quot;language&quot;:&quot;cs&quot;,&quot;tabTitle&quot;:&quot;C#&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen .net API Library v14.4.0\\nusing Adyen;\\nusing Environment = Adyen.Model.Environment;\\nusing Adyen.Model;\\nusing Adyen.Model.Checkout;\\nusing Adyen.Service.Checkout;\\n\\n\\\/\\\/ For the live environment, additionally include your liveEndpointUrlPrefix.\\nvar config = new Config()\\n{\\n    XApiKey = \\&quot;ADYEN_API_KEY\\&quot;,\\n    Environment = Environment.Test\\n};\\nvar client = new Client(config);\\n\\n\\\/\\\/ Create the request object(s)\\nSplitAmount splitAmount1 = new SplitAmount\\n{\\n  Value = 39600\\n};\\n\\nSplitAmount splitAmount2 = new SplitAmount\\n{\\n  Value = 400\\n};\\n\\nAmount amount = new Amount\\n{\\n  Currency = \\&quot;USD\\&quot;,\\n  Value = 40000\\n};\\n\\nSplit split1 = new Split\\n{\\n  Reference = \\&quot;Your reference for the sale amount.\\&quot;,\\n  Amount = splitAmount1,\\n  Description = \\&quot;Your description for the sale amount.\\&quot;,\\n  Type = Split.TypeEnum.BalanceAccount,\\n  Account = \\&quot;BA00000000000000000000001\\&quot;\\n};\\n\\nSplit split2 = new Split\\n{\\n  Reference = \\&quot;Your reference for your commission.\\&quot;,\\n  Amount = splitAmount2,\\n  Description = \\&quot;Your description for your commission.\\&quot;,\\n  Type = Split.TypeEnum.Commission\\n};\\n\\nSplit split3 = new Split\\n{\\n  Reference = \\&quot;Your reference for the transaction fees.\\&quot;,\\n  Description = \\&quot;Your description for the transaction fees.\\&quot;,\\n  Type = Split.TypeEnum.PaymentFee,\\n  Account = \\&quot;BA00000000000000000000001\\&quot;\\n};\\n\\nCardDetails cardDetails = new CardDetails\\n{\\n  Number = \\&quot;4111111111111111\\&quot;,\\n  Cvc = \\&quot;737\\&quot;,\\n  HolderName = \\&quot;John Smith\\&quot;,\\n  ExpiryMonth = \\&quot;03\\&quot;,\\n  ExpiryYear = \\&quot;2030\\&quot;,\\n  Type = CardDetails.TypeEnum.Scheme\\n};\\n\\nPaymentRequest paymentRequest = new PaymentRequest\\n{\\n  Reference = \\&quot;YOUR_ORDER_NUMBER\\&quot;,\\n  Amount = amount,\\n  Splits = new List&lt;Split&gt;{ split1, split2, split3 },\\n  MerchantAccount = \\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;,\\n  PaymentMethod = new CheckoutPaymentMethod(cardDetails),\\n  AdditionalData = new Dictionary&lt;string, string&gt;\\n  {\\n\\n    { \\&quot;subMerchant.subSeller1.postalCode\\&quot;, \\&quot;POSTAL_CODE\\&quot; },\\n    { \\&quot;subMerchant.subSeller1.id\\&quot;, \\&quot;12345\\&quot; },\\n    { \\&quot;subMerchant.subSeller1.street\\&quot;, \\&quot;Street Address\\&quot; },\\n    { \\&quot;subMerchant.subSeller1.country\\&quot;, \\&quot;COUNTRY\\&quot; },\\n    { \\&quot;subMerchant.subSeller1.city\\&quot;, \\&quot;CITY\\&quot; },\\n    { \\&quot;subMerchant.subSeller1.state\\&quot;, \\&quot;STATE\\&quot; },\\n    { \\&quot;subMerchant.numberOfSubSellers\\&quot;, \\&quot;1\\&quot; },\\n    { \\&quot;subMerchant.subSeller1.name\\&quot;, \\&quot;Test Merchant\\&quot; }\\n  },\\n  ReturnUrl = \\&quot;https:\\\/\\\/your-company.example.com\\\/...\\&quot;\\n};\\n\\n\\\/\\\/ Make the API call\\nvar service = new PaymentsService(client);\\nvar response = service.Payments(paymentRequest, requestOptions: new RequestOptions { IdempotencyKey = \\&quot;UUID\\&quot;});&quot;},{&quot;language&quot;:&quot;js&quot;,&quot;tabTitle&quot;:&quot;NodeJS (JavaScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v16.2.0\\n\\\/\\\/ Require the parts of the module you want to use\\nconst { Client, CheckoutAPI } = require('@adyen\\\/api-library');\\n\\\/\\\/ Initialize the client object\\n\\\/\\\/ For the live environment, additionally include your liveEndpointUrlPrefix.\\nconst client = new Client({apiKey: \\&quot;ADYEN_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot;});\\n\\n\\\/\\\/ Create the request object(s)\\nconst paymentRequest = {\\n  paymentMethod: {\\n    type: \\&quot;scheme\\&quot;,\\n    number: \\&quot;4111111111111111\\&quot;,\\n    cvc: \\&quot;737\\&quot;,\\n    expiryMonth: \\&quot;03\\&quot;,\\n    expiryYear: \\&quot;2030\\&quot;,\\n    holderName: \\&quot;John Smith\\&quot;\\n  },\\n  amount: {\\n    value: 40000,\\n    currency: \\&quot;EUR\\&quot;\\n  },\\n  reference: \\&quot;YOUR_ORDER_NUMBER\\&quot;,\\n  merchantAccount: \\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;,\\n  returnUrl: \\&quot;https:\\\/\\\/your-company.example.com\\\/...\\&quot;,\\n  splits: [ {\\n    amount: {\\n      value: 39600\\n    },\\n    type: \\&quot;BalanceAccount\\&quot;,\\n    account: \\&quot;BA00000000000000000000001\\&quot;,\\n    reference: \\&quot;Your reference for the sale amount.\\&quot;,\\n    description: \\&quot;Your description for the sale amount.\\&quot;\\n  }, {\\n    amount: {\\n      value: 400\\n    },\\n    type: \\&quot;Commission\\&quot;,\\n    reference: \\&quot;Your reference for the commission.\\&quot;,\\n    description: \\&quot;Your description for the commission.\\&quot;\\n  }, {\\n    type: \\&quot;PaymentFee\\&quot;,\\n    account: \\&quot;BA00000000000000000000001\\&quot;,\\n    reference: \\&quot;Your reference for the transaction fees.\\&quot;,\\n    description: \\&quot;Your description for the transaction fees.\\&quot;\\n  } ],\\n  additionalData: {\\n    \\&quot;subMerchant.numberOfSubSellers\\&quot; : 1,\\n    \\&quot;subMerchant.subSeller1.id\\&quot; : \\&quot;12345\\&quot;,\\n    \\&quot;subMerchant.subSeller1.name\\&quot; : \\&quot;Test Merchant\\&quot;,\\n    \\&quot;subMerchant.subSeller1.street\\&quot; : \\&quot;Street Address\\&quot;,\\n    \\&quot;subMerchant.subSeller1.postalCode\\&quot; : \\&quot;POSTAL_CODE\\&quot;,\\n    \\&quot;subMerchant.subSeller1.city\\&quot; : \\&quot;CITY\\&quot;,\\n    \\&quot;subMerchant.subSeller1.state\\&quot; : \\&quot;STATE\\&quot;,\\n    \\&quot;subMerchant.subSeller1.country\\&quot; : \\&quot;COUNTRY\\&quot;\\n  }\\n}\\n\\n\\\/\\\/ Make the API call\\nconst checkoutAPI = new CheckoutAPI(client);\\nconst response = checkoutAPI.PaymentsApi.payments(paymentRequest, { idempotencyKey: \\&quot;UUID\\&quot; });&quot;},{&quot;language&quot;:&quot;go&quot;,&quot;tabTitle&quot;:&quot;Go&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Go API Library v9.3.0\\nimport (\\n  \\&quot;context\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v9\\\/src\\\/common\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v9\\\/src\\\/adyen\\&quot;\\n  \\&quot;github.com\\\/adyen\\\/adyen-go-api-library\\\/v9\\\/src\\\/checkout\\&quot;\\n)\\n\\\/\\\/ For the live environment, additionally include your liveEndpointUrlPrefix.\\nclient := adyen.NewClient(&amp;common.Config{\\n  ApiKey:      \\&quot;ADYEN_API_KEY\\&quot;,\\n  Environment: common.TestEnv,\\n})\\n\\n\\\/\\\/ Create the request object(s)\\nsplitAmount1 := checkout.SplitAmount{\\n  Value: 39600,\\n}\\n\\nsplitAmount2 := checkout.SplitAmount{\\n  Value: 400,\\n}\\n\\namount := checkout.Amount{\\n  Currency: \\&quot;USD\\&quot;,\\n  Value: 40000,\\n}\\n\\nsplit1 := checkout.Split{\\n  Reference: common.PtrString(\\&quot;Your reference for the sale amount.\\&quot;),\\n  Amount: &amp;splitAmount1,\\n  Description: common.PtrString(\\&quot;Your description for the sale amount.\\&quot;),\\n  Type: \\&quot;BalanceAccount\\&quot;,\\n  Account: common.PtrString(\\&quot;BA00000000000000000000001\\&quot;),\\n}\\n\\nsplit2 := checkout.Split{\\n  Reference: common.PtrString(\\&quot;Your reference for your commission.\\&quot;),\\n  Amount: &amp;splitAmount2,\\n  Description: common.PtrString(\\&quot;Your description for your commission.\\&quot;),\\n  Type: \\&quot;Commission\\&quot;,\\n}\\n\\nsplit3 := checkout.Split{\\n  Reference: common.PtrString(\\&quot;Your reference for the transaction fees.\\&quot;),\\n  Description: common.PtrString(\\&quot;Your description for the transaction fees.\\&quot;),\\n  Type: \\&quot;PaymentFee\\&quot;,\\n  Account: common.PtrString(\\&quot;BA00000000000000000000001\\&quot;),\\n}\\n\\ncardDetails := checkout.CardDetails{\\n  Number: common.PtrString(\\&quot;4111111111111111\\&quot;),\\n  Cvc: common.PtrString(\\&quot;737\\&quot;),\\n  HolderName: common.PtrString(\\&quot;John Smith\\&quot;),\\n  ExpiryMonth: common.PtrString(\\&quot;03\\&quot;),\\n  ExpiryYear: common.PtrString(\\&quot;2030\\&quot;),\\n  Type: common.PtrString(\\&quot;scheme\\&quot;),\\n}\\n\\npaymentRequest := checkout.PaymentRequest{\\n  Reference: \\&quot;YOUR_ORDER_NUMBER\\&quot;,\\n  Amount: amount,\\n  Splits: []checkout.Split{\\n      split1, split2, split3,\\n  },\\n  MerchantAccount: \\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;,\\n  PaymentMethod: checkout.CardDetailsAsCheckoutPaymentMethod(&amp;cardDetails),\\n  AdditionalData: &amp;map[string]string{\\n    \\&quot;subMerchant.subSeller1.postalCode\\&quot;: \\&quot;POSTAL_CODE\\&quot;,\\n    \\&quot;subMerchant.subSeller1.id\\&quot;: \\&quot;12345\\&quot;,\\n    \\&quot;subMerchant.subSeller1.street\\&quot;: \\&quot;Street Address\\&quot;,\\n    \\&quot;subMerchant.subSeller1.country\\&quot;: \\&quot;COUNTRY\\&quot;,\\n    \\&quot;subMerchant.subSeller1.city\\&quot;: \\&quot;CITY\\&quot;,\\n    \\&quot;subMerchant.subSeller1.state\\&quot;: \\&quot;STATE\\&quot;,\\n    \\&quot;subMerchant.numberOfSubSellers\\&quot;: \\&quot;1\\&quot;,\\n    \\&quot;subMerchant.subSeller1.name\\&quot;: \\&quot;Test Merchant\\&quot;,\\n  },\\n  ReturnUrl: \\&quot;https:\\\/\\\/your-company.example.com\\\/...\\&quot;,\\n}\\n\\n\\\/\\\/ Make the API call\\nservice := client.Checkout()\\nreq := service.PaymentsApi.PaymentsInput().IdempotencyKey(\\&quot;UUID\\&quot;).PaymentRequest(paymentRequest)\\nres, httpRes, err := service.PaymentsApi.Payments(context.Background(), req)&quot;},{&quot;language&quot;:&quot;py&quot;,&quot;tabTitle&quot;:&quot;Python&quot;,&quot;content&quot;:&quot;# Adyen Python API Library v12.2.0\\nimport Adyen\\n\\nadyen = Adyen.Adyen()\\nadyen.client.xapikey = \\&quot;ADYEN_API_KEY\\&quot;\\n# For the live environment, additionally include your liveEndpointUrlPrefix.\\nadyen.client.platform = \\&quot;test\\&quot; # The environment to use library in.\\n\\n# Create the request object(s)\\njson_request = {\\n  \\&quot;paymentMethod\\&quot;: {\\n    \\&quot;type\\&quot;: \\&quot;scheme\\&quot;,\\n    \\&quot;number\\&quot;: \\&quot;4111111111111111\\&quot;,\\n    \\&quot;cvc\\&quot;: \\&quot;737\\&quot;,\\n    \\&quot;expiryMonth\\&quot;: \\&quot;03\\&quot;,\\n    \\&quot;expiryYear\\&quot;: \\&quot;2030\\&quot;,\\n    \\&quot;holderName\\&quot;: \\&quot;John Smith\\&quot;\\n  },\\n  \\&quot;amount\\&quot;: {\\n    \\&quot;value\\&quot;: 40000,\\n    \\&quot;currency\\&quot;: \\&quot;USD\\&quot;\\n  },\\n  \\&quot;reference\\&quot;: \\&quot;YOUR_ORDER_NUMBER\\&quot;,\\n  \\&quot;merchantAccount\\&quot;: \\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;,\\n  \\&quot;returnUrl\\&quot;: \\&quot;https:\\\/\\\/your-company.example.com\\\/...\\&quot;,\\n  \\&quot;splits\\&quot;: [ {\\n    \\&quot;amount\\&quot;: {\\n      \\&quot;value\\&quot;: 39600\\n    },\\n    \\&quot;type\\&quot;: \\&quot;BalanceAccount\\&quot;,\\n    \\&quot;account\\&quot;: \\&quot;BA00000000000000000000001\\&quot;,\\n    \\&quot;reference\\&quot;: \\&quot;Your reference for the sale amount.\\&quot;,\\n    \\&quot;description\\&quot;: \\&quot;Your description for the sale amount.\\&quot;\\n  }, {\\n    \\&quot;amount\\&quot;: {\\n      \\&quot;value\\&quot;: 400\\n    },\\n    \\&quot;type\\&quot;: \\&quot;Commission\\&quot;,\\n    \\&quot;reference\\&quot;: \\&quot;Your reference for your commission.\\&quot;,\\n    \\&quot;description\\&quot;: \\&quot;Your description for your commission.\\&quot;\\n  }, {\\n    \\&quot;type\\&quot;: \\&quot;PaymentFee\\&quot;,\\n    \\&quot;account\\&quot;: \\&quot;BA00000000000000000000001\\&quot;,\\n    \\&quot;reference\\&quot;: \\&quot;Your reference for the transaction fees.\\&quot;,\\n    \\&quot;description\\&quot;: \\&quot;Your description for the transaction fees.\\&quot;\\n  } ],\\n  \\&quot;additionalData\\&quot;: {\\n    \\&quot;subMerchant.numberOfSubSellers\\&quot; : 1,\\n    \\&quot;subMerchant.subSeller1.id\\&quot; : \\&quot;12345\\&quot;,\\n    \\&quot;subMerchant.subSeller1.name\\&quot; : \\&quot;Test Merchant\\&quot;,\\n    \\&quot;subMerchant.subSeller1.street\\&quot; : \\&quot;Street Address\\&quot;,\\n    \\&quot;subMerchant.subSeller1.postalCode\\&quot; : \\&quot;POSTAL_CODE\\&quot;,\\n    \\&quot;subMerchant.subSeller1.city\\&quot; : \\&quot;CITY\\&quot;,\\n    \\&quot;subMerchant.subSeller1.state\\&quot; : \\&quot;STATE\\&quot;,\\n    \\&quot;subMerchant.subSeller1.country\\&quot; : \\&quot;COUNTRY\\&quot;\\n  }\\n}\\n\\n# Make the API call\\nresult = adyen.checkout.payments_api.payments(request=json_request, idempotency_key=\\&quot;UUID\\&quot;)&quot;},{&quot;language&quot;:&quot;rb&quot;,&quot;tabTitle&quot;:&quot;Ruby&quot;,&quot;content&quot;:&quot;# Adyen Ruby API Library v9.3.0\\nrequire \\&quot;adyen-ruby-api-library\\&quot;\\n\\nadyen = Adyen::Client.new\\nadyen.api_key = 'ADYEN_API_KEY'\\n# For the live environment, additionally include your liveEndpointUrlPrefix.\\nadyen.env = :test # Set to \\&quot;live\\&quot; for live environment\\n\\n# Create the request object(s)\\nrequest_body = {\\n  :paymentMethod =&gt; {\\n    :type =&gt; 'scheme',\\n    :number =&gt; '4111111111111111',\\n    :cvc =&gt; '737',\\n    :expiryMonth =&gt; '03',\\n    :expiryYear =&gt; '2030',\\n    :holderName =&gt; 'John Smith'\\n  },\\n  :amount =&gt; {\\n    :value =&gt; 40000,\\n    :currency =&gt; 'USD'\\n  },\\n  :reference =&gt; 'YOUR_ORDER_NUMBER',\\n  :merchantAccount =&gt; 'YOUR_MERCHANT_ACCOUNT',\\n  :returnUrl =&gt; 'https:\\\/\\\/your-company.example.com\\\/...',\\n  :splits =&gt; [ {\\n    :amount =&gt; {\\n      :value =&gt; 39600\\n    },\\n    :type =&gt; 'BalanceAccount',\\n    :account =&gt; 'BA00000000000000000000001',\\n    :reference =&gt; 'Your reference for the sale amount.',\\n    :description =&gt; 'Your description for the sale amount.'\\n  }, {\\n    :amount =&gt; {\\n      :value =&gt; 400\\n    },\\n    :type =&gt; 'Commission',\\n    :reference =&gt; 'Your reference for your commission.',\\n    :description =&gt; 'Your description for your commission.'\\n  }, {\\n    :type =&gt; 'PaymentFee',\\n    :account =&gt; 'BA00000000000000000000001',\\n    :reference =&gt; 'Your reference for the transaction fees.',\\n    :description =&gt; 'Your description for the transaction fees.'\\n  } ],\\n  :additionalData =&gt; {\\n    :subMerchant.numberOfSubSellers =&gt; 1,\\n    :subMerchant.subSeller1.id =&gt; '12345',\\n    :subMerchant.subSeller1.name =&gt; 'Test Merchant',\\n    :subMerchant.subSeller1.street =&gt; 'Street Address',\\n    :subMerchant.subSeller1.postalCode =&gt; 'POSTAL_CODE',\\n    :subMerchant.subSeller1.city =&gt; 'CITY',\\n    :subMerchant.subSeller1.state =&gt; 'STATE',\\n    :subMerchant.subSeller1.country =&gt; 'COUNTRY'\\n  }\\n}\\n\\n# Make the API call\\nresult = adyen.checkout.payments_api.payments(request_body, headers: { 'Idempotency-Key' =&gt; 'UUID' })&quot;},{&quot;language&quot;:&quot;ts&quot;,&quot;tabTitle&quot;:&quot;NodeJS (TypeScript)&quot;,&quot;content&quot;:&quot;\\\/\\\/ Adyen Node API Library v16.2.0\\n\\\/\\\/ Require the parts of the module you want to use\\nimport { Client, CheckoutAPI, Types } from \\&quot;@adyen\\\/api-library\\&quot;;\\n\\\/\\\/ Initialize the client object\\n\\\/\\\/ For the live environment, additionally include your liveEndpointUrlPrefix.\\nconst client = new Client({apiKey: \\&quot;ADYEN_API_KEY\\&quot;, environment: \\&quot;TEST\\&quot;});\\n\\n\\\/\\\/ Create the request object(s)\\nconst splitAmount1: Types.checkout.SplitAmount = {\\n  value: 39600\\n};\\n\\nconst splitAmount2: Types.checkout.SplitAmount = {\\n  value: 400\\n};\\n\\nconst amount: Types.checkout.Amount = {\\n  currency: \\&quot;USD\\&quot;,\\n  value: 40000\\n};\\n\\nconst split1: Types.checkout.Split = {\\n  reference: \\&quot;Your reference for the sale amount.\\&quot;,\\n  amount: splitAmount1,\\n  description: \\&quot;Your description for the sale amount.\\&quot;,\\n  type: Types.checkout.Split.TypeEnum.BalanceAccount,\\n  account: \\&quot;BA00000000000000000000001\\&quot;\\n};\\n\\nconst split2: Types.checkout.Split = {\\n  reference: \\&quot;Your reference for your commission.\\&quot;,\\n  amount: splitAmount2,\\n  description: \\&quot;Your description for your commission.\\&quot;,\\n  type: Types.checkout.Split.TypeEnum.Commission\\n};\\n\\nconst split3: Types.checkout.Split = {\\n  reference: \\&quot;Your reference for the transaction fees.\\&quot;,\\n  description: \\&quot;Your description for the transaction fees.\\&quot;,\\n  type: Types.checkout.Split.TypeEnum.PaymentFee,\\n  account: \\&quot;BA00000000000000000000001\\&quot;\\n};\\n\\nconst cardDetails: Types.checkout.CardDetails = {\\n  number: \\&quot;4111111111111111\\&quot;,\\n  cvc: \\&quot;737\\&quot;,\\n  holderName: \\&quot;John Smith\\&quot;,\\n  expiryMonth: \\&quot;03\\&quot;,\\n  expiryYear: \\&quot;2030\\&quot;,\\n  type: Types.checkout.CardDetails.TypeEnum.Scheme\\n};\\n\\nconst paymentRequest: Types.checkout.PaymentRequest = {\\n  reference: \\&quot;YOUR_ORDER_NUMBER\\&quot;,\\n  amount: amount,\\n  splits: [split1, split2, split3],\\n  merchantAccount: \\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;,\\n  paymentMethod: cardDetails,\\n  additionalData: {\\n    \\&quot;subMerchant.subSeller1.postalCode\\&quot;: \\&quot;POSTAL_CODE\\&quot;,\\n    \\&quot;subMerchant.subSeller1.id\\&quot;: \\&quot;12345\\&quot;,\\n    \\&quot;subMerchant.subSeller1.street\\&quot;: \\&quot;Street Address\\&quot;,\\n    \\&quot;subMerchant.subSeller1.country\\&quot;: \\&quot;COUNTRY\\&quot;,\\n    \\&quot;subMerchant.subSeller1.city\\&quot;: \\&quot;CITY\\&quot;,\\n    \\&quot;subMerchant.subSeller1.state\\&quot;: \\&quot;STATE\\&quot;,\\n    \\&quot;subMerchant.numberOfSubSellers\\&quot;: \\&quot;1\\&quot;,\\n    \\&quot;subMerchant.subSeller1.name\\&quot;: \\&quot;Test Merchant\\&quot;\\n  },\\n  returnUrl: \\&quot;https:\\\/\\\/your-company.example.com\\\/...\\&quot;\\n};\\n\\n\\\/\\\/ Make the API call\\nconst checkoutAPI = new CheckoutAPI(client);\\nconst response = checkoutAPI.PaymentsApi.payments(paymentRequest, { idempotencyKey: \\&quot;UUID\\&quot; });&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<p>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.<\/p>\n<h2>Shopper statement<\/h2>\n<p>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 <em>transaction &nbsp;description<\/em>, <em>statement&nbsp;descriptor<\/em>, <em>shopper&nbsp;statement<\/em>, or <em>billing&nbsp;descriptor<\/em>. If shoppers do not recognize a transaction by its description:<\/p>\n<ul>\n<li>There is a higher chance your shopper issues a chargeback.<\/li>\n<li>You can get a fine from the relevant card scheme related to your chargeback rate.<\/li>\n<\/ul>\n<p>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.<\/p>\n<p>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 <code>shopperStatement<\/code> in your payment request. For more information, see <a href=\"\/pt\/account\/transaction-description\">Transaction description<\/a>.<\/p>","url":"https:\/\/docs.adyen.com\/pt\/platforms\/online-payments\/payment-facilitators","articleFields":{"description":"Learn what additional information you must send in your requests if you are a payment facilitator.","feedback_component":true,"type":"page","_expandable":{"operations":""},"status":"current","filters_component":false,"parameters":{"directoryPath":"\/platforms","model":"platform"},"next_steps":[{"title":"Split payments at authorization","description":"Learn how to split a payment at the time of authorization.","url":"\/platforms\/online-payments\/split-transactions\/split-payments-at-authorization","required":false}],"page_id":"c1fc658d-d687-41de-8096-0f9b228fb3af","decision_tree":"[]"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/platforms\/online-payments\/payment-facilitators","title":"Payment facilitators","content":"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.\nRequirements\n\n\n\nRequirement\nDescription\n\n\n\n\nIntegration type\nYou must have an Adyen online payments integration and a checkout UI.\n\n\nAPI credentials\nYou must have credentials for the  Checkout API.\n\n\n\n\nSend user data points with a transaction\nDuring the  \/sessions or  \/payments authorization for each transaction, card schemes require data points that specify the following information about your user:\n\nUnique identifier: You must assign a unique identifier to each of your users.\nName: You must provide an accurate name for the user that is present on the shopper's statement. For Mastercard, this includes an aggregator prefix.\nLocation: You must provide the user's location as the location of the transaction.\n\nRequired parameters\nYou must send additionalData parameters with the  \/sessions or  \/payments authorization request. For cancellations, captures, and refunds, Adyen automatically populates your user's details from the initial payment.\nSubmit your request using  AdditionalDataSubMerchant parameters.\n\nThe [subSellerNr] is always 1. Submit all additionalData parameters as:\nadditionalData.subMerchant.subSeller1.[parameter]\n\n\n\n\nRequired additional parameters\nDescription\n\n\n\n\n additionalData.subMerchant.numberOfSubSellers\nThe number of users in the transaction. Set this to 1.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].id\nA unique identifier you assigned to your user.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].name\nThe name of your user.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].street\nThe street name and house number of your user's address.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].postalCode\nThe postal code of your user's address, without dashes. Required only in Canada and the United States.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].city\nThe city of your user's address.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].state\nThe state code of your user's address, if applicable.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].country\nThe three-letter ISO country code of your user's address.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].email\nThe email address of the user.\n\n\n\n\n additionalData.subMerchant.subSeller[subSellerNr].phoneNumber\nThe phone number of the user.\n\n\n\n\nBefore going live, confirm with your Adyen contact that the paymentFacilitatorIds, aggregatorPrefix and amexCapnSubmitterId are configured for your platform.\n\nHere is an example of a split payment request facilitated on behalf of your user:\n\n    \n\nAs 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.\nShopper statement\nWhen 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 &nbsp;description, statement&nbsp;descriptor, shopper&nbsp;statement, or billing&nbsp;descriptor. If shoppers do not recognize a transaction by its description:\n\nThere is a higher chance your shopper issues a chargeback.\nYou can get a fine from the relevant card scheme related to your chargeback rate.\n\nTo 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.\nIf 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.","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Platforms","lvl2":"Process online payments","lvl3":"Payment facilitators"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/platforms","lvl2":"https:\/\/docs.adyen.com\/pt\/platforms\/online-payments","lvl3":"\/pt\/platforms\/online-payments\/payment-facilitators"},"levels":4,"category":"Platforms","category_color":"green","tags":["Payment","facilitators"]},"articleFiles":{"payfac-split-payment-request.js":"<p alt=\"\">payfac-split-payment-request.js<\/p>"}}
