Adyen · Schema

BusinessLine

PaymentsFinancial ServicesFintech

Properties

Name Type Description
capability string The capability for which you are creating the business line. Possible values: **receivePayments**, **receiveFromPlatformPayments**, **issueBankAccount**
id string The unique identifier of the business line.
industryCode string A code that represents the [industry of the legal entity](https://docs.adyen.com/marketplaces-and-platforms/verification-requirements/reference-additional-products/#list-industry-codes). For example,
legalEntityId string Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line.
problems array The verification errors related to capabilities for this supporting entity.
salesChannels array A list of channels where goods or services are sold. Possible values: **pos**, **posMoto**, **eCommerce**, **ecomMoto**, **payByLink**. Required only in combination with the `service` **paymentProcess
service string The service for which you are creating the business line. Possible values: * **paymentProcessing** * **banking**
sourceOfFunds object Contains information about the source of your user's funds. Required only for the `service` **banking**.
webData array List of website URLs where your user's goods or services are sold. When this is required for a service but your user does not have an online presence, provide the reason in the `webDataExemption` obje
webDataExemption object The reason why the web data is not provided.
View JSON Schema on GitHub

JSON Schema

adyen-businessline-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/BusinessLine",
  "title": "BusinessLine",
  "properties": {
    "capability": {
      "deprecated": true,
      "x-deprecatedInVersion": "3",
      "x-deprecatedMessage": "Use `service` instead.",
      "description": "The capability for which you are creating the business line.\n\nPossible values: **receivePayments**, **receiveFromPlatformPayments**, **issueBankAccount**",
      "enum": [
        "receivePayments",
        "receiveFromPlatformPayments",
        "issueBankAccount"
      ],
      "type": "string"
    },
    "id": {
      "description": "The unique identifier of the business line.",
      "readOnly": true,
      "type": "string"
    },
    "industryCode": {
      "description": "A code that represents the [industry of the legal entity](https://docs.adyen.com/marketplaces-and-platforms/verification-requirements/reference-additional-products/#list-industry-codes). For example, **4431A** for computer software stores.",
      "type": "string"
    },
    "legalEntityId": {
      "description": "Unique identifier of the [legal entity](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/legalEntities__resParam_id) that owns the business line.",
      "type": "string"
    },
    "problems": {
      "x-addedInVersion": "3",
      "description": "The verification errors related to capabilities for this supporting entity.",
      "items": {
        "$ref": "#/components/schemas/CapabilityProblem"
      },
      "type": "array"
    },
    "salesChannels": {
      "description": "A list of channels where goods or services are sold.\n\nPossible values: **pos**, **posMoto**, **eCommerce**, **ecomMoto**, **payByLink**.\n\nRequired only in combination with the `service` **paymentProcessing**.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "service": {
      "x-addedInVersion": "3",
      "description": "The service for which you are creating the business line.\n\n\n\nPossible values:\n*  **paymentProcessing**\n*  **banking**\n\n",
      "enum": [
        "paymentProcessing",
        "banking"
      ],
      "type": "string"
    },
    "sourceOfFunds": {
      "description": "Contains information about the source of your user's funds. Required only for the `service` **banking**.",
      "$ref": "#/components/schemas/SourceOfFunds"
    },
    "webData": {
      "description": "List of website URLs where your user's goods or services are sold. When this is required for a service but your user does not have an online presence, provide the reason in the `webDataExemption` object.",
      "items": {
        "$ref": "#/components/schemas/WebData"
      },
      "type": "array"
    },
    "webDataExemption": {
      "description": "The reason why the web data is not provided.",
      "$ref": "#/components/schemas/WebDataExemption"
    }
  },
  "required": [
    "service",
    "industryCode",
    "legalEntityId",
    "id"
  ],
  "type": "object"
}