Adyen · JSON Structure

Management Create Merchant Request Structure

CreateMerchantRequest schema from Adyen API

Type: object Properties: 7 Required: 1
PaymentsFinancial ServicesFintech

CreateMerchantRequest is a JSON Structure definition published by Adyen, describing 7 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

businessLineId companyId description legalEntityId pricingPlan reference salesChannels

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/management-create-merchant-request-structure.json",
  "description": "CreateMerchantRequest schema from Adyen API",
  "type": "object",
  "properties": {
    "businessLineId": {
      "description": "The unique identifier of the [business line](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businessLines). Required for an Adyen for Platforms Manage integration.",
      "type": "string"
    },
    "companyId": {
      "description": "The unique identifier of the company account.",
      "type": "string"
    },
    "description": {
      "description": "Your description for the merchant account, maximum 300 characters.",
      "maxLength": 300,
      "type": "string"
    },
    "legalEntityId": {
      "description": "The unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities). Required for an Adyen for Platforms Manage integration.",
      "type": "string"
    },
    "pricingPlan": {
      "description": "Sets the pricing plan for the merchant account. Required for an Adyen for Platforms Manage integration. Your Adyen contact will provide the values that you can use.",
      "type": "string"
    },
    "reference": {
      "description": "Your reference for the merchant account. To make this reference the unique identifier of the merchant account, your Adyen contact can set up a template on your company account. The template can have 6 to 255 characters with upper- and lower-case letters, underscores, and numbers. When your company account has a template, then the `reference` is required and must be unique within the company account.",
      "type": "string"
    },
    "salesChannels": {
      "description": "List of sales channels that the merchant will process payments with",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "companyId"
  ],
  "name": "CreateMerchantRequest"
}