Adyen · JSON Structure

Management Company Api Credential Structure

CompanyApiCredential schema from Adyen API

Type: object Properties: 10 Required: 6

PaymentsFinancial ServicesFintech

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

Properties

_links active allowedIpAddresses allowedOrigins associatedMerchantAccounts clientKey description id roles username

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adyen/refs/heads/main/json-structure/management-company-api-credential-structure.json",
  "description": "CompanyApiCredential schema from Adyen API",
  "type": "object",
  "properties": {
    "_links": {
      "description": "References to resources linked to the API credential.",
      "$ref": "#/components/schemas/ApiCredentialLinks"
    },
    "active": {
      "description": "Indicates if the API credential is enabled. Must be set to **true** to use the credential in your integration.",
      "type": "boolean"
    },
    "allowedIpAddresses": {
      "description": "List of IP addresses from which your client can make requests.\n\nIf the list is empty, we allow requests from any IP.\nIf the list is not empty and we get a request from an IP which is not on the list, you get a security error.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "allowedOrigins": {
      "description": "List containing the [allowed origins](https://docs.adyen.com/development-resources/client-side-authentication#allowed-origins) linked to the API credential.",
      "items": {
        "$ref": "#/components/schemas/AllowedOrigin"
      },
      "type": "array"
    },
    "associatedMerchantAccounts": {
      "description": "List of merchant accounts that the API credential has explicit access to. \n If the credential has access to a company, this implies access to all merchant accounts and no merchants for that company will be included.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "clientKey": {
      "description": "Public key used for [client-side authentication](https://docs.adyen.com/development-resources/client-side-authentication). The client key is required for Drop-in and Components integrations.",
      "type": "string"
    },
    "description": {
      "description": "Description of the API credential.",
      "maxLength": 50,
      "type": "string"
    },
    "id": {
      "description": "Unique identifier 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.",
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "username": {
      "description": "The name of the [API credential](https://docs.adyen.com/development-resources/api-credentials), for example **ws@Company.TestCompany**.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "username",
    "clientKey",
    "allowedIpAddresses",
    "roles",
    "active"
  ],
  "name": "CompanyApiCredential"
}