Adyen · Schema

UpdateStoreRequest

PaymentsFinancial ServicesFintech

Properties

Name	Type	Description
address	object	The address of the store. It is not possible to update the country of the store.
businessLineIds	array	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.
description	string	The description of the store.
externalReferenceId	string	The unique identifier of the store, used by certain payment methods and tax authorities. Accepts up to 14 digits. Required for CNPJ in Brazil, in the format 00.000.000/00git00-00 separated by dots, sl
phoneNumber	string	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 agai
splitConfiguration	object	Rules for Adyen for Platforms merchants to split the transaction amount and fees.
status	string	The status of the store. Possible values are: - active: This value is assigned automatically when a store is created. - inactive: The maximum [transaction limits and number of Store-and-Forwar

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateStoreRequest",
  "title": "UpdateStoreRequest",
  "properties": {
    "address": {
      "description": "The address of the store. It is not possible to update the country of the store.",
      "$ref": "#/components/schemas/UpdatableAddress"
    },
    "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.",
      "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"
    },
    "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"
    },
    "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 maximum [transaction limits and number of Store-and-Forward transactions](https://docs.adyen.com/point-of-sale/determine-account-structure/configure-features#payment-features) for the store are set to 0. This blocks new transactions, but captures are still possible.\n- **closed**: The terminals of the store are reassigned to the merchant inventory, so they can't process payments.\n\nYou can change the status from **active** to **inactive**, and from **inactive** to **active** or **closed**. \nOnce **closed**, a store can't be reopened.",
      "enum": [
        "active",
        "closed",
        "inactive"
      ],
      "type": "string"
    }
  },
  "type": "object"
}