openapi.json

{
  "swagger": "2.0",
  "info": {
    "contact": {
      "email": "support@adyen.com",
      "name": "Adyen Support",
      "url": "https://support.adyen.com/",
      "x-twitter": "Adyen"
    },
    "description": "A web service containing utility functions available for merchants integrating with Checkout APIs.\n## Authentication\nEach request to the Checkout Utility API must be signed with an API key. For this, obtain an API Key from your Customer Area, as described in [How to get the Checkout API key](https://docs.adyen.com/developers/user-management/how-to-get-the-checkout-api-key). Then set this key to the `X-API-Key` header value, for example:\n\n```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: Your_Checkout_API_key\" \\\n...\n```\nNote that when going live, you need to generate a new API Key to access the [live endpoints](https://docs.adyen.com/developers/api-reference/live-endpoints).\n\n## Versioning\nCheckout API supports versioning of its endpoints through a version suffix in the endpoint URL. This suffix has the following format: \"vXX\", where XX is the version number.\n\nFor example:\n```\nhttps://checkout-test.adyen.com/v1/originKeys\n```",
    "termsOfService": "https://docs.adyen.com/legal/terms-conditions",
    "title": "Adyen Checkout Utility Service",
    "version": "1",
    "x-apisguru-categories": [
      "payment"
    ],
    "x-logo": {
      "url": "https://api.apis.guru/v2/cache/logo/https_twitter.com_Adyen_profile_image.jpeg"
    },
    "x-origin": [
      {
        "converter": {
          "url": "https://github.com/lucybot/api-spec-converter",
          "version": "2.7.11"
        },
        "format": "openapi",
        "url": "https://raw.githubusercontent.com/adyen/adyen-openapi/master/specs/3.0/CheckoutUtilityService-v1.json",
        "version": "3.0"
      }
    ],
    "x-preferred": true,
    "x-providerName": "adyen.com",
    "x-serviceName": "CheckoutUtilityService",
    "x-datafire": {
      "name": "adyen_checkoututilityservice",
      "type": "openapi"
    }
  },
  "host": "checkout-test.adyen.com",
  "basePath": "/v1",
  "schemes": [
    "https"
  ],
  "paths": {
    "/originKeys": {
      "post": {
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "in": "body",
            "name": "body",
            "schema": {
              "$ref": "#/definitions/CheckoutUtilityRequest"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK - the request has succeeded.",
            "schema": {
              "$ref": "#/definitions/CheckoutUtilityResponse"
            }
          },
          "400": {
            "description": "Bad Request - a problem reading or understanding the request."
          },
          "401": {
            "description": "Unauthorized - authentication required."
          },
          "403": {
            "description": "Forbidden - insufficient permissions to process the request."
          },
          "422": {
            "description": "Unprocessable Entity - a request validation error."
          },
          "500": {
            "description": "Internal Server Error - the server could not process the request."
          }
        },
        "description": "This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains.",
        "summary": "Create originKey values for one or more merchant domains.",
        "x-groupName": "General",
        "x-sortIndex": 0
      }
    }
  },
  "definitions": {
    "CheckoutUtilityRequest": {
      "properties": {
        "originDomains": {
          "description": "The list of origin domains, for which origin keys are requested.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "required": [
        "originDomains"
      ]
    },
    "CheckoutUtilityResponse": {
      "properties": {
        "originKeys": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "The list of origin keys for all requested domains. For each list item, the key is the domain and the value is the origin key.",
          "type": "object"
        }
      }
    }
  },
  "x-components": {},
  "x-groups": [
    "General"
  ]
}