Adyen · JSON Structure

Accounts Store Detail Structure

StoreDetail schema from Adyen API

Type: object Properties: 15 Required: 3
PaymentsFinancial ServicesFintech

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

Properties

address fullPhoneNumber logo merchantAccount merchantCategoryCode merchantHouseNumber phoneNumber shopperInteraction splitConfigurationUUID status store storeName storeReference virtualAccount webAddress

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/accounts-store-detail-structure.json",
  "description": "StoreDetail schema from Adyen API",
  "type": "object",
  "properties": {
    "address": {
      "description": "The address of the physical store where the account holder will process payments from.",
      "$ref": "#/components/schemas/ViasAddress"
    },
    "fullPhoneNumber": {
      "description": "The phone number of the store provided as a single string.  It will be handled as a landline phone.\n\nExamples: \"0031 6 11 22 33 44\", \"+316/1122-3344\", \"(0031) 611223344\"",
      "type": "string"
    },
    "logo": {
      "x-addedInVersion": "5",
      "description": "Store logo for payment method setup.",
      "type": "string"
    },
    "merchantAccount": {
      "description": "The merchant account to which the store belongs.",
      "type": "string"
    },
    "merchantCategoryCode": {
      "description": "The merchant category code (MCC) that classifies the business of the account holder.",
      "type": "string"
    },
    "merchantHouseNumber": {
      "x-addedInVersion": "5",
      "description": "Merchant house number for payment method setup.",
      "type": "string"
    },
    "phoneNumber": {
      "description": "The phone number of the store.",
      "$ref": "#/components/schemas/ViasPhoneNumber"
    },
    "shopperInteraction": {
      "x-addedInVersion": "5",
      "description": "The sales channel. Possible values: **Ecommerce**, **POS**.",
      "enum": [
        "Ecommerce",
        "POS"
      ],
      "type": "string"
    },
    "splitConfigurationUUID": {
      "x-addedInVersion": "5",
      "description": "The unique reference for the split configuration, returned when you configure splits in your Customer Area. When this is provided, the `virtualAccount` is also required. Adyen uses the configuration and the `virtualAccount` to split funds between accounts in your platform.",
      "type": "string"
    },
    "status": {
      "description": "The status of the store. Possible values: **Pending**, **Active**, **Inactive**, **InactiveWithModifications**, **Closed**.",
      "enum": [
        "Active",
        "Closed",
        "Inactive",
        "InactiveWithModifications",
        "Pending"
      ],
      "type": "string"
    },
    "store": {
      "description": "Adyen-generated unique alphanumeric identifier (UUID) for the store, returned in the response when you create a store. Required when updating an existing store in an `/updateAccountHolder` request.",
      "type": "string"
    },
    "storeName": {
      "description": "The name of the account holder's store. This value is shown in shopper statements.\n\n* Length: Between 3 to 22 characters \n\n* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**",
      "type": "string"
    },
    "storeReference": {
      "description": "Your unique identifier for the store. The Customer Area also uses this value for the store description.\n\n * Length: Between 3 to 128 characters\n\n* The following characters are *not* supported: **:;}{$#@!|<>%^*+=\\\\**",
      "type": "string"
    },
    "virtualAccount": {
      "x-addedInVersion": "5",
      "description": "The account holder's `accountCode` where the split amount will be sent. Required when you provide the `splitConfigurationUUID`.",
      "type": "string"
    },
    "webAddress": {
      "x-addedInVersion": "5",
      "description": "URL of the ecommerce store.",
      "type": "string"
    }
  },
  "required": [
    "merchantCategoryCode",
    "address",
    "merchantAccount"
  ],
  "name": "StoreDetail"
}