Adyen · Schema

UpdateMerchantApiCredentialRequest

PaymentsFinancial ServicesFintech

Properties

Name Type Description
active boolean Indicates if the API credential is enabled.
allowedOrigins array The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential.
description string Description of the API credential.
roles array List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.' can be assigned to other API credentials
View JSON Schema on GitHub

JSON Schema

adyen-updatemerchantapicredentialrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateMerchantApiCredentialRequest",
  "title": "UpdateMerchantApiCredentialRequest",
  "properties": {
    "active": {
      "description": "Indicates if the API credential is enabled.",
      "type": "boolean"
    },
    "allowedOrigins": {
      "description": "The new list of [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) for the API credential.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "description": {
      "description": "Description of the API credential.",
      "type": "string"
    },
    "roles": {
      "description": "List of [roles](https://docs.adyen.com/development-resources/api-credentials#roles-1) for the API credential. Only roles assigned to 'ws@Company.<CompanyName>' can be assigned to other API credentials.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "type": "object"
}