Adyen · JSON Structure

Management Store Structure

Store schema from Adyen API

Type: object Properties: 12
PaymentsFinancial ServicesFintech

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

Properties

_links address businessLineIds description externalReferenceId id merchantId phoneNumber reference shopperStatement splitConfiguration status

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-store-structure.json",
  "description": "Store schema from Adyen API",
  "type": "object",
  "properties": {
    "_links": {
      "description": "Reference to resources connected with the store.",
      "$ref": "#/components/schemas/Links"
    },
    "address": {
      "description": "The address of the store.",
      "$ref": "#/components/schemas/StoreLocation"
    },
    "businessLineIds": {
      "description": "The unique identifiers of the [business lines](https://docs.adyen.com/api-explorer/#/legalentity/latest/post/businesslines__resParam_id) that the store is associated with.\n If not specified, the business line of the merchant account is used. Required when there are multiple business lines under the merchant account.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "description": {
      "description": "The description of the store.",
      "type": "string"
    },
    "externalReferenceId": {
      "description": "The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits.\n\nRequired for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, slashes, hyphens, or without separators.\n\nOptional for Zip in Australia and SIRET in France, required except for nonprofit organizations and incorporated associations.\n\n",
      "type": "string"
    },
    "id": {
      "description": "The unique identifier of the store. This value is generated by Adyen.",
      "type": "string"
    },
    "merchantId": {
      "description": "The unique identifier of the merchant account that the store belongs to.",
      "type": "string"
    },
    "phoneNumber": {
      "description": "The phone number of the store, including '+' and country code in the [E.164](https://en.wikipedia.org/wiki/E.164) format. If passed in a different format, we convert and validate the phone number against E.164. ",
      "type": "string"
    },
    "reference": {
      "description": "A reference to recognize the store by. Also known as the store code.\n Allowed characters: lowercase and uppercase letters without diacritics, numbers 0 through 9, hyphen (-), and underscore (_)",
      "type": "string"
    },
    "shopperStatement": {
      "description": "The store name shown on the shopper's bank or credit card statement and on the shopper receipt.",
      "type": "string"
    },
    "splitConfiguration": {
      "description": "Rules for Adyen for Platforms merchants to split the transaction amount and fees.",
      "$ref": "#/components/schemas/StoreSplitConfiguration"
    },
    "status": {
      "description": "The status of the store. Possible values are:\n\n- **active**. This value is assigned automatically when a store is created. \n- **inactive**. The terminals under the store are blocked from accepting new transactions, but capturing outstanding transactions is still possible.\n- **closed**. This status is irreversible. The terminals under the store are reassigned to the merchant inventory.",
      "enum": [
        "active",
        "closed",
        "inactive"
      ],
      "type": "string"
    }
  },
  "name": "Store"
}