Adyen · JSON Structure

Payments Additional Data Sub Merchant Structure

AdditionalDataSubMerchant schema from Adyen API

Type: object Properties: 10
PaymentsFinancial ServicesFintech

AdditionalDataSubMerchant is a JSON Structure definition published by Adyen, describing 10 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

subMerchant.numberOfSubSellers subMerchant.subSeller[subSellerNr].city subMerchant.subSeller[subSellerNr].country subMerchant.subSeller[subSellerNr].id subMerchant.subSeller[subSellerNr].mcc subMerchant.subSeller[subSellerNr].name subMerchant.subSeller[subSellerNr].postalCode subMerchant.subSeller[subSellerNr].state subMerchant.subSeller[subSellerNr].street subMerchant.subSeller[subSellerNr].taxId

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/payments-additional-data-sub-merchant-structure.json",
  "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"
    }
  },
  "name": "AdditionalDataSubMerchant"
}