Adyen · Schema

AdditionalDataSubMerchant

AdditionalDataSubMerchant schema from Adyen API

PaymentsFinancial ServicesFintech

Properties

Name Type Description
subMerchant.numberOfSubSellers string Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.
subMerchant.subSeller[subSellerNr].city string Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 13 characters
subMerchant.subSeller[subSellerNr].country string Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. * Format: [ISO 3166-1 alpha-3](htt
subMerchant.subSeller[subSellerNr].id string Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. * Format: Alphanumeric *
subMerchant.subSeller[subSellerNr].mcc string Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). * Format: Numeric * Fixed length: 4 digits
subMerchant.subSeller[subSellerNr].name string Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement that will appear i
subMerchant.subSeller[subSellerNr].postalCode string Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes. * Format: Numeric * Fixed length: 8 digits
subMerchant.subSeller[subSellerNr].state string Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country. * Format: Alphanumeric * Maximum length: 2 character
subMerchant.subSeller[subSellerNr].street string Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address. * Format: Alphanumeric * Maximum length: 60 characters
subMerchant.subSeller[subSellerNr].taxId string Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant. * Format: Numeric * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ
View JSON Schema on GitHub

JSON Schema

checkout-additional-data-sub-merchant-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-schema/checkout-additional-data-sub-merchant-schema.json",
  "title": "AdditionalDataSubMerchant",
  "description": "AdditionalDataSubMerchant schema from Adyen API",
  "type": "object",
  "properties": {
    "subMerchant.numberOfSubSellers": {
      "description": "Required for transactions performed by registered payment facilitators. Indicates the number of sub-merchants contained in the request. For example, **3**.",
      "type": "string"
    },
    "subMerchant.subSeller[subSellerNr].city": {
      "description": "Required for transactions performed by registered payment facilitators. The city of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 13 characters",
      "type": "string"
    },
    "subMerchant.subSeller[subSellerNr].country": {
      "description": "Required for transactions performed by registered payment facilitators. The three-letter country code of the sub-merchant's address. For example, **BRA** for Brazil. \n* Format: [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3)\n* Fixed length: 3 characters",
      "type": "string"
    },
    "subMerchant.subSeller[subSellerNr].id": {
      "description": "Required for transactions performed by registered payment facilitators. A unique identifier that you create for the sub-merchant, used by schemes to identify the sub-merchant. \n* Format: Alphanumeric\n* Maximum length: 15 characters",
      "type": "string"
    },
    "subMerchant.subSeller[subSellerNr].mcc": {
      "description": "Required for transactions performed by registered payment facilitators. The sub-merchant's 4-digit Merchant Category Code (MCC). \n* Format: Numeric\n* Fixed length: 4 digits",
      "type": "string"
    },
    "subMerchant.subSeller[subSellerNr].name": {
      "description": "Required for transactions performed by registered payment facilitators. The name of the sub-merchant. Based on scheme specifications, this value will overwrite the shopper statement  that will appear in the card statement.\n* Format: Alphanumeric\n* Maximum length: 22 characters",
      "type": "string"
    },
    "subMerchant.subSeller[subSellerNr].postalCode": {
      "description": "Required for transactions performed by registered payment facilitators. The postal code of the sub-merchant's address, without dashes.\n* Format: Numeric\n* Fixed length: 8 digits",
      "type": "string"
    },
    "subMerchant.subSeller[subSellerNr].state": {
      "description": "Required for transactions performed by registered payment facilitators. The state code of the sub-merchant's address, if applicable to the country.\n* Format: Alphanumeric\n* Maximum length: 2 characters",
      "type": "string"
    },
    "subMerchant.subSeller[subSellerNr].street": {
      "description": "Required for transactions performed by registered payment facilitators. The street name and house number of the sub-merchant's address.\n* Format: Alphanumeric\n* Maximum length: 60 characters",
      "type": "string"
    },
    "subMerchant.subSeller[subSellerNr].taxId": {
      "description": "Required for transactions performed by registered payment facilitators. The tax ID of the sub-merchant.\n* Format: Numeric\n* Fixed length: 11 digits for the CPF or 14 digits for the CNPJ",
      "type": "string"
    }
  }
}