{"title":"Card scheme requirements for payment facilitators","category":"default","creationDate":1683539700,"content":"<div class=\"additional-info-block output-inline\">\n<h5 class=\"article__heading additional-info-block__title\">Adyen for Platforms<\/h5><div class=\"additional-info-block__body\"><p>If you are already registered as a payment facilitator and you are using our <a href=\"https:\/\/www.adyen.com\/platform-payments\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Adyen for Platforms<\/a> solution, refer to the <a href=\"\/pt\/platforms\/online-payments\/payment-facilitators\">Platforms documentation for payment facilitators<\/a>.<\/p><\/div><\/div>\n\n<p>If you are a <a href=\"\/pt\/get-started-with-adyen\/adyen-glossary#payment-facilitator\" target=\"_blank\">payment facilitator<\/a> that processes card transactions for sub-merchants, Visa, Mastercard, and American Express require you to send certain data points with each transaction. These data points must refer to the sub-merchant, who is considered the Merchant of Record when a transaction is passed through a payment facilitator.<\/p>\n<h2>Send sub-merchant data points with a transaction<\/h2>\n<p>During the  <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, Visa, Mastercard, and American Express require data points that specify the following information about the sub-merchant:<\/p>\n<ul>\n<li><strong>Unique identifier<\/strong>: You must assign a unique identifier to each of your sub-merchants.<\/li>\n<li><strong>Name<\/strong>: You must provide an accurate name for the sub-merchant that is present on the shopper's statement. For Mastercard and American Express this includes an aggregator prefix.<br \/>\nContact the <a href=\"https:\/\/ca-test.adyen.com\/ca\/ca\/contactUs\/support.shtml?form=other\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">Support Team<\/a> to get an aggregator prefix.<\/li>\n<li><strong>Location<\/strong>: You must provide the sub-merchant'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\/payments\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">\/payments<\/a> authorization. For cancellations, captures, and refunds, Adyen automatically populates sub-merchant 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. See the  <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">API documentation<\/a> to view specific formatting requirements for each parameter.<\/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 style=\"text-align: left;\">Required parameter<\/th>\n<th style=\"text-align: left;\">Description<\/th>\n<\/tr>\n<\/thead>\n<tbody>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">The number of sub-merchants in the transaction. For Payment Facilitators not using <a href=\"https:\/\/www.adyen.com\/platform-payments\/\" target=\"_blank\" rel=\"nofollow noopener noreferrer\" class=\"external-link no-image\">AfP<\/a>, this value must be <strong>1<\/strong>.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">A unique identifier assigned by the payment facilitator.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-taxId\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].taxId<\/a><\/td>\n<td style=\"text-align: left;\">The tax ID of the sub-merchant: an 11-digit CPF or 14-digit CNPJ. Required only in Brazil.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments#request-additionalData-AdditionalDataSubMerchant-subMerchant-subSeller_subSellerNr_-mcc\" class=\"codeLabel  external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">additionalData.subMerchant.subSeller[subSellerNr].mcc<\/a><\/td>\n<td style=\"text-align: left;\">The sub-merchant's 4-digit Merchant Category Code (MCC). Required only in Brazil.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">The name of the sub-merchant.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">The street name and house number of the sub-merchant's address.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">The postal code of the sub-merchant's address, without dashes. Required only in Brazil, Canada, the United States, and for domestic in-person payments in Ireland.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">The city of the sub-merchant's address.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">The state code of the sub-merchant's address, if applicable to the country\/region.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">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 the sub-merchant's address.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">The email address of the sub-merchant.<\/td>\n<\/tr>\n<tr>\n<td style=\"text-align: left;\"> <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 style=\"text-align: left;\">The phone number of the sub-merchant.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n<h3>Automatically collected parameters<\/h3>\n<p>Your API request contains two additional data points that are automatically collected from your account properties. Do not send these data points manually. The two data points are:<\/p>\n<ul>\n<li><strong><code>paymentFacilitatorIds<\/code><\/strong>: Your payment facilitator ID. Both Visa and Mastercard create an ID for you.<br \/>\nFor example: <code>AdyenVisa_US_WF_400224: '12345'<\/code><\/li>\n<li><strong><code>amexCapnSubmitterId<\/code><\/strong>: American Express will provide a unique ID to you in order to use Adyen as gateway.<\/li>\n<li><strong><code>aggregatorPrefix<\/code><\/strong>: Your 25-character aggregator prefix.<br \/>\nFor example: <code>PayfacName*SubmerchantName.<\/code><\/li>\n<\/ul>\n<h3>Sample request<\/h3>\n<div data-component-wrapper=\"code-sample\">\n    <code-sample :title=\"'Sample API request for a sub-merchant transaction'\" :id=\"''\" :code-data=\"[{&quot;language&quot;:&quot;json&quot;,&quot;tabTitle&quot;:&quot;&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-d '{\\n    \\&quot;merchantAccount\\&quot;:\\&quot;YOUR_MERCHANT_ACCOUNT\\&quot;,\\n    \\&quot;amount\\&quot;: {\\n        \\&quot;currency\\&quot;:\\&quot;EUR\\&quot;,\\n        \\&quot;value\\&quot;:10000\\n    },\\n    \\&quot;reference\\&quot;:\\&quot;YOUR_UNIQUE_REFERENCE\\&quot;,\\n    \\&quot;paymentMethod\\&quot; : {\\n        \\&quot;number\\&quot; : \\&quot;CARD_NUMBER\\&quot;,\\n        \\&quot;expiryMonth\\&quot; : \\&quot;EXPIRY_MONTH\\&quot;,\\n        \\&quot;expiryYear\\&quot; : \\&quot;EXPIRY_YEAR\\&quot;,\\n        \\&quot;cvc\\&quot; : \\&quot;CVC\\&quot;,\\n        \\&quot;holderName\\&quot; : \\&quot;HOLDER_NAME\\&quot;,\\n        \\&quot;type\\&quot; : \\&quot;scheme\\&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        \\&quot;subMerchant.subSeller1.email\\&quot;: \\&quot;EMAIL\\&quot;,\\n        \\&quot;subMerchant.subSeller1.phoneNumber\\&quot;: \\&quot;PHONE_NUMBER\\&quot;\\n    }\\n}'&quot;}]\" :enable-copy-link-to-code-block=\"true\" :code-sample-card-size=\"'fullsize'\"><\/code-sample>\n<\/div>\n<h2>See also<\/h2>\n<ul>\n<li><a href=\"\/pt\/get-started-with-adyen\/adyen-glossary\/\" target=\"_blank\">Adyen glossary<\/a><\/li>\n<li>\n <a href=\"https:\/\/docs.adyen.com\/api-explorer\/Checkout\/latest\/post\/payments\" class=\" external-link no-image\" target=\"_blank\" rel=\"nofollow noopener noreferrer\">API documentation<\/a>\n<\/li>\n<\/ul>","url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/cards\/payment-facilitators","articleFields":{"description":"Send sub-merchant transactions to Adyen to comply with Visa and Mastercard requirements","feedback_component":true,"filters_component":false,"last_edit_on":"29-01-2024 12:36","decision_tree":"[]","page_id":"a327aab5-da95-4204-98b8-491c0d190a92"},"algolia":{"url":"https:\/\/docs.adyen.com\/pt\/payment-methods\/cards\/payment-facilitators","title":"Card scheme requirements for payment facilitators","content":"\nAdyen for PlatformsIf you are already registered as a payment facilitator and you are using our Adyen for Platforms solution, refer to the Platforms documentation for payment facilitators.\n\nIf you are a payment facilitator that processes card transactions for sub-merchants, Visa, Mastercard, and American Express require you to send certain data points with each transaction. These data points must refer to the sub-merchant, who is considered the Merchant of Record when a transaction is passed through a payment facilitator.\nSend sub-merchant data points with a transaction\nDuring the  \/payments authorization for each transaction, Visa, Mastercard, and American Express require data points that specify the following information about the sub-merchant:\n\nUnique identifier: You must assign a unique identifier to each of your sub-merchants.\nName: You must provide an accurate name for the sub-merchant that is present on the shopper's statement. For Mastercard and American Express this includes an aggregator prefix.\nContact the Support Team to get an aggregator prefix.\nLocation: You must provide the sub-merchant's location as the location of the transaction.\n\nRequired parameters\nYou must send additionalData parameters with the  \/payments authorization. For cancellations, captures, and refunds, Adyen automatically populates sub-merchant details from the initial payment.\nSubmit your request using  AdditionalDataSubMerchant parameters. See the  API documentation to view specific formatting requirements for each parameter.\n\nThe [subSellerNr] is always 1. Submit all additionalData parameters as:\nadditionalData.subMerchant.subSeller1.[parameter]\n\n\n\n\nRequired parameter\nDescription\n\n\n\n\n additionalData.subMerchant.numberOfSubSellers\nThe number of sub-merchants in the transaction. For Payment Facilitators not using AfP, this value must be 1.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].id\nA unique identifier assigned by the payment facilitator.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].taxId\nThe tax ID of the sub-merchant: an 11-digit CPF or 14-digit CNPJ. Required only in Brazil.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].mcc\nThe sub-merchant's 4-digit Merchant Category Code (MCC). Required only in Brazil.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].name\nThe name of the sub-merchant.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].street\nThe street name and house number of the sub-merchant's address.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].postalCode\nThe postal code of the sub-merchant's address, without dashes. Required only in Brazil, Canada, the United States, and for domestic in-person payments in Ireland.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].city\nThe city of the sub-merchant's address.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].state\nThe state code of the sub-merchant's address, if applicable to the country\/region.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].country\nThe three-letter ISO country code of the sub-merchant's address.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].email\nThe email address of the sub-merchant.\n\n\n additionalData.subMerchant.subSeller[subSellerNr].phoneNumber\nThe phone number of the sub-merchant.\n\n\n\nAutomatically collected parameters\nYour API request contains two additional data points that are automatically collected from your account properties. Do not send these data points manually. The two data points are:\n\npaymentFacilitatorIds: Your payment facilitator ID. Both Visa and Mastercard create an ID for you.\nFor example: AdyenVisa_US_WF_400224: '12345'\namexCapnSubmitterId: American Express will provide a unique ID to you in order to use Adyen as gateway.\naggregatorPrefix: Your 25-character aggregator prefix.\nFor example: PayfacName*SubmerchantName.\n\nSample request\n\n    \n\nSee also\n\nAdyen glossary\n\n API documentation\n\n","type":"page","locale":"pt","boost":17,"hierarchy":{"lvl0":"Home","lvl1":"Payment methods","lvl2":"Cards","lvl3":"Card scheme requirements for payment facilitators"},"hierarchy_url":{"lvl0":"https:\/\/docs.adyen.com\/pt","lvl1":"https:\/\/docs.adyen.com\/pt\/payment-methods","lvl2":"https:\/\/docs.adyen.com\/pt\/payment-methods\/cards","lvl3":"\/pt\/payment-methods\/cards\/payment-facilitators"},"levels":4,"category":"Payment method","category_color":"green","tags":["scheme","requirements","payment","facilitators"]}}
