From 958d5afa6d451b7d83e09e1a5e03d39cbfaeacf1 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Tue, 27 Sep 2022 09:11:42 +0000 Subject: [PATCH] spec release --- json/BinLookupService-v40.json | 4 +- json/BinLookupService-v50.json | 6 +- json/BinLookupService-v52.json | 6 +- json/CheckoutService-v37.json | 4 +- json/CheckoutService-v40.json | 4 +- json/CheckoutService-v41.json | 4 +- json/CheckoutService-v46.json | 4 +- json/CheckoutService-v49.json | 4 +- json/CheckoutService-v50.json | 4 +- json/CheckoutService-v51.json | 4 +- json/CheckoutService-v52.json | 4 +- json/CheckoutService-v53.json | 4 +- json/CheckoutService-v64.json | 4 +- json/CheckoutService-v65.json | 4 +- json/CheckoutService-v66.json | 4 +- json/CheckoutService-v67.json | 4 +- json/CheckoutService-v68.json | 4 +- json/CheckoutService-v69.json | 4 +- json/PaymentService-v25.json | 19 +- json/PaymentService-v30.json | 19 +- json/PaymentService-v40.json | 39 ++-- json/PaymentService-v46.json | 41 +++-- json/PaymentService-v49.json | 41 +++-- json/PaymentService-v50.json | 41 +++-- json/PaymentService-v51.json | 41 +++-- json/PaymentService-v52.json | 41 +++-- json/PaymentService-v64.json | 121 +++---------- json/PaymentService-v67.json | 121 +++---------- json/PaymentService-v68.json | 121 +++---------- json/RecurringService-v25.json | 4 +- json/RecurringService-v30.json | 4 +- json/RecurringService-v40.json | 197 +------------------- json/RecurringService-v49.json | 197 +------------------- json/RecurringService-v67.json | 319 +-------------------------------- json/RecurringService-v68.json | 319 +-------------------------------- yaml/BinLookupService-v40.yaml | 21 +-- yaml/BinLookupService-v50.yaml | 27 +-- yaml/BinLookupService-v52.yaml | 27 +-- yaml/CheckoutService-v37.yaml | 42 ++--- yaml/CheckoutService-v40.yaml | 42 ++--- yaml/CheckoutService-v41.yaml | 42 ++--- yaml/CheckoutService-v46.yaml | 42 ++--- yaml/CheckoutService-v49.yaml | 42 ++--- yaml/CheckoutService-v50.yaml | 42 ++--- yaml/CheckoutService-v51.yaml | 42 ++--- yaml/CheckoutService-v52.yaml | 42 ++--- yaml/CheckoutService-v53.yaml | 42 ++--- yaml/CheckoutService-v64.yaml | 42 ++--- yaml/CheckoutService-v65.yaml | 42 ++--- yaml/CheckoutService-v66.yaml | 42 ++--- yaml/CheckoutService-v67.yaml | 42 ++--- yaml/CheckoutService-v68.yaml | 42 ++--- yaml/CheckoutService-v69.yaml | 42 ++--- yaml/PaymentService-v25.yaml | 107 ++++++++--- yaml/PaymentService-v30.yaml | 107 ++++++++--- yaml/PaymentService-v40.yaml | 133 +++++++++----- yaml/PaymentService-v46.yaml | 139 +++++++++----- yaml/PaymentService-v49.yaml | 139 +++++++++----- yaml/PaymentService-v50.yaml | 139 +++++++++----- yaml/PaymentService-v51.yaml | 139 +++++++++----- yaml/PaymentService-v52.yaml | 139 +++++++++----- yaml/PaymentService-v64.yaml | 212 ++++++++++------------ yaml/PaymentService-v67.yaml | 212 ++++++++++------------ yaml/PaymentService-v68.yaml | 212 ++++++++++------------ yaml/RecurringService-v25.yaml | 65 ++++--- yaml/RecurringService-v30.yaml | 65 ++++--- yaml/RecurringService-v40.yaml | 200 +++++---------------- yaml/RecurringService-v49.yaml | 200 +++++---------------- yaml/RecurringService-v67.yaml | 276 +++++----------------------- yaml/RecurringService-v68.yaml | 276 +++++----------------------- 70 files changed, 1736 insertions(+), 3490 deletions(-) diff --git a/json/BinLookupService-v40.json b/json/BinLookupService-v40.json index 01967f6..5c70546 100644 --- a/json/BinLookupService-v40.json +++ b/json/BinLookupService-v40.json @@ -9,8 +9,8 @@ "version" : "40", "x-publicVersion" : true, "title" : "Adyen BinLookup API", - "description" : "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nThe BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/BinLookup/v40/get3dsAvailability\n```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v40/get3dsAvailability\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-23T11:29:18Z", + "description" : "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.", + "x-timestamp" : "2022-07-19T19:18:37Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/BinLookupService-v50.json b/json/BinLookupService-v50.json index 4c5fc32..e11f537 100644 --- a/json/BinLookupService-v50.json +++ b/json/BinLookupService-v50.json @@ -9,8 +9,8 @@ "version" : "50", "x-publicVersion" : true, "title" : "Adyen BinLookup API", - "description" : "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nThe BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/BinLookup/v50/get3dsAvailability\n```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v50/get3dsAvailability\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-23T11:29:18Z", + "description" : "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -515,7 +515,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/BinLookupService-v52.json b/json/BinLookupService-v52.json index 88056d7..9e51c07 100644 --- a/json/BinLookupService-v52.json +++ b/json/BinLookupService-v52.json @@ -9,8 +9,8 @@ "version" : "52", "x-publicVersion" : true, "title" : "Adyen BinLookup API", - "description" : "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nThe BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/BinLookup/v52/get3dsAvailability\n```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v52/get3dsAvailability\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-23T11:29:19Z", + "description" : "The BIN Lookup API provides endpoints for retrieving information, such as cost estimates, and 3D Secure supported version based on a given BIN.", + "x-timestamp" : "2022-07-19T19:18:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -520,7 +520,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json index ef230bf..bd13f8d 100644 --- a/json/CheckoutService-v37.json +++ b/json/CheckoutService-v37.json @@ -9,8 +9,8 @@ "version" : "37", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v37/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v37/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=37) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:04Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v37/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=37) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:41Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json index 9385b4f..c64fd9d 100644 --- a/json/CheckoutService-v40.json +++ b/json/CheckoutService-v40.json @@ -9,8 +9,8 @@ "version" : "40", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v40/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v40/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=40) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:06Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v40/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=40) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:45Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json index bb70b39..34d40d8 100644 --- a/json/CheckoutService-v41.json +++ b/json/CheckoutService-v41.json @@ -9,8 +9,8 @@ "version" : "41", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v41/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v41/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=41) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:06Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v41/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=41) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:45Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json index 399f754..2524260 100644 --- a/json/CheckoutService-v46.json +++ b/json/CheckoutService-v46.json @@ -9,8 +9,8 @@ "version" : "46", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v46/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v46/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=46) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:07Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v46/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=46) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:46Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json index 74af3ed..b57924f 100644 --- a/json/CheckoutService-v49.json +++ b/json/CheckoutService-v49.json @@ -9,8 +9,8 @@ "version" : "49", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v49/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v49/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=49) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:07Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v49/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=49) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:47Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json index 43833d3..5939f96 100644 --- a/json/CheckoutService-v50.json +++ b/json/CheckoutService-v50.json @@ -9,8 +9,8 @@ "version" : "50", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v50/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v50/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=50) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:08Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v50/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=50) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:48Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json index d421075..f0bf5cf 100644 --- a/json/CheckoutService-v51.json +++ b/json/CheckoutService-v51.json @@ -9,8 +9,8 @@ "version" : "51", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v51/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v51/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=51) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:08Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v51/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=51) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:48Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json index fe48b16..ac1cd71 100644 --- a/json/CheckoutService-v52.json +++ b/json/CheckoutService-v52.json @@ -9,8 +9,8 @@ "version" : "52", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v52/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v52/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=52) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:09Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v52/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=52) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:51Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json index 3b426df..1d2eb9c 100644 --- a/json/CheckoutService-v53.json +++ b/json/CheckoutService-v53.json @@ -9,8 +9,8 @@ "version" : "53", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v53/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v53/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=53) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:09Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v53/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=53) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:52Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json index 9ad9a82..d28c07a 100644 --- a/json/CheckoutService-v64.json +++ b/json/CheckoutService-v64.json @@ -9,8 +9,8 @@ "version" : "64", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v64/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v64/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=64) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:09Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v64/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=64) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:54Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json index 117c5fc..ec93700 100644 --- a/json/CheckoutService-v65.json +++ b/json/CheckoutService-v65.json @@ -9,8 +9,8 @@ "version" : "65", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v65/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v65/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=65) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:10Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v65/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=65) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:55Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json index 30e850f..647891c 100644 --- a/json/CheckoutService-v66.json +++ b/json/CheckoutService-v66.json @@ -9,8 +9,8 @@ "version" : "66", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v66/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v66/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=66) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:10Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v66/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=66) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:55Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json index f4368c4..9517d2b 100644 --- a/json/CheckoutService-v67.json +++ b/json/CheckoutService-v67.json @@ -9,8 +9,8 @@ "version" : "67", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v67/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v67/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=67) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:10Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v67/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=67) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:55Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v68.json b/json/CheckoutService-v68.json index d8140f9..db9d3ea 100644 --- a/json/CheckoutService-v68.json +++ b/json/CheckoutService-v68.json @@ -9,8 +9,8 @@ "version" : "68", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v68/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v68/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=68) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:11Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v68/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=68) to find out what changed in this version!", + "x-timestamp" : "2022-09-14T16:34:58Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/CheckoutService-v69.json b/json/CheckoutService-v69.json index 5f1a00f..2090337 100644 --- a/json/CheckoutService-v69.json +++ b/json/CheckoutService-v69.json @@ -9,8 +9,8 @@ "version" : "69", "x-publicVersion" : true, "title" : "Adyen Checkout API", - "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to Checkout API must be signed with an API key. For this, [get your API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) from your Customer Area, and 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_API_KEY\" \\\n...\n```\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v69/payments\n```\n\n## Going live\n\nTo access the live endpoints, you need an API key from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account, for example:\n```\nhttps://{PREFIX}-checkout-live.adyenpayments.com/v69/payments\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.\n\nWhen preparing to do live transactions with Checkout API, follow the [go-live checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure you've got all the required configuration in place.\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=69) to find out what changed in this version!", - "x-timestamp" : "2022-09-21T17:23:11Z", + "description" : "Adyen Checkout API provides a simple and flexible way to initiate and authorise online payments. You can use the same integration for payments made with cards (including 3D Secure), mobile wallets, and local payment methods (for example, iDEAL and Sofort).\n\nThis API reference provides information on available endpoints and how to interact with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments).\n\n## Authentication\nEach request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-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/development-resources/live-endpoints).\n\n## Versioning\nCheckout API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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/v69/payments\n```\n\n## Release notes\nHave a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=69) to find out what changed in this version!", + "x-timestamp" : "2022-09-21T10:23:20Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index f969adc..cd4cea1 100644 --- a/json/PaymentService-v25.json +++ b/json/PaymentService-v25.json @@ -9,8 +9,8 @@ "version" : "25", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v25/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v25/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v25/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:37Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -393,7 +393,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2644,7 +2644,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -2880,7 +2880,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -3331,7 +3331,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index 12ddeb1..5375335 100644 --- a/json/PaymentService-v30.json +++ b/json/PaymentService-v30.json @@ -9,8 +9,8 @@ "version" : "30", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v30/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v30/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v30/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:37Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -510,7 +510,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -3002,7 +3002,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -3248,7 +3248,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -3704,7 +3704,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index 9d40eab..b7b5b2a 100644 --- a/json/PaymentService-v40.json +++ b/json/PaymentService-v40.json @@ -9,8 +9,8 @@ "version" : "40", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v40/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v40/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v40/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:37Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -627,7 +627,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2564,7 +2564,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -2912,7 +2912,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3016,7 +3016,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3736,7 +3736,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3744,7 +3744,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4015,7 +4015,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4023,7 +4023,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4286,7 +4286,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4294,7 +4294,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4547,7 +4547,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4787,7 +4787,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { @@ -5207,7 +5214,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5509,7 +5516,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index 3294768..4178829 100644 --- a/json/PaymentService-v46.json +++ b/json/PaymentService-v46.json @@ -9,8 +9,8 @@ "version" : "46", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v46/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v46/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v46/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -627,7 +627,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2569,7 +2569,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -2927,7 +2927,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3036,7 +3036,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3756,7 +3756,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3764,7 +3764,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4035,7 +4035,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4043,7 +4043,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4306,7 +4306,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4314,7 +4314,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4572,7 +4572,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4812,7 +4812,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { @@ -5064,7 +5071,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -5245,7 +5252,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5552,7 +5559,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index 7e168bc..3a9763b 100644 --- a/json/PaymentService-v49.json +++ b/json/PaymentService-v49.json @@ -9,8 +9,8 @@ "version" : "49", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v49/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v49/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v49/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -627,7 +627,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2569,7 +2569,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -2927,7 +2927,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3036,7 +3036,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3756,7 +3756,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3764,7 +3764,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4035,7 +4035,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4043,7 +4043,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4306,7 +4306,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4314,7 +4314,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4572,7 +4572,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4812,7 +4812,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { @@ -5064,7 +5071,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -5245,7 +5252,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5587,7 +5594,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index 5315c8a..fcf85b4 100644 --- a/json/PaymentService-v50.json +++ b/json/PaymentService-v50.json @@ -9,8 +9,8 @@ "version" : "50", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v50/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v50/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v50/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -627,7 +627,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2579,7 +2579,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -2937,7 +2937,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3046,7 +3046,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3766,7 +3766,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3774,7 +3774,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4051,7 +4051,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4059,7 +4059,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4328,7 +4328,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4336,7 +4336,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4600,7 +4600,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4840,7 +4840,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { @@ -5092,7 +5099,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -5273,7 +5280,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5635,7 +5642,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index a03b75f..cf504bf 100644 --- a/json/PaymentService-v51.json +++ b/json/PaymentService-v51.json @@ -9,8 +9,8 @@ "version" : "51", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v51/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v51/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v51/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:38Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -627,7 +627,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2693,7 +2693,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3079,7 +3079,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3188,7 +3188,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3914,7 +3914,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3922,7 +3922,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4205,7 +4205,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4213,7 +4213,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4488,7 +4488,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4496,7 +4496,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4760,7 +4760,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5000,7 +5000,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { @@ -5252,7 +5259,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -5433,7 +5440,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5823,7 +5830,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index e14fe14..f415166 100644 --- a/json/PaymentService-v52.json +++ b/json/PaymentService-v52.json @@ -9,8 +9,8 @@ "version" : "52", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v52/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:39Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -627,7 +627,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2693,7 +2693,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3079,7 +3079,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3188,7 +3188,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3922,7 +3922,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3930,7 +3930,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4213,7 +4213,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4221,7 +4221,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4496,7 +4496,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4504,7 +4504,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4768,7 +4768,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5008,7 +5008,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { @@ -5260,7 +5267,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -5441,7 +5448,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5831,7 +5838,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index 351b3c4..401548e 100644 --- a/json/PaymentService-v64.json +++ b/json/PaymentService-v64.json @@ -9,8 +9,8 @@ "version" : "64", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v64/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:39Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -627,7 +627,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2693,7 +2693,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3079,7 +3079,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3188,7 +3188,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3454,76 +3454,6 @@ "accountScore" ] }, - "FundDestination" : { - "properties" : { - "additionalData" : { - "additionalProperties" : { - "type" : "string" - }, - "description" : "a map of name/value pairs for passing in additional/industry-specific data", - "type" : "object" - }, - "billingAddress" : { - "description" : "The address where to send the invoice.", - "$ref" : "#/components/schemas/Address" - }, - "card" : { - "description" : "Credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided.", - "$ref" : "#/components/schemas/Card" - }, - "selectedRecurringDetailReference" : { - "description" : "The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "the email address of the person", - "type" : "string" - }, - "shopperName" : { - "description" : "the name of the person", - "$ref" : "#/components/schemas/Name" - }, - "shopperReference" : { - "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address.", - "type" : "string" - }, - "telephoneNumber" : { - "description" : "the telephone number of the person", - "type" : "string" - } - } - }, - "FundSource" : { - "properties" : { - "additionalData" : { - "additionalProperties" : { - "type" : "string" - }, - "description" : "A map of name-value pairs for passing additional or industry-specific data.", - "type" : "object" - }, - "billingAddress" : { - "description" : "The address where to send the invoice.", - "$ref" : "#/components/schemas/Address" - }, - "card" : { - "description" : "Credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided.", - "$ref" : "#/components/schemas/Card" - }, - "shopperEmail" : { - "description" : "Email address of the person.", - "type" : "string" - }, - "shopperName" : { - "description" : "Name of the person.", - "$ref" : "#/components/schemas/Name" - }, - "telephoneNumber" : { - "description" : "Phone number of the person", - "type" : "string" - } - } - }, "Installments" : { "properties" : { "plan" : { @@ -3870,16 +3800,6 @@ "format" : "int32", "type" : "integer" }, - "fundDestination" : { - "x-addedInVersion" : "64", - "description" : "the person or entity receiving the money", - "$ref" : "#/components/schemas/FundDestination" - }, - "fundSource" : { - "x-addedInVersion" : "64", - "description" : "The person or entity funding the money.", - "$ref" : "#/components/schemas/FundSource" - }, "fundingSource" : { "x-addedInVersion" : "52", "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4011,7 +3931,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4019,7 +3939,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4302,7 +4222,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4310,7 +4230,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4585,7 +4505,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4593,7 +4513,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4857,7 +4777,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5097,7 +5017,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { @@ -5349,7 +5276,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -5530,7 +5457,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5920,7 +5847,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v67.json b/json/PaymentService-v67.json index d2442d2..c8052cc 100644 --- a/json/PaymentService-v67.json +++ b/json/PaymentService-v67.json @@ -9,8 +9,8 @@ "version" : "67", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v67/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v67/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v67/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:39Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -627,7 +627,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2693,7 +2693,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3079,7 +3079,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3188,7 +3188,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3454,76 +3454,6 @@ "accountScore" ] }, - "FundDestination" : { - "properties" : { - "additionalData" : { - "additionalProperties" : { - "type" : "string" - }, - "description" : "a map of name/value pairs for passing in additional/industry-specific data", - "type" : "object" - }, - "billingAddress" : { - "description" : "The address where to send the invoice.", - "$ref" : "#/components/schemas/Address" - }, - "card" : { - "description" : "Credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided.", - "$ref" : "#/components/schemas/Card" - }, - "selectedRecurringDetailReference" : { - "description" : "The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "the email address of the person", - "type" : "string" - }, - "shopperName" : { - "description" : "the name of the person", - "$ref" : "#/components/schemas/Name" - }, - "shopperReference" : { - "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address.", - "type" : "string" - }, - "telephoneNumber" : { - "description" : "the telephone number of the person", - "type" : "string" - } - } - }, - "FundSource" : { - "properties" : { - "additionalData" : { - "additionalProperties" : { - "type" : "string" - }, - "description" : "A map of name-value pairs for passing additional or industry-specific data.", - "type" : "object" - }, - "billingAddress" : { - "description" : "The address where to send the invoice.", - "$ref" : "#/components/schemas/Address" - }, - "card" : { - "description" : "Credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided.", - "$ref" : "#/components/schemas/Card" - }, - "shopperEmail" : { - "description" : "Email address of the person.", - "type" : "string" - }, - "shopperName" : { - "description" : "Name of the person.", - "$ref" : "#/components/schemas/Name" - }, - "telephoneNumber" : { - "description" : "Phone number of the person", - "type" : "string" - } - } - }, "Installments" : { "properties" : { "plan" : { @@ -3864,16 +3794,6 @@ "format" : "int32", "type" : "integer" }, - "fundDestination" : { - "x-addedInVersion" : "64", - "description" : "the person or entity receiving the money", - "$ref" : "#/components/schemas/FundDestination" - }, - "fundSource" : { - "x-addedInVersion" : "64", - "description" : "The person or entity funding the money.", - "$ref" : "#/components/schemas/FundSource" - }, "fundingSource" : { "x-addedInVersion" : "52", "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4005,7 +3925,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4013,7 +3933,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4290,7 +4210,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4298,7 +4218,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4567,7 +4487,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4575,7 +4495,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4839,7 +4759,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5079,7 +4999,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { @@ -5323,7 +5250,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -5504,7 +5431,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5959,7 +5886,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v68.json b/json/PaymentService-v68.json index 8da9391..e61792d 100644 --- a/json/PaymentService-v68.json +++ b/json/PaymentService-v68.json @@ -9,8 +9,8 @@ "version" : "68", "x-publicVersion" : true, "title" : "Adyen Payment API", - "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v68/authorise\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "A set of API endpoints that allow you to initiate, settle, and modify payments on the Adyen payments platform. You can use the API to accept card payments (including One-Click and 3D Secure), bank transfers, ewallets, and many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\n## Authentication\nTo connect to the Payments API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nPayments API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Payment/v68/authorise\n```", + "x-timestamp" : "2022-08-22T16:23:39Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -627,7 +627,7 @@ "Modifications" ], "summary" : "Cancel or refund a payment", - "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", + "description" : "Cancels a payment if it has not been captured yet, or refunds it if it has already been captured. This is useful when it is not certain if the payment has been captured or not (for example, when using auto-capture).\n\nDo not use this endpoint for payments that involve:\n * [Multiple partial captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information) either at time of payment or capture for Adyen for Platforms.\n\n Instead, check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund) or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\nFor more information, refer to [Cancel or refund](https://docs.adyen.com/online-payments/classic-integrations/modify-payments/cancel-or-refund).\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/{paymentPspReference}/reversals`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/{paymentPspReference}/reversals) endpoint under Checkout API instead.", "operationId" : "post-cancelOrRefund", "x-groupName" : "Modifications", "x-sortIndex" : 4, @@ -2827,7 +2827,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3213,7 +3213,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3322,7 +3322,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3588,76 +3588,6 @@ "accountScore" ] }, - "FundDestination" : { - "properties" : { - "additionalData" : { - "additionalProperties" : { - "type" : "string" - }, - "description" : "a map of name/value pairs for passing in additional/industry-specific data", - "type" : "object" - }, - "billingAddress" : { - "description" : "The address where to send the invoice.", - "$ref" : "#/components/schemas/Address" - }, - "card" : { - "description" : "Credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided.", - "$ref" : "#/components/schemas/Card" - }, - "selectedRecurringDetailReference" : { - "description" : "The `recurringDetailReference` you want to use for this payment. The value `LATEST` can be used to select the most recently stored recurring detail.", - "type" : "string" - }, - "shopperEmail" : { - "description" : "the email address of the person", - "type" : "string" - }, - "shopperName" : { - "description" : "the name of the person", - "$ref" : "#/components/schemas/Name" - }, - "shopperReference" : { - "description" : "Required for recurring payments. \nYour reference to uniquely identify this shopper, for example user ID or account ID. Minimum length: 3 characters.\n> Your reference must not include personally identifiable information (PII), for example name or email address.", - "type" : "string" - }, - "telephoneNumber" : { - "description" : "the telephone number of the person", - "type" : "string" - } - } - }, - "FundSource" : { - "properties" : { - "additionalData" : { - "additionalProperties" : { - "type" : "string" - }, - "description" : "A map of name-value pairs for passing additional or industry-specific data.", - "type" : "object" - }, - "billingAddress" : { - "description" : "The address where to send the invoice.", - "$ref" : "#/components/schemas/Address" - }, - "card" : { - "description" : "Credit card data.\n\nOptional if `shopperReference` and `selectedRecurringDetailReference` are provided.", - "$ref" : "#/components/schemas/Card" - }, - "shopperEmail" : { - "description" : "Email address of the person.", - "type" : "string" - }, - "shopperName" : { - "description" : "Name of the person.", - "$ref" : "#/components/schemas/Name" - }, - "telephoneNumber" : { - "description" : "Phone number of the person", - "type" : "string" - } - } - }, "Installments" : { "properties" : { "plan" : { @@ -4027,16 +3957,6 @@ "format" : "int32", "type" : "integer" }, - "fundDestination" : { - "x-addedInVersion" : "64", - "description" : "the person or entity receiving the money", - "$ref" : "#/components/schemas/FundDestination" - }, - "fundSource" : { - "x-addedInVersion" : "64", - "description" : "The person or entity funding the money.", - "$ref" : "#/components/schemas/FundSource" - }, "fundingSource" : { "x-addedInVersion" : "52", "description" : "The funding source that should be used when multiple sources are available. For Brazilian combo cards, by default the funding source is credit. To use debit, set this value to **debit**.", @@ -4168,7 +4088,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4176,7 +4096,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4453,7 +4373,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4461,7 +4381,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4730,7 +4650,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split).", + "description" : "An array of objects specifying how the payment should be split when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4738,7 +4658,7 @@ }, "store" : { "x-addedInVersion" : "23", - "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", + "description" : "The ecommerce or point-of-sale store that is processing the payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -5017,7 +4937,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5257,7 +5177,14 @@ "type" : "string" }, "merchantAdviceCode" : { - "description" : "The Merchant Advice Code (MAC) can be returned by Mastercard issuers for refused payments. If present, the MAC contains information about why the payment failed, and whether it can be retried.\n\nFor more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).", + "description" : "A code and message that issuers send to provide more details about the payment. This field is especially useful when implementing a retry logic for declined payments.\n\nPossible values:\n\n* **01: New account information available**\n\n* **02: Cannot approve at this time, try again later**\n\n* **03: Do not try again**\n\n* **04: Token requirements not fulfilled for this token type**\n\n* **21: Payment Cancellation** (only for Mastercard)\n\n", + "enum" : [ + "01: New account information available", + "02: Cannot approve at this time, try again later", + "03: Do not try again", + "04: Token requirements not fulfilled for this token type", + "21: Payment Cancellation" + ], "type" : "string" }, "merchantReference" : { @@ -5501,7 +5428,7 @@ "additionalProperties" : { "type" : "string" }, - "description" : "Contains additional information about the payment. Some data fields are included only if you select them first. Go to **Customer Area** > **Developers** > **Additional data**.", + "description" : "Contains additional information about the payment. Some data fields are included only if you select them first: Go to **Customer Area** > **Account** > **API URLs**.", "type" : "object" }, "errorCode" : { @@ -5682,7 +5609,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -6340,7 +6267,7 @@ }, "splits" : { "x-addedInVersion" : "37", - "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information).", + "description" : "An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/RecurringService-v25.json b/json/RecurringService-v25.json index d416941..a9a77ec 100644 --- a/json/RecurringService-v25.json +++ b/json/RecurringService-v25.json @@ -9,8 +9,8 @@ "version" : "25", "x-publicVersion" : true, "title" : "Adyen Recurring API", - "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v25/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v25/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nTo connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v25/disable\n```", + "x-timestamp" : "2022-07-19T19:18:39Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/RecurringService-v30.json b/json/RecurringService-v30.json index 1988326..d1880ef 100644 --- a/json/RecurringService-v30.json +++ b/json/RecurringService-v30.json @@ -9,8 +9,8 @@ "version" : "30", "x-publicVersion" : true, "title" : "Adyen Recurring API", - "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v30/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v30/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nTo connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v30/disable\n```", + "x-timestamp" : "2022-07-19T19:18:39Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", diff --git a/json/RecurringService-v40.json b/json/RecurringService-v40.json index 16abfe7..093ddb5 100644 --- a/json/RecurringService-v40.json +++ b/json/RecurringService-v40.json @@ -9,8 +9,8 @@ "version" : "40", "x-publicVersion" : true, "title" : "Adyen Recurring API", - "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v40/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v40/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nTo connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v40/disable\n```", + "x-timestamp" : "2022-07-19T19:18:39Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -27,100 +27,6 @@ } ], "paths" : { - "/createPermit" : { - "post" : { - "tags" : [ - "General" - ], - "summary" : "Create new permits linked to a recurring contract.", - "description" : "Create permits for a recurring contract, including support for defining restrictions.", - "x-addedInVersion" : "40", - "operationId" : "post-createPermit", - "x-groupName" : "General", - "x-sortIndex" : 0, - "security" : [ - { - "BasicAuth" : [ - ] - }, - { - "ApiKeyAuth" : [ - ] - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePermitRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePermitResult" - } - } - }, - "description" : "OK - the request has succeeded." - }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, - "401" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unauthorized - authentication required." - }, - "403" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Forbidden - insufficient permissions to process the request." - }, - "422" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unprocessable Entity - a request validation error." - }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Internal Server Error - the server could not process the request." - } - } - } - }, "/disable" : { "post" : { "tags" : [ @@ -682,50 +588,6 @@ "holderName" ] }, - "CreatePermitRequest" : { - "properties" : { - "merchantAccount" : { - "description" : "The merchant account identifier, with which you want to process the transaction.", - "type" : "string" - }, - "permits" : { - "description" : "The permits to create for this recurring contract.", - "items" : { - "$ref" : "#/components/schemas/Permit" - }, - "type" : "array" - }, - "recurringDetailReference" : { - "description" : "The recurring contract the new permits will use.", - "type" : "string" - }, - "shopperReference" : { - "description" : "The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).", - "type" : "string" - } - }, - "required" : [ - "merchantAccount", - "shopperReference", - "recurringDetailReference", - "permits" - ] - }, - "CreatePermitResult" : { - "properties" : { - "permitResultList" : { - "description" : "List of new permits.", - "items" : { - "$ref" : "#/components/schemas/PermitResult" - }, - "type" : "array" - }, - "pspReference" : { - "description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.", - "type" : "string" - } - } - }, "DisableRequest" : { "properties" : { "contract" : { @@ -853,61 +715,6 @@ } } }, - "Permit" : { - "properties" : { - "partnerId" : { - "description" : "Partner ID (when using the permit-per-partner token sharing model).", - "type" : "string" - }, - "profileReference" : { - "description" : "The profile to apply to this permit (when using the shared permits model).", - "type" : "string" - }, - "restriction" : { - "description" : "Permit level restriction overrides.", - "$ref" : "#/components/schemas/PermitRestriction" - }, - "resultKey" : { - "description" : "The key to link permit requests to permit results.", - "type" : "string" - }, - "validTillDate" : { - "description" : "The expiry date for this permit.", - "format" : "date-time", - "type" : "string" - } - } - }, - "PermitRestriction" : { - "properties" : { - "maxAmount" : { - "description" : "The total sum amount of one or more payments made using this permit may not exceed this amount if set.", - "$ref" : "#/components/schemas/Amount" - }, - "singleTransactionLimit" : { - "description" : "The amount of any single payment using this permit may not exceed this amount if set.", - "$ref" : "#/components/schemas/Amount" - }, - "singleUse" : { - "description" : "Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed.", - "type" : "boolean" - } - } - }, - "PermitResult" : { - "properties" : { - "resultKey" : { - "x-addedInVersion" : "32", - "description" : "The key to link permit requests to permit results.", - "type" : "string" - }, - "token" : { - "x-addedInVersion" : "32", - "description" : "The permit token which is used to make payments by the partner company.", - "type" : "string" - } - } - }, "Recurring" : { "properties" : { "contract" : { diff --git a/json/RecurringService-v49.json b/json/RecurringService-v49.json index a3dcd8e..bfa9f01 100644 --- a/json/RecurringService-v49.json +++ b/json/RecurringService-v49.json @@ -9,8 +9,8 @@ "version" : "49", "x-publicVersion" : true, "title" : "Adyen Recurring API", - "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v49/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v49/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nTo connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v49/disable\n```", + "x-timestamp" : "2022-08-25T17:24:58Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -27,100 +27,6 @@ } ], "paths" : { - "/createPermit" : { - "post" : { - "tags" : [ - "General" - ], - "summary" : "Create new permits linked to a recurring contract.", - "description" : "Create permits for a recurring contract, including support for defining restrictions.", - "x-addedInVersion" : "40", - "operationId" : "post-createPermit", - "x-groupName" : "General", - "x-sortIndex" : 0, - "security" : [ - { - "BasicAuth" : [ - ] - }, - { - "ApiKeyAuth" : [ - ] - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePermitRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePermitResult" - } - } - }, - "description" : "OK - the request has succeeded." - }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, - "401" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unauthorized - authentication required." - }, - "403" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Forbidden - insufficient permissions to process the request." - }, - "422" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unprocessable Entity - a request validation error." - }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Internal Server Error - the server could not process the request." - } - } - } - }, "/disable" : { "post" : { "tags" : [ @@ -682,50 +588,6 @@ "holderName" ] }, - "CreatePermitRequest" : { - "properties" : { - "merchantAccount" : { - "description" : "The merchant account identifier, with which you want to process the transaction.", - "type" : "string" - }, - "permits" : { - "description" : "The permits to create for this recurring contract.", - "items" : { - "$ref" : "#/components/schemas/Permit" - }, - "type" : "array" - }, - "recurringDetailReference" : { - "description" : "The recurring contract the new permits will use.", - "type" : "string" - }, - "shopperReference" : { - "description" : "The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).", - "type" : "string" - } - }, - "required" : [ - "merchantAccount", - "shopperReference", - "recurringDetailReference", - "permits" - ] - }, - "CreatePermitResult" : { - "properties" : { - "permitResultList" : { - "description" : "List of new permits.", - "items" : { - "$ref" : "#/components/schemas/PermitResult" - }, - "type" : "array" - }, - "pspReference" : { - "description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.", - "type" : "string" - } - } - }, "DisableRequest" : { "properties" : { "contract" : { @@ -853,61 +715,6 @@ } } }, - "Permit" : { - "properties" : { - "partnerId" : { - "description" : "Partner ID (when using the permit-per-partner token sharing model).", - "type" : "string" - }, - "profileReference" : { - "description" : "The profile to apply to this permit (when using the shared permits model).", - "type" : "string" - }, - "restriction" : { - "description" : "Permit level restriction overrides.", - "$ref" : "#/components/schemas/PermitRestriction" - }, - "resultKey" : { - "description" : "The key to link permit requests to permit results.", - "type" : "string" - }, - "validTillDate" : { - "description" : "The expiry date for this permit.", - "format" : "date-time", - "type" : "string" - } - } - }, - "PermitRestriction" : { - "properties" : { - "maxAmount" : { - "description" : "The total sum amount of one or more payments made using this permit may not exceed this amount if set.", - "$ref" : "#/components/schemas/Amount" - }, - "singleTransactionLimit" : { - "description" : "The amount of any single payment using this permit may not exceed this amount if set.", - "$ref" : "#/components/schemas/Amount" - }, - "singleUse" : { - "description" : "Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed.", - "type" : "boolean" - } - } - }, - "PermitResult" : { - "properties" : { - "resultKey" : { - "x-addedInVersion" : "32", - "description" : "The key to link permit requests to permit results.", - "type" : "string" - }, - "token" : { - "x-addedInVersion" : "32", - "description" : "The permit token which is used to make payments by the partner company.", - "type" : "string" - } - } - }, "Recurring" : { "properties" : { "contract" : { diff --git a/json/RecurringService-v67.json b/json/RecurringService-v67.json index c564de5..b4920cb 100644 --- a/json/RecurringService-v67.json +++ b/json/RecurringService-v67.json @@ -9,8 +9,8 @@ "version" : "67", "x-publicVersion" : true, "title" : "Adyen Recurring API", - "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v67/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v67/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nTo connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v67/disable\n```", + "x-timestamp" : "2022-08-25T17:24:58Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -27,100 +27,6 @@ } ], "paths" : { - "/createPermit" : { - "post" : { - "tags" : [ - "General" - ], - "summary" : "Create new permits linked to a recurring contract.", - "description" : "Create permits for a recurring contract, including support for defining restrictions.", - "x-addedInVersion" : "40", - "operationId" : "post-createPermit", - "x-groupName" : "General", - "x-sortIndex" : 0, - "security" : [ - { - "BasicAuth" : [ - ] - }, - { - "ApiKeyAuth" : [ - ] - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePermitRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePermitResult" - } - } - }, - "description" : "OK - the request has succeeded." - }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, - "401" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unauthorized - authentication required." - }, - "403" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Forbidden - insufficient permissions to process the request." - }, - "422" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unprocessable Entity - a request validation error." - }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Internal Server Error - the server could not process the request." - } - } - } - }, "/disable" : { "post" : { "tags" : [ @@ -219,100 +125,6 @@ } } }, - "/disablePermit" : { - "post" : { - "tags" : [ - "General" - ], - "summary" : "Disable an existing permit.", - "description" : "Disable a permit that was previously linked to a recurringDetailReference.", - "x-addedInVersion" : "61", - "operationId" : "post-disablePermit", - "x-groupName" : "General", - "x-sortIndex" : 0, - "security" : [ - { - "BasicAuth" : [ - ] - }, - { - "ApiKeyAuth" : [ - ] - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/DisablePermitRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/DisablePermitResult" - } - } - }, - "description" : "OK - the request has succeeded." - }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, - "401" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unauthorized - authentication required." - }, - "403" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Forbidden - insufficient permissions to process the request." - }, - "422" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unprocessable Entity - a request validation error." - }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Internal Server Error - the server could not process the request." - } - } - } - }, "/listRecurringDetails" : { "post" : { "tags" : [ @@ -776,78 +588,6 @@ "holderName" ] }, - "CreatePermitRequest" : { - "properties" : { - "merchantAccount" : { - "description" : "The merchant account identifier, with which you want to process the transaction.", - "type" : "string" - }, - "permits" : { - "description" : "The permits to create for this recurring contract.", - "items" : { - "$ref" : "#/components/schemas/Permit" - }, - "type" : "array" - }, - "recurringDetailReference" : { - "description" : "The recurring contract the new permits will use.", - "type" : "string" - }, - "shopperReference" : { - "description" : "The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).", - "type" : "string" - } - }, - "required" : [ - "merchantAccount", - "shopperReference", - "recurringDetailReference", - "permits" - ] - }, - "CreatePermitResult" : { - "properties" : { - "permitResultList" : { - "description" : "List of new permits.", - "items" : { - "$ref" : "#/components/schemas/PermitResult" - }, - "type" : "array" - }, - "pspReference" : { - "description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.", - "type" : "string" - } - } - }, - "DisablePermitRequest" : { - "properties" : { - "merchantAccount" : { - "description" : "The merchant account identifier, with which you want to process the transaction.", - "type" : "string" - }, - "token" : { - "description" : "The permit token to disable.", - "type" : "string" - } - }, - "required" : [ - "merchantAccount", - "token" - ] - }, - "DisablePermitResult" : { - "properties" : { - "pspReference" : { - "description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.", - "type" : "string" - }, - "status" : { - "description" : "Status of the disable request.", - "type" : "string" - } - } - }, "DisableRequest" : { "properties" : { "contract" : { @@ -975,61 +715,6 @@ } } }, - "Permit" : { - "properties" : { - "partnerId" : { - "description" : "Partner ID (when using the permit-per-partner token sharing model).", - "type" : "string" - }, - "profileReference" : { - "description" : "The profile to apply to this permit (when using the shared permits model).", - "type" : "string" - }, - "restriction" : { - "description" : "Permit level restriction overrides.", - "$ref" : "#/components/schemas/PermitRestriction" - }, - "resultKey" : { - "description" : "The key to link permit requests to permit results.", - "type" : "string" - }, - "validTillDate" : { - "description" : "The expiry date for this permit.", - "format" : "date-time", - "type" : "string" - } - } - }, - "PermitRestriction" : { - "properties" : { - "maxAmount" : { - "description" : "The total sum amount of one or more payments made using this permit may not exceed this amount if set.", - "$ref" : "#/components/schemas/Amount" - }, - "singleTransactionLimit" : { - "description" : "The amount of any single payment using this permit may not exceed this amount if set.", - "$ref" : "#/components/schemas/Amount" - }, - "singleUse" : { - "description" : "Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed.", - "type" : "boolean" - } - } - }, - "PermitResult" : { - "properties" : { - "resultKey" : { - "x-addedInVersion" : "32", - "description" : "The key to link permit requests to permit results.", - "type" : "string" - }, - "token" : { - "x-addedInVersion" : "32", - "description" : "The permit token which is used to make payments by the partner company.", - "type" : "string" - } - } - }, "Recurring" : { "properties" : { "contract" : { diff --git a/json/RecurringService-v68.json b/json/RecurringService-v68.json index 102cf3d..230ab9a 100644 --- a/json/RecurringService-v68.json +++ b/json/RecurringService-v68.json @@ -9,8 +9,8 @@ "version" : "68", "x-publicVersion" : true, "title" : "Adyen Recurring API", - "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials) to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type: application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively, you can use the username and password to connect to the API using basic authentication, for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v68/disable\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials) from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", - "x-timestamp" : "2022-09-26T15:20:41Z", + "description" : "The Recurring APIs allow you to manage and remove your tokens or saved payment details. Tokens should be created with validation during a payment request.\n\nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n## Authentication\nTo connect to the Recurring API, you must use your basic authentication credentials. For this, create your web service user, as described in [How to get the WS user password](https://docs.adyen.com/development-resources/api-credentials). Then use its credentials to authenticate your request, for example:\n\n```\ncurl\n-U \"ws@Company.YourCompany\":\"YourWsPassword\" \\\n-H \"Content-Type: application/json\" \\\n...\n```\nNote that when going live, you need to generate new web service user credentials to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints).\n\n## Versioning\nRecurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) using 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://pal-test.adyen.com/pal/servlet/Recurring/v68/disable\n```", + "x-timestamp" : "2022-08-25T17:24:58Z", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -27,100 +27,6 @@ } ], "paths" : { - "/createPermit" : { - "post" : { - "tags" : [ - "General" - ], - "summary" : "Create new permits linked to a recurring contract.", - "description" : "Create permits for a recurring contract, including support for defining restrictions.", - "x-addedInVersion" : "40", - "operationId" : "post-createPermit", - "x-groupName" : "General", - "x-sortIndex" : 0, - "security" : [ - { - "BasicAuth" : [ - ] - }, - { - "ApiKeyAuth" : [ - ] - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePermitRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CreatePermitResult" - } - } - }, - "description" : "OK - the request has succeeded." - }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, - "401" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unauthorized - authentication required." - }, - "403" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Forbidden - insufficient permissions to process the request." - }, - "422" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unprocessable Entity - a request validation error." - }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Internal Server Error - the server could not process the request." - } - } - } - }, "/disable" : { "post" : { "tags" : [ @@ -219,100 +125,6 @@ } } }, - "/disablePermit" : { - "post" : { - "tags" : [ - "General" - ], - "summary" : "Disable an existing permit.", - "description" : "Disable a permit that was previously linked to a recurringDetailReference.", - "x-addedInVersion" : "61", - "operationId" : "post-disablePermit", - "x-groupName" : "General", - "x-sortIndex" : 0, - "security" : [ - { - "BasicAuth" : [ - ] - }, - { - "ApiKeyAuth" : [ - ] - } - ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/DisablePermitRequest" - } - } - } - }, - "responses" : { - "200" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/DisablePermitResult" - } - } - }, - "description" : "OK - the request has succeeded." - }, - "400" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Bad Request - a problem reading or understanding the request." - }, - "401" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unauthorized - authentication required." - }, - "403" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Forbidden - insufficient permissions to process the request." - }, - "422" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Unprocessable Entity - a request validation error." - }, - "500" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ServiceError" - } - } - }, - "description" : "Internal Server Error - the server could not process the request." - } - } - } - }, "/listRecurringDetails" : { "post" : { "tags" : [ @@ -776,78 +588,6 @@ "holderName" ] }, - "CreatePermitRequest" : { - "properties" : { - "merchantAccount" : { - "description" : "The merchant account identifier, with which you want to process the transaction.", - "type" : "string" - }, - "permits" : { - "description" : "The permits to create for this recurring contract.", - "items" : { - "$ref" : "#/components/schemas/Permit" - }, - "type" : "array" - }, - "recurringDetailReference" : { - "description" : "The recurring contract the new permits will use.", - "type" : "string" - }, - "shopperReference" : { - "description" : "The shopper's reference to uniquely identify this shopper (e.g. user ID or account ID).", - "type" : "string" - } - }, - "required" : [ - "merchantAccount", - "shopperReference", - "recurringDetailReference", - "permits" - ] - }, - "CreatePermitResult" : { - "properties" : { - "permitResultList" : { - "description" : "List of new permits.", - "items" : { - "$ref" : "#/components/schemas/PermitResult" - }, - "type" : "array" - }, - "pspReference" : { - "description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.", - "type" : "string" - } - } - }, - "DisablePermitRequest" : { - "properties" : { - "merchantAccount" : { - "description" : "The merchant account identifier, with which you want to process the transaction.", - "type" : "string" - }, - "token" : { - "description" : "The permit token to disable.", - "type" : "string" - } - }, - "required" : [ - "merchantAccount", - "token" - ] - }, - "DisablePermitResult" : { - "properties" : { - "pspReference" : { - "description" : "A unique reference associated with the request. This value is globally unique; quote it when communicating with us about this request.", - "type" : "string" - }, - "status" : { - "description" : "Status of the disable request.", - "type" : "string" - } - } - }, "DisableRequest" : { "properties" : { "contract" : { @@ -975,61 +715,6 @@ } } }, - "Permit" : { - "properties" : { - "partnerId" : { - "description" : "Partner ID (when using the permit-per-partner token sharing model).", - "type" : "string" - }, - "profileReference" : { - "description" : "The profile to apply to this permit (when using the shared permits model).", - "type" : "string" - }, - "restriction" : { - "description" : "Permit level restriction overrides.", - "$ref" : "#/components/schemas/PermitRestriction" - }, - "resultKey" : { - "description" : "The key to link permit requests to permit results.", - "type" : "string" - }, - "validTillDate" : { - "description" : "The expiry date for this permit.", - "format" : "date-time", - "type" : "string" - } - } - }, - "PermitRestriction" : { - "properties" : { - "maxAmount" : { - "description" : "The total sum amount of one or more payments made using this permit may not exceed this amount if set.", - "$ref" : "#/components/schemas/Amount" - }, - "singleTransactionLimit" : { - "description" : "The amount of any single payment using this permit may not exceed this amount if set.", - "$ref" : "#/components/schemas/Amount" - }, - "singleUse" : { - "description" : "Only a single payment can be made using this permit if set to true, otherwise multiple payments are allowed.", - "type" : "boolean" - } - } - }, - "PermitResult" : { - "properties" : { - "resultKey" : { - "x-addedInVersion" : "32", - "description" : "The key to link permit requests to permit results.", - "type" : "string" - }, - "token" : { - "x-addedInVersion" : "32", - "description" : "The permit token which is used to make payments by the partner company.", - "type" : "string" - } - } - }, "Recurring" : { "properties" : { "contract" : { diff --git a/yaml/BinLookupService-v40.yaml b/yaml/BinLookupService-v40.yaml index 7475e03..f866050 100644 --- a/yaml/BinLookupService-v40.yaml +++ b/yaml/BinLookupService-v40.yaml @@ -5,24 +5,9 @@ info: version: '40' x-publicVersion: true title: Adyen BinLookup API - description: "The BIN Lookup API provides endpoints for retrieving information,\ - \ such as cost estimates, and 3D Secure supported version based on a given BIN.\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nThe\ - \ BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/BinLookup/v40/get3dsAvailability\n\ - ```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which\ - \ is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v40/get3dsAvailability\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-23T11:29:18Z' + description: The BIN Lookup API provides endpoints for retrieving information, such + as cost estimates, and 3D Secure supported version based on a given BIN. + x-timestamp: '2022-07-19T19:18:37Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/BinLookupService-v50.yaml b/yaml/BinLookupService-v50.yaml index ca3cc17..d0d11f5 100644 --- a/yaml/BinLookupService-v50.yaml +++ b/yaml/BinLookupService-v50.yaml @@ -5,24 +5,9 @@ info: version: '50' x-publicVersion: true title: Adyen BinLookup API - description: "The BIN Lookup API provides endpoints for retrieving information,\ - \ such as cost estimates, and 3D Secure supported version based on a given BIN.\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nThe\ - \ BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/BinLookup/v50/get3dsAvailability\n\ - ```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which\ - \ is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v50/get3dsAvailability\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-23T11:29:18Z' + description: The BIN Lookup API provides endpoints for retrieving information, such + as cost estimates, and 3D Secure supported version based on a given BIN. + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -513,9 +498,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. diff --git a/yaml/BinLookupService-v52.yaml b/yaml/BinLookupService-v52.yaml index d095085..334fd60 100644 --- a/yaml/BinLookupService-v52.yaml +++ b/yaml/BinLookupService-v52.yaml @@ -5,24 +5,9 @@ info: version: '52' x-publicVersion: true title: Adyen BinLookup API - description: "The BIN Lookup API provides endpoints for retrieving information,\ - \ such as cost estimates, and 3D Secure supported version based on a given BIN.\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nThe\ - \ BinLookup API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/BinLookup/v52/get3dsAvailability\n\ - ```## Going live\n\nTo authneticate to the live endpoints, you need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ from your live Customer Area.\n\nThe live endpoint URLs contain a prefix which\ - \ is unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/BinLookup/v52/get3dsAvailability\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-23T11:29:19Z' + description: The BIN Lookup API provides endpoints for retrieving information, such + as cost estimates, and 3D Secure supported version based on a given BIN. + x-timestamp: '2022-07-19T19:18:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -517,9 +502,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml index fa7e30e..97762c9 100644 --- a/yaml/CheckoutService-v37.yaml +++ b/yaml/CheckoutService-v37.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v37/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=37) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:04Z' + x-timestamp: '2022-09-14T16:34:41Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v40.yaml b/yaml/CheckoutService-v40.yaml index abfe551..8995a30 100644 --- a/yaml/CheckoutService-v40.yaml +++ b/yaml/CheckoutService-v40.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v40/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=40) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:06Z' + x-timestamp: '2022-09-14T16:34:45Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v41.yaml b/yaml/CheckoutService-v41.yaml index c5e8b91..c53d356 100644 --- a/yaml/CheckoutService-v41.yaml +++ b/yaml/CheckoutService-v41.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v41/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=41) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:06Z' + x-timestamp: '2022-09-14T16:34:45Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v46.yaml b/yaml/CheckoutService-v46.yaml index 04eb470..5ea885f 100644 --- a/yaml/CheckoutService-v46.yaml +++ b/yaml/CheckoutService-v46.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v46/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=46) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:07Z' + x-timestamp: '2022-09-14T16:34:46Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v49.yaml b/yaml/CheckoutService-v49.yaml index f781faa..9ea98c6 100644 --- a/yaml/CheckoutService-v49.yaml +++ b/yaml/CheckoutService-v49.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v49/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=49) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:07Z' + x-timestamp: '2022-09-14T16:34:47Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v50.yaml b/yaml/CheckoutService-v50.yaml index ad17a20..f971bbf 100644 --- a/yaml/CheckoutService-v50.yaml +++ b/yaml/CheckoutService-v50.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v50/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=50) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:08Z' + x-timestamp: '2022-09-14T16:34:48Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v51.yaml b/yaml/CheckoutService-v51.yaml index de39fb7..eaff5d8 100644 --- a/yaml/CheckoutService-v51.yaml +++ b/yaml/CheckoutService-v51.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v51/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=51) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:08Z' + x-timestamp: '2022-09-14T16:34:48Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v52.yaml b/yaml/CheckoutService-v52.yaml index 5cf6d22..b4832f3 100644 --- a/yaml/CheckoutService-v52.yaml +++ b/yaml/CheckoutService-v52.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v52/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=52) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:09Z' + x-timestamp: '2022-09-14T16:34:51Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v53.yaml b/yaml/CheckoutService-v53.yaml index a0bdda9..52d7b82 100644 --- a/yaml/CheckoutService-v53.yaml +++ b/yaml/CheckoutService-v53.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v53/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=53) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:09Z' + x-timestamp: '2022-09-14T16:34:52Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v64.yaml b/yaml/CheckoutService-v64.yaml index dae77b2..805a690 100644 --- a/yaml/CheckoutService-v64.yaml +++ b/yaml/CheckoutService-v64.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v64/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=64) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:09Z' + x-timestamp: '2022-09-14T16:34:54Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v65.yaml b/yaml/CheckoutService-v65.yaml index 012e66a..f26aad7 100644 --- a/yaml/CheckoutService-v65.yaml +++ b/yaml/CheckoutService-v65.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v65/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=65) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:10Z' + x-timestamp: '2022-09-14T16:34:55Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v66.yaml b/yaml/CheckoutService-v66.yaml index d8cd603..94fa456 100644 --- a/yaml/CheckoutService-v66.yaml +++ b/yaml/CheckoutService-v66.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v66/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=66) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:10Z' + x-timestamp: '2022-09-14T16:34:55Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v67.yaml b/yaml/CheckoutService-v67.yaml index 56dd7c3..ea760c9 100644 --- a/yaml/CheckoutService-v67.yaml +++ b/yaml/CheckoutService-v67.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v67/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=67) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:10Z' + x-timestamp: '2022-09-14T16:34:55Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v68.yaml b/yaml/CheckoutService-v68.yaml index e9a6ded..e93d6d0 100644 --- a/yaml/CheckoutService-v68.yaml +++ b/yaml/CheckoutService-v68.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v68/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=68) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:11Z' + x-timestamp: '2022-09-14T16:34:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/CheckoutService-v69.yaml b/yaml/CheckoutService-v69.yaml index 700100a..09860cb 100644 --- a/yaml/CheckoutService-v69.yaml +++ b/yaml/CheckoutService-v69.yaml @@ -12,15 +12,14 @@ info: This API reference provides information on available endpoints and how to interact - with them. To learn more about the API, visit [online payments documentation](https://docs.adyen.com/online-payments). + with them. To learn more about the API, visit [Checkout documentation](https://docs.adyen.com/online-payments). ## Authentication - Each request to Checkout API must be signed with an API key. For this, [get your - API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key) - from your Customer Area, and set this key to the `X-API-Key` header value, for - example: + Each request to the Checkout 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 API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). + Then set this key to the `X-API-Key` header value, for example: ``` @@ -29,12 +28,16 @@ info: -H "Content-Type: application/json" \ - -H "X-API-Key: YOUR_API_KEY" \ + -H "X-API-Key: Your_Checkout_API_key" \ ... ``` + Note that when going live, you need to generate a new API Key to access the [live + endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + ## Versioning Checkout API supports [versioning](https://docs.adyen.com/development-resources/versioning) @@ -51,36 +54,11 @@ info: ``` - ## Going live - - - To access the live endpoints, you need an API key from your live Customer Area. - - - The live endpoint URLs contain a prefix which is unique to your company account, - for example: - - ``` - - https://{PREFIX}-checkout-live.adyenpayments.com/v69/payments - - ``` - - - Get your `{PREFIX}` from your live Customer Area under **Developers** > **API - URLs** > **Prefix**. - - - When preparing to do live transactions with Checkout API, follow the [go-live - checklist](https://docs.adyen.com/online-payments/go-live-checklist) to make sure - you''ve got all the required configuration in place. - - ## Release notes Have a look at the [release notes](https://docs.adyen.com/online-payments/release-notes?integration_type=api&version=69) to find out what changed in this version!' - x-timestamp: '2022-09-21T17:23:11Z' + x-timestamp: '2022-09-21T10:23:20Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index 09a713b..4af34c9 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -5,27 +5,54 @@ info: version: '25' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v25/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v25/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v25/authorise + + ```' + x-timestamp: '2022-08-22T16:23:37Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -283,7 +310,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2890,7 +2917,7 @@ components: store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -3179,7 +3206,7 @@ components: store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -3761,12 +3788,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index aa10dd1..635c7f8 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -5,27 +5,54 @@ info: version: '30' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v30/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v30/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v30/authorise + + ```' + x-timestamp: '2022-08-22T16:23:37Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -368,7 +395,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -3154,7 +3181,7 @@ components: store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -3460,7 +3487,7 @@ components: store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4046,12 +4073,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index a4c630f..fcfed39 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -5,27 +5,54 @@ info: version: '40' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v40/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v40/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v40/authorise + + ```' + x-timestamp: '2022-08-22T16:23:37Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -445,7 +472,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2670,7 +2697,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -2962,7 +2989,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3042,7 +3069,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3828,15 +3855,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4171,15 +4198,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4507,15 +4534,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4770,7 +4797,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5136,12 +5163,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. @@ -5597,7 +5648,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5889,7 +5940,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index f9263ce..214d853 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -5,27 +5,54 @@ info: version: '46' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v46/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v46/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v46/authorise + + ```' + x-timestamp: '2022-08-22T16:23:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -445,7 +472,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2675,7 +2702,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -2977,7 +3004,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3062,7 +3089,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3848,15 +3875,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4191,15 +4218,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4527,15 +4554,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4795,7 +4822,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5161,12 +5188,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. @@ -5484,9 +5535,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. @@ -5635,7 +5686,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5932,7 +5983,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index 1095f70..41d836a 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -5,27 +5,54 @@ info: version: '49' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v49/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v49/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v49/authorise + + ```' + x-timestamp: '2022-08-22T16:23:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -445,7 +472,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2675,7 +2702,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -2977,7 +3004,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3062,7 +3089,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3848,15 +3875,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4191,15 +4218,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4527,15 +4554,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4795,7 +4822,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5161,12 +5188,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. @@ -5484,9 +5535,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. @@ -5635,7 +5686,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5976,7 +6027,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index c732e8a..cdebdc9 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -5,27 +5,54 @@ info: version: '50' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v50/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v50/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v50/authorise + + ```' + x-timestamp: '2022-08-22T16:23:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -445,7 +472,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2692,7 +2719,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -2994,7 +3021,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3079,7 +3106,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3865,15 +3892,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4214,15 +4241,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4556,15 +4583,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4830,7 +4857,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5196,12 +5223,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. @@ -5519,9 +5570,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. @@ -5670,7 +5721,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6029,7 +6080,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index fa2dc3e..5d80199 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -5,27 +5,54 @@ info: version: '51' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v51/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v51/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v51/authorise + + ```' + x-timestamp: '2022-08-22T16:23:38Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -445,7 +472,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2760,7 +2787,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3082,7 +3109,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3167,7 +3194,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3959,15 +3986,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4314,15 +4341,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4662,15 +4689,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4936,7 +4963,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5302,12 +5329,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. @@ -5625,9 +5676,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. @@ -5776,7 +5827,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6156,7 +6207,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index 4b0c948..82ea6a0 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -5,27 +5,54 @@ info: version: '52' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v52/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v52/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v52/authorise + + ```' + x-timestamp: '2022-08-22T16:23:39Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -445,7 +472,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2760,7 +2787,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3082,7 +3109,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3167,7 +3194,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3967,15 +3994,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4322,15 +4349,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4670,15 +4697,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4944,7 +4971,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5310,12 +5337,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. @@ -5633,9 +5684,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. @@ -5784,7 +5835,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6164,7 +6215,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index 7563199..5c423eb 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -5,27 +5,54 @@ info: version: '64' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v64/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v64/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v64/authorise + + ```' + x-timestamp: '2022-08-22T16:23:39Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -445,7 +472,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2760,7 +2787,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3082,7 +3109,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3167,7 +3194,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3421,71 +3448,6 @@ components: type: array required: - accountScore - FundDestination: - properties: - additionalData: - additionalProperties: - type: string - description: a map of name/value pairs for passing in additional/industry-specific - data - type: object - billingAddress: - description: The address where to send the invoice. - $ref: '#/components/schemas/Address' - card: - description: 'Credit card data. - - - Optional if `shopperReference` and `selectedRecurringDetailReference` - are provided.' - $ref: '#/components/schemas/Card' - selectedRecurringDetailReference: - description: The `recurringDetailReference` you want to use for this payment. - The value `LATEST` can be used to select the most recently stored recurring - detail. - type: string - shopperEmail: - description: the email address of the person - type: string - shopperName: - description: the name of the person - $ref: '#/components/schemas/Name' - shopperReference: - description: "Required for recurring payments. \nYour reference to uniquely\ - \ identify this shopper, for example user ID or account ID. Minimum length:\ - \ 3 characters.\n> Your reference must not include personally identifiable\ - \ information (PII), for example name or email address." - type: string - telephoneNumber: - description: the telephone number of the person - type: string - FundSource: - properties: - additionalData: - additionalProperties: - type: string - description: A map of name-value pairs for passing additional or industry-specific - data. - type: object - billingAddress: - description: The address where to send the invoice. - $ref: '#/components/schemas/Address' - card: - description: 'Credit card data. - - - Optional if `shopperReference` and `selectedRecurringDetailReference` - are provided.' - $ref: '#/components/schemas/Card' - shopperEmail: - description: Email address of the person. - type: string - shopperName: - description: Name of the person. - $ref: '#/components/schemas/Name' - telephoneNumber: - description: Phone number of the person - type: string Installments: properties: plan: @@ -3841,14 +3803,6 @@ components: value can be either positive or negative. format: int32 type: integer - fundDestination: - x-addedInVersion: '64' - description: the person or entity receiving the money - $ref: '#/components/schemas/FundDestination' - fundSource: - x-addedInVersion: '64' - description: The person or entity funding the money. - $ref: '#/components/schemas/FundSource' fundingSource: x-addedInVersion: '52' description: The funding source that should be used when multiple sources @@ -4054,15 +4008,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4409,15 +4363,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4757,15 +4711,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -5031,7 +4985,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5397,12 +5351,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. @@ -5720,9 +5698,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. @@ -5871,7 +5849,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6251,7 +6229,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v67.yaml b/yaml/PaymentService-v67.yaml index f0acaa9..f7d81b7 100644 --- a/yaml/PaymentService-v67.yaml +++ b/yaml/PaymentService-v67.yaml @@ -5,27 +5,54 @@ info: version: '67' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v67/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v67/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v67/authorise + + ```' + x-timestamp: '2022-08-22T16:23:39Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -445,7 +472,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2760,7 +2787,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3082,7 +3109,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3167,7 +3194,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3421,71 +3448,6 @@ components: type: array required: - accountScore - FundDestination: - properties: - additionalData: - additionalProperties: - type: string - description: a map of name/value pairs for passing in additional/industry-specific - data - type: object - billingAddress: - description: The address where to send the invoice. - $ref: '#/components/schemas/Address' - card: - description: 'Credit card data. - - - Optional if `shopperReference` and `selectedRecurringDetailReference` - are provided.' - $ref: '#/components/schemas/Card' - selectedRecurringDetailReference: - description: The `recurringDetailReference` you want to use for this payment. - The value `LATEST` can be used to select the most recently stored recurring - detail. - type: string - shopperEmail: - description: the email address of the person - type: string - shopperName: - description: the name of the person - $ref: '#/components/schemas/Name' - shopperReference: - description: "Required for recurring payments. \nYour reference to uniquely\ - \ identify this shopper, for example user ID or account ID. Minimum length:\ - \ 3 characters.\n> Your reference must not include personally identifiable\ - \ information (PII), for example name or email address." - type: string - telephoneNumber: - description: the telephone number of the person - type: string - FundSource: - properties: - additionalData: - additionalProperties: - type: string - description: A map of name-value pairs for passing additional or industry-specific - data. - type: object - billingAddress: - description: The address where to send the invoice. - $ref: '#/components/schemas/Address' - card: - description: 'Credit card data. - - - Optional if `shopperReference` and `selectedRecurringDetailReference` - are provided.' - $ref: '#/components/schemas/Card' - shopperEmail: - description: Email address of the person. - type: string - shopperName: - description: Name of the person. - $ref: '#/components/schemas/Name' - telephoneNumber: - description: Phone number of the person - type: string Installments: properties: plan: @@ -3835,14 +3797,6 @@ components: value can be either positive or negative. format: int32 type: integer - fundDestination: - x-addedInVersion: '64' - description: the person or entity receiving the money - $ref: '#/components/schemas/FundDestination' - fundSource: - x-addedInVersion: '64' - description: The person or entity funding the money. - $ref: '#/components/schemas/FundSource' fundingSource: x-addedInVersion: '52' description: The funding source that should be used when multiple sources @@ -4048,15 +4002,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4397,15 +4351,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4739,15 +4693,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -5013,7 +4967,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5379,12 +5333,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. @@ -5695,9 +5673,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. @@ -5846,7 +5824,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6313,7 +6291,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/PaymentService-v68.yaml b/yaml/PaymentService-v68.yaml index c342cc1..77ddb01 100644 --- a/yaml/PaymentService-v68.yaml +++ b/yaml/PaymentService-v68.yaml @@ -5,27 +5,54 @@ info: version: '68' x-publicVersion: true title: Adyen Payment API - description: "A set of API endpoints that allow you to initiate, settle, and modify\ - \ payments on the Adyen payments platform. You can use the API to accept card\ - \ payments (including One-Click and 3D Secure), bank transfers, ewallets, and\ - \ many other payment methods.\n\nTo learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration).\n\ - \n## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nPayments\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Payment/v68/authorise\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Payment/v68/authorise\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'A set of API endpoints that allow you to initiate, settle, and modify + payments on the Adyen payments platform. You can use the API to accept card payments + (including One-Click and 3D Secure), bank transfers, ewallets, and many other + payment methods. + + + To learn more about the API, visit [Classic integration](https://docs.adyen.com/classic-integration). + + + ## Authentication + + To connect to the Payments API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Payments API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Payment/v68/authorise + + ```' + x-timestamp: '2022-08-22T16:23:39Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -445,7 +472,7 @@ paths: \ it if it has already been captured. This is useful when it is not certain\ \ if the payment has been captured or not (for example, when using auto-capture).\n\ \nDo not use this endpoint for payments that involve:\n * [Multiple partial\ - \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information)\ + \ captures](https://docs.adyen.com/online-payments/capture).\n * [Split data](https://docs.adyen.com/platforms/processing-payments#providing-split-information)\ \ either at time of payment or capture for Adyen for Platforms.\n\n Instead,\ \ check if the payment has been captured and make a corresponding [`/refund`](https://docs.adyen.com/api-explorer/#/Payment/refund)\ \ or [`/cancel`](https://docs.adyen.com/api-explorer/#/Payment/cancel) call.\n\ @@ -2907,7 +2934,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3229,7 +3256,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3314,7 +3341,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3568,71 +3595,6 @@ components: type: array required: - accountScore - FundDestination: - properties: - additionalData: - additionalProperties: - type: string - description: a map of name/value pairs for passing in additional/industry-specific - data - type: object - billingAddress: - description: The address where to send the invoice. - $ref: '#/components/schemas/Address' - card: - description: 'Credit card data. - - - Optional if `shopperReference` and `selectedRecurringDetailReference` - are provided.' - $ref: '#/components/schemas/Card' - selectedRecurringDetailReference: - description: The `recurringDetailReference` you want to use for this payment. - The value `LATEST` can be used to select the most recently stored recurring - detail. - type: string - shopperEmail: - description: the email address of the person - type: string - shopperName: - description: the name of the person - $ref: '#/components/schemas/Name' - shopperReference: - description: "Required for recurring payments. \nYour reference to uniquely\ - \ identify this shopper, for example user ID or account ID. Minimum length:\ - \ 3 characters.\n> Your reference must not include personally identifiable\ - \ information (PII), for example name or email address." - type: string - telephoneNumber: - description: the telephone number of the person - type: string - FundSource: - properties: - additionalData: - additionalProperties: - type: string - description: A map of name-value pairs for passing additional or industry-specific - data. - type: object - billingAddress: - description: The address where to send the invoice. - $ref: '#/components/schemas/Address' - card: - description: 'Credit card data. - - - Optional if `shopperReference` and `selectedRecurringDetailReference` - are provided.' - $ref: '#/components/schemas/Card' - shopperEmail: - description: Email address of the person. - type: string - shopperName: - description: Name of the person. - $ref: '#/components/schemas/Name' - telephoneNumber: - description: Phone number of the person - type: string Installments: properties: plan: @@ -4011,14 +3973,6 @@ components: value can be either positive or negative. format: int32 type: integer - fundDestination: - x-addedInVersion: '64' - description: the person or entity receiving the money - $ref: '#/components/schemas/FundDestination' - fundSource: - x-addedInVersion: '64' - description: The person or entity funding the money. - $ref: '#/components/schemas/FundSource' fundingSource: x-addedInVersion: '52' description: The funding source that should be used when multiple sources @@ -4224,15 +4178,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4573,15 +4527,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4915,15 +4869,15 @@ components: splits: x-addedInVersion: '37' description: An array of objects specifying how the payment should be split - when using [Adyen for Platforms](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/add-manage-funds#split). + when using [Adyen for Platforms](https://docs.adyen.com/platforms/processing-payments#providing-split-information) + or [Issuing](https://docs.adyen.com/issuing/manage-funds#split). items: $ref: '#/components/schemas/Split' type: array store: x-addedInVersion: '23' description: The ecommerce or point-of-sale store that is processing the - payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) + payment. Used in [partner arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -5200,7 +5154,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5566,12 +5520,36 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - description: 'The Merchant Advice Code (MAC) can be returned by Mastercard - issuers for refused payments. If present, the MAC contains information - about why the payment failed, and whether it can be retried. + description: 'A code and message that issuers send to provide more details + about the payment. This field is especially useful when implementing a + retry logic for declined payments. - For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' + Possible values: + + + * **01: New account information available** + + + * **02: Cannot approve at this time, try again later** + + + * **03: Do not try again** + + + * **04: Token requirements not fulfilled for this token type** + + + * **21: Payment Cancellation** (only for Mastercard) + + + ' + enum: + - '01: New account information available' + - '02: Cannot approve at this time, try again later' + - '03: Do not try again' + - '04: Token requirements not fulfilled for this token type' + - '21: Payment Cancellation' type: string merchantReference: description: The reference provided for the transaction. @@ -5882,9 +5860,9 @@ components: x-addedInVersion: '46' additionalProperties: type: string - description: Contains additional information about the payment. Some data - fields are included only if you select them first. Go to **Customer Area** - > **Developers** > **Additional data**. + description: 'Contains additional information about the payment. Some data + fields are included only if you select them first: Go to **Customer Area** + > **Account** > **API URLs**.' type: object errorCode: description: The error code mapped to the error message. @@ -6033,7 +6011,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6702,7 +6680,7 @@ components: x-addedInVersion: '37' description: An array of objects specifying how the amount should be split between accounts when using Adyen for Platforms. For details, refer to - [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array diff --git a/yaml/RecurringService-v25.yaml b/yaml/RecurringService-v25.yaml index f2509a8..8888178 100644 --- a/yaml/RecurringService-v25.yaml +++ b/yaml/RecurringService-v25.yaml @@ -5,26 +5,51 @@ info: version: '25' x-publicVersion: true title: Adyen Recurring API - description: "The Recurring APIs allow you to manage and remove your tokens or saved\ - \ payment details. Tokens should be created with validation during a payment request.\n\ - \nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n\ - ## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Recurring/v25/disable\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v25/disable\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'The Recurring APIs allow you to manage and remove your tokens or saved + payment details. Tokens should be created with validation during a payment request. + + + For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). + + ## Authentication + + To connect to the Recurring API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Recurring/v25/disable + + ```' + x-timestamp: '2022-07-19T19:18:39Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/RecurringService-v30.yaml b/yaml/RecurringService-v30.yaml index 52d05ab..92e4570 100644 --- a/yaml/RecurringService-v30.yaml +++ b/yaml/RecurringService-v30.yaml @@ -5,26 +5,51 @@ info: version: '30' x-publicVersion: true title: Adyen Recurring API - description: "The Recurring APIs allow you to manage and remove your tokens or saved\ - \ payment details. Tokens should be created with validation during a payment request.\n\ - \nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n\ - ## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Recurring/v30/disable\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v30/disable\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'The Recurring APIs allow you to manage and remove your tokens or saved + payment details. Tokens should be created with validation during a payment request. + + + For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). + + ## Authentication + + To connect to the Recurring API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Recurring/v30/disable + + ```' + x-timestamp: '2022-07-19T19:18:39Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team diff --git a/yaml/RecurringService-v40.yaml b/yaml/RecurringService-v40.yaml index 546a4f4..0adcd41 100644 --- a/yaml/RecurringService-v40.yaml +++ b/yaml/RecurringService-v40.yaml @@ -5,26 +5,51 @@ info: version: '40' x-publicVersion: true title: Adyen Recurring API - description: "The Recurring APIs allow you to manage and remove your tokens or saved\ - \ payment details. Tokens should be created with validation during a payment request.\n\ - \nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n\ - ## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Recurring/v40/disable\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v40/disable\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'The Recurring APIs allow you to manage and remove your tokens or saved + payment details. Tokens should be created with validation during a payment request. + + + For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). + + ## Authentication + + To connect to the Recurring API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Recurring/v40/disable + + ```' + x-timestamp: '2022-07-19T19:18:39Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -35,62 +60,6 @@ x-groups: tags: - name: General paths: - /createPermit: - post: - tags: - - General - summary: Create new permits linked to a recurring contract. - description: Create permits for a recurring contract, including support for - defining restrictions. - x-addedInVersion: '40' - operationId: post-createPermit - x-groupName: General - x-sortIndex: 0 - security: - - BasicAuth: [] - - ApiKeyAuth: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePermitRequest' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePermitResult' - description: OK - the request has succeeded. - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Bad Request - a problem reading or understanding the request. - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unauthorized - authentication required. - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Forbidden - insufficient permissions to process the request. - '422': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unprocessable Entity - a request validation error. - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Internal Server Error - the server could not process the request. /disable: post: tags: @@ -515,40 +484,6 @@ components: - expiryMonth - expiryYear - holderName - CreatePermitRequest: - properties: - merchantAccount: - description: The merchant account identifier, with which you want to process - the transaction. - type: string - permits: - description: The permits to create for this recurring contract. - items: - $ref: '#/components/schemas/Permit' - type: array - recurringDetailReference: - description: The recurring contract the new permits will use. - type: string - shopperReference: - description: The shopper's reference to uniquely identify this shopper (e.g. - user ID or account ID). - type: string - required: - - merchantAccount - - shopperReference - - recurringDetailReference - - permits - CreatePermitResult: - properties: - permitResultList: - description: List of new permits. - items: - $ref: '#/components/schemas/PermitResult' - type: array - pspReference: - description: A unique reference associated with the request. This value - is globally unique; quote it when communicating with us about this request. - type: string DisableRequest: properties: contract: @@ -674,51 +609,6 @@ components: description: This is the recurringDetailReference returned in the response when token was created type: string - Permit: - properties: - partnerId: - description: Partner ID (when using the permit-per-partner token sharing - model). - type: string - profileReference: - description: The profile to apply to this permit (when using the shared - permits model). - type: string - restriction: - description: Permit level restriction overrides. - $ref: '#/components/schemas/PermitRestriction' - resultKey: - description: The key to link permit requests to permit results. - type: string - validTillDate: - description: The expiry date for this permit. - format: date-time - type: string - PermitRestriction: - properties: - maxAmount: - description: The total sum amount of one or more payments made using this - permit may not exceed this amount if set. - $ref: '#/components/schemas/Amount' - singleTransactionLimit: - description: The amount of any single payment using this permit may not - exceed this amount if set. - $ref: '#/components/schemas/Amount' - singleUse: - description: Only a single payment can be made using this permit if set - to true, otherwise multiple payments are allowed. - type: boolean - PermitResult: - properties: - resultKey: - x-addedInVersion: '32' - description: The key to link permit requests to permit results. - type: string - token: - x-addedInVersion: '32' - description: The permit token which is used to make payments by the partner - company. - type: string Recurring: properties: contract: diff --git a/yaml/RecurringService-v49.yaml b/yaml/RecurringService-v49.yaml index e63f513..2615f18 100644 --- a/yaml/RecurringService-v49.yaml +++ b/yaml/RecurringService-v49.yaml @@ -5,26 +5,51 @@ info: version: '49' x-publicVersion: true title: Adyen Recurring API - description: "The Recurring APIs allow you to manage and remove your tokens or saved\ - \ payment details. Tokens should be created with validation during a payment request.\n\ - \nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n\ - ## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Recurring/v49/disable\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v49/disable\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'The Recurring APIs allow you to manage and remove your tokens or saved + payment details. Tokens should be created with validation during a payment request. + + + For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). + + ## Authentication + + To connect to the Recurring API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Recurring/v49/disable + + ```' + x-timestamp: '2022-08-25T17:24:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -35,62 +60,6 @@ x-groups: tags: - name: General paths: - /createPermit: - post: - tags: - - General - summary: Create new permits linked to a recurring contract. - description: Create permits for a recurring contract, including support for - defining restrictions. - x-addedInVersion: '40' - operationId: post-createPermit - x-groupName: General - x-sortIndex: 0 - security: - - BasicAuth: [] - - ApiKeyAuth: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePermitRequest' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePermitResult' - description: OK - the request has succeeded. - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Bad Request - a problem reading or understanding the request. - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unauthorized - authentication required. - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Forbidden - insufficient permissions to process the request. - '422': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unprocessable Entity - a request validation error. - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Internal Server Error - the server could not process the request. /disable: post: tags: @@ -515,40 +484,6 @@ components: - expiryMonth - expiryYear - holderName - CreatePermitRequest: - properties: - merchantAccount: - description: The merchant account identifier, with which you want to process - the transaction. - type: string - permits: - description: The permits to create for this recurring contract. - items: - $ref: '#/components/schemas/Permit' - type: array - recurringDetailReference: - description: The recurring contract the new permits will use. - type: string - shopperReference: - description: The shopper's reference to uniquely identify this shopper (e.g. - user ID or account ID). - type: string - required: - - merchantAccount - - shopperReference - - recurringDetailReference - - permits - CreatePermitResult: - properties: - permitResultList: - description: List of new permits. - items: - $ref: '#/components/schemas/PermitResult' - type: array - pspReference: - description: A unique reference associated with the request. This value - is globally unique; quote it when communicating with us about this request. - type: string DisableRequest: properties: contract: @@ -674,51 +609,6 @@ components: description: This is the recurringDetailReference returned in the response when token was created type: string - Permit: - properties: - partnerId: - description: Partner ID (when using the permit-per-partner token sharing - model). - type: string - profileReference: - description: The profile to apply to this permit (when using the shared - permits model). - type: string - restriction: - description: Permit level restriction overrides. - $ref: '#/components/schemas/PermitRestriction' - resultKey: - description: The key to link permit requests to permit results. - type: string - validTillDate: - description: The expiry date for this permit. - format: date-time - type: string - PermitRestriction: - properties: - maxAmount: - description: The total sum amount of one or more payments made using this - permit may not exceed this amount if set. - $ref: '#/components/schemas/Amount' - singleTransactionLimit: - description: The amount of any single payment using this permit may not - exceed this amount if set. - $ref: '#/components/schemas/Amount' - singleUse: - description: Only a single payment can be made using this permit if set - to true, otherwise multiple payments are allowed. - type: boolean - PermitResult: - properties: - resultKey: - x-addedInVersion: '32' - description: The key to link permit requests to permit results. - type: string - token: - x-addedInVersion: '32' - description: The permit token which is used to make payments by the partner - company. - type: string Recurring: properties: contract: diff --git a/yaml/RecurringService-v67.yaml b/yaml/RecurringService-v67.yaml index 1d0edc7..f4d103d 100644 --- a/yaml/RecurringService-v67.yaml +++ b/yaml/RecurringService-v67.yaml @@ -5,26 +5,51 @@ info: version: '67' x-publicVersion: true title: Adyen Recurring API - description: "The Recurring APIs allow you to manage and remove your tokens or saved\ - \ payment details. Tokens should be created with validation during a payment request.\n\ - \nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n\ - ## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Recurring/v67/disable\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v67/disable\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'The Recurring APIs allow you to manage and remove your tokens or saved + payment details. Tokens should be created with validation during a payment request. + + + For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). + + ## Authentication + + To connect to the Recurring API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Recurring/v67/disable + + ```' + x-timestamp: '2022-08-25T17:24:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -35,62 +60,6 @@ x-groups: tags: - name: General paths: - /createPermit: - post: - tags: - - General - summary: Create new permits linked to a recurring contract. - description: Create permits for a recurring contract, including support for - defining restrictions. - x-addedInVersion: '40' - operationId: post-createPermit - x-groupName: General - x-sortIndex: 0 - security: - - BasicAuth: [] - - ApiKeyAuth: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePermitRequest' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePermitResult' - description: OK - the request has succeeded. - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Bad Request - a problem reading or understanding the request. - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unauthorized - authentication required. - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Forbidden - insufficient permissions to process the request. - '422': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unprocessable Entity - a request validation error. - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Internal Server Error - the server could not process the request. /disable: post: tags: @@ -152,61 +121,6 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. - /disablePermit: - post: - tags: - - General - summary: Disable an existing permit. - description: Disable a permit that was previously linked to a recurringDetailReference. - x-addedInVersion: '61' - operationId: post-disablePermit - x-groupName: General - x-sortIndex: 0 - security: - - BasicAuth: [] - - ApiKeyAuth: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DisablePermitRequest' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DisablePermitResult' - description: OK - the request has succeeded. - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Bad Request - a problem reading or understanding the request. - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unauthorized - authentication required. - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Forbidden - insufficient permissions to process the request. - '422': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unprocessable Entity - a request validation error. - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Internal Server Error - the server could not process the request. /listRecurringDetails: post: tags: @@ -570,61 +484,6 @@ components: - expiryMonth - expiryYear - holderName - CreatePermitRequest: - properties: - merchantAccount: - description: The merchant account identifier, with which you want to process - the transaction. - type: string - permits: - description: The permits to create for this recurring contract. - items: - $ref: '#/components/schemas/Permit' - type: array - recurringDetailReference: - description: The recurring contract the new permits will use. - type: string - shopperReference: - description: The shopper's reference to uniquely identify this shopper (e.g. - user ID or account ID). - type: string - required: - - merchantAccount - - shopperReference - - recurringDetailReference - - permits - CreatePermitResult: - properties: - permitResultList: - description: List of new permits. - items: - $ref: '#/components/schemas/PermitResult' - type: array - pspReference: - description: A unique reference associated with the request. This value - is globally unique; quote it when communicating with us about this request. - type: string - DisablePermitRequest: - properties: - merchantAccount: - description: The merchant account identifier, with which you want to process - the transaction. - type: string - token: - description: The permit token to disable. - type: string - required: - - merchantAccount - - token - DisablePermitResult: - properties: - pspReference: - description: A unique reference associated with the request. This value - is globally unique; quote it when communicating with us about this request. - type: string - status: - description: Status of the disable request. - type: string DisableRequest: properties: contract: @@ -750,51 +609,6 @@ components: description: This is the recurringDetailReference returned in the response when token was created type: string - Permit: - properties: - partnerId: - description: Partner ID (when using the permit-per-partner token sharing - model). - type: string - profileReference: - description: The profile to apply to this permit (when using the shared - permits model). - type: string - restriction: - description: Permit level restriction overrides. - $ref: '#/components/schemas/PermitRestriction' - resultKey: - description: The key to link permit requests to permit results. - type: string - validTillDate: - description: The expiry date for this permit. - format: date-time - type: string - PermitRestriction: - properties: - maxAmount: - description: The total sum amount of one or more payments made using this - permit may not exceed this amount if set. - $ref: '#/components/schemas/Amount' - singleTransactionLimit: - description: The amount of any single payment using this permit may not - exceed this amount if set. - $ref: '#/components/schemas/Amount' - singleUse: - description: Only a single payment can be made using this permit if set - to true, otherwise multiple payments are allowed. - type: boolean - PermitResult: - properties: - resultKey: - x-addedInVersion: '32' - description: The key to link permit requests to permit results. - type: string - token: - x-addedInVersion: '32' - description: The permit token which is used to make payments by the partner - company. - type: string Recurring: properties: contract: diff --git a/yaml/RecurringService-v68.yaml b/yaml/RecurringService-v68.yaml index 07fa3d3..e712bb9 100644 --- a/yaml/RecurringService-v68.yaml +++ b/yaml/RecurringService-v68.yaml @@ -5,26 +5,51 @@ info: version: '68' x-publicVersion: true title: Adyen Recurring API - description: "The Recurring APIs allow you to manage and remove your tokens or saved\ - \ payment details. Tokens should be created with validation during a payment request.\n\ - \nFor more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization).\n\ - ## Authentication\nYou need an [API credential](https://docs.adyen.com/development-resources/api-credentials)\ - \ to authenticate to the API.\n\nIf using an API key, add an `X-API-Key` header\ - \ with the API key as the value, for example:\n\n ```\ncurl\n-H \"Content-Type:\ - \ application/json\" \\\n-H \"X-API-Key: YOUR_API_KEY\" \\\n...\n```\n\nAlternatively,\ - \ you can use the username and password to connect to the API using basic authentication,\ - \ for example:\n\n```\ncurl\n-U \"ws@Company.YOUR_COMPANY_ACCOUNT\":\"YOUR_BASIC_AUTHENTICATION_PASSWORD\"\ - \ \\\n-H \"Content-Type: application/json\" \\\n...\n```\n\n## Versioning\nRecurring\ - \ API supports [versioning](https://docs.adyen.com/development-resources/versioning)\ - \ using 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://pal-test.adyen.com/pal/servlet/Recurring/v68/disable\n\ - ```\n\n## Going live\n\nTo authenticate to the live endpoints, you need an [API\ - \ credential](https://docs.adyen.com/development-resources/api-credentials) from\ - \ your live Customer Area.\n\nThe live endpoint URLs contain a prefix which is\ - \ unique to your company account:\n```\n\nhttps://{PREFIX}-pal-live.adyenpayments.com/pal/servlet/Recurring/v68/disable\n\ - ```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** >\ - \ **API URLs** > **Prefix**." - x-timestamp: '2022-09-26T15:20:41Z' + description: 'The Recurring APIs allow you to manage and remove your tokens or saved + payment details. Tokens should be created with validation during a payment request. + + + For more information, refer to our [Tokenization documentation](https://docs.adyen.com/online-payments/tokenization). + + ## Authentication + + To connect to the Recurring API, you must use your basic authentication credentials. + For this, create your web service user, as described in [How to get the WS user + password](https://docs.adyen.com/development-resources/api-credentials). Then + use its credentials to authenticate your request, for example: + + + ``` + + curl + + -U "ws@Company.YourCompany":"YourWsPassword" \ + + -H "Content-Type: application/json" \ + + ... + + ``` + + Note that when going live, you need to generate new web service user credentials + to access the [live endpoints](https://docs.adyen.com/development-resources/live-endpoints). + + + ## Versioning + + Recurring API supports [versioning](https://docs.adyen.com/development-resources/versioning) + using a version suffix in the endpoint URL. This suffix has the following format: + "vXX", where XX is the version number. + + + For example: + + ``` + + https://pal-test.adyen.com/pal/servlet/Recurring/v68/disable + + ```' + x-timestamp: '2022-08-25T17:24:58Z' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -35,62 +60,6 @@ x-groups: tags: - name: General paths: - /createPermit: - post: - tags: - - General - summary: Create new permits linked to a recurring contract. - description: Create permits for a recurring contract, including support for - defining restrictions. - x-addedInVersion: '40' - operationId: post-createPermit - x-groupName: General - x-sortIndex: 0 - security: - - BasicAuth: [] - - ApiKeyAuth: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePermitRequest' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/CreatePermitResult' - description: OK - the request has succeeded. - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Bad Request - a problem reading or understanding the request. - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unauthorized - authentication required. - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Forbidden - insufficient permissions to process the request. - '422': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unprocessable Entity - a request validation error. - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Internal Server Error - the server could not process the request. /disable: post: tags: @@ -152,61 +121,6 @@ paths: schema: $ref: '#/components/schemas/ServiceError' description: Internal Server Error - the server could not process the request. - /disablePermit: - post: - tags: - - General - summary: Disable an existing permit. - description: Disable a permit that was previously linked to a recurringDetailReference. - x-addedInVersion: '61' - operationId: post-disablePermit - x-groupName: General - x-sortIndex: 0 - security: - - BasicAuth: [] - - ApiKeyAuth: [] - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/DisablePermitRequest' - responses: - '200': - content: - application/json: - schema: - $ref: '#/components/schemas/DisablePermitResult' - description: OK - the request has succeeded. - '400': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Bad Request - a problem reading or understanding the request. - '401': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unauthorized - authentication required. - '403': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Forbidden - insufficient permissions to process the request. - '422': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Unprocessable Entity - a request validation error. - '500': - content: - application/json: - schema: - $ref: '#/components/schemas/ServiceError' - description: Internal Server Error - the server could not process the request. /listRecurringDetails: post: tags: @@ -570,61 +484,6 @@ components: - expiryMonth - expiryYear - holderName - CreatePermitRequest: - properties: - merchantAccount: - description: The merchant account identifier, with which you want to process - the transaction. - type: string - permits: - description: The permits to create for this recurring contract. - items: - $ref: '#/components/schemas/Permit' - type: array - recurringDetailReference: - description: The recurring contract the new permits will use. - type: string - shopperReference: - description: The shopper's reference to uniquely identify this shopper (e.g. - user ID or account ID). - type: string - required: - - merchantAccount - - shopperReference - - recurringDetailReference - - permits - CreatePermitResult: - properties: - permitResultList: - description: List of new permits. - items: - $ref: '#/components/schemas/PermitResult' - type: array - pspReference: - description: A unique reference associated with the request. This value - is globally unique; quote it when communicating with us about this request. - type: string - DisablePermitRequest: - properties: - merchantAccount: - description: The merchant account identifier, with which you want to process - the transaction. - type: string - token: - description: The permit token to disable. - type: string - required: - - merchantAccount - - token - DisablePermitResult: - properties: - pspReference: - description: A unique reference associated with the request. This value - is globally unique; quote it when communicating with us about this request. - type: string - status: - description: Status of the disable request. - type: string DisableRequest: properties: contract: @@ -750,51 +609,6 @@ components: description: This is the recurringDetailReference returned in the response when token was created type: string - Permit: - properties: - partnerId: - description: Partner ID (when using the permit-per-partner token sharing - model). - type: string - profileReference: - description: The profile to apply to this permit (when using the shared - permits model). - type: string - restriction: - description: Permit level restriction overrides. - $ref: '#/components/schemas/PermitRestriction' - resultKey: - description: The key to link permit requests to permit results. - type: string - validTillDate: - description: The expiry date for this permit. - format: date-time - type: string - PermitRestriction: - properties: - maxAmount: - description: The total sum amount of one or more payments made using this - permit may not exceed this amount if set. - $ref: '#/components/schemas/Amount' - singleTransactionLimit: - description: The amount of any single payment using this permit may not - exceed this amount if set. - $ref: '#/components/schemas/Amount' - singleUse: - description: Only a single payment can be made using this permit if set - to true, otherwise multiple payments are allowed. - type: boolean - PermitResult: - properties: - resultKey: - x-addedInVersion: '32' - description: The key to link permit requests to permit results. - type: string - token: - x-addedInVersion: '32' - description: The permit token which is used to make payments by the partner - company. - type: string Recurring: properties: contract: