diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index cd4cea1..f969adc 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\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", + "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", "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/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/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.", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -3331,14 +3331,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index 5375335..12ddeb1 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\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", + "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", "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/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/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.", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -3704,14 +3704,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index b7b5b2a..9d40eab 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\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", + "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", "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/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/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.", "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/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/marketplaces-and-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/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/marketplaces-and-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/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/marketplaces-and-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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4787,14 +4787,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { @@ -5214,7 +5207,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5516,7 +5509,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index 4178829..3294768 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\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", + "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", "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/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/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.", "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/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/marketplaces-and-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/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/marketplaces-and-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/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/marketplaces-and-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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4812,14 +4812,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { @@ -5071,7 +5064,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** > **Account** > **API URLs**.", + "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**.", "type" : "object" }, "errorCode" : { @@ -5252,7 +5245,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5559,7 +5552,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index 3a9763b..7e168bc 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\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", + "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", "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/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/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.", "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/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/marketplaces-and-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/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/marketplaces-and-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/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/marketplaces-and-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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4812,14 +4812,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { @@ -5071,7 +5064,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** > **Account** > **API URLs**.", + "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**.", "type" : "object" }, "errorCode" : { @@ -5252,7 +5245,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5594,7 +5587,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index fcf85b4..5315c8a 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\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", + "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", "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/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/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.", "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/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/marketplaces-and-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/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/marketplaces-and-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/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/marketplaces-and-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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4840,14 +4840,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { @@ -5099,7 +5092,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** > **Account** > **API URLs**.", + "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**.", "type" : "object" }, "errorCode" : { @@ -5280,7 +5273,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5642,7 +5635,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index cf504bf..a03b75f 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\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", + "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", "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/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/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.", "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/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/marketplaces-and-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/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/marketplaces-and-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/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/marketplaces-and-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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5000,14 +5000,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { @@ -5259,7 +5252,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** > **Account** > **API URLs**.", + "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**.", "type" : "object" }, "errorCode" : { @@ -5440,7 +5433,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5830,7 +5823,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index f415166..e14fe14 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\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", + "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", "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/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/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.", "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/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/marketplaces-and-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/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/marketplaces-and-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/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/marketplaces-and-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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "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 arrangement integrations](https://docs.adyen.com/platforms/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 model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5008,14 +5008,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { @@ -5267,7 +5260,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** > **Account** > **API URLs**.", + "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**.", "type" : "object" }, "errorCode" : { @@ -5448,7 +5441,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5838,7 +5831,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index 401548e..351b3c4 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\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", + "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", "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/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/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.", "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/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/marketplaces-and-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/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/marketplaces-and-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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3454,6 +3454,76 @@ "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" : { @@ -3800,6 +3870,16 @@ "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**.", @@ -3931,7 +4011,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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3939,7 +4019,7 @@ }, "store" : { "x-addedInVersion" : "23", - "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.", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4222,7 +4302,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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4230,7 +4310,7 @@ }, "store" : { "x-addedInVersion" : "23", - "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.", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4505,7 +4585,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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4513,7 +4593,7 @@ }, "store" : { "x-addedInVersion" : "23", - "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.", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4777,7 +4857,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5017,14 +5097,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { @@ -5276,7 +5349,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** > **Account** > **API URLs**.", + "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**.", "type" : "object" }, "errorCode" : { @@ -5457,7 +5530,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5847,7 +5920,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v67.json b/json/PaymentService-v67.json index c8052cc..d2442d2 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\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", + "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", "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/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/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.", "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/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/marketplaces-and-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/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/marketplaces-and-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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3454,6 +3454,76 @@ "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" : { @@ -3794,6 +3864,16 @@ "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**.", @@ -3925,7 +4005,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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3933,7 +4013,7 @@ }, "store" : { "x-addedInVersion" : "23", - "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.", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4210,7 +4290,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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4218,7 +4298,7 @@ }, "store" : { "x-addedInVersion" : "23", - "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.", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4487,7 +4567,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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4495,7 +4575,7 @@ }, "store" : { "x-addedInVersion" : "23", - "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.", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4759,7 +4839,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4999,14 +5079,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { @@ -5250,7 +5323,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** > **Account** > **API URLs**.", + "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**.", "type" : "object" }, "errorCode" : { @@ -5431,7 +5504,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5886,7 +5959,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/json/PaymentService-v68.json b/json/PaymentService-v68.json index e61792d..8da9391 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\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", + "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", "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/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/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.", "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/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/marketplaces-and-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/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/marketplaces-and-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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -3588,6 +3588,76 @@ "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" : { @@ -3957,6 +4027,16 @@ "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**.", @@ -4088,7 +4168,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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4096,7 +4176,7 @@ }, "store" : { "x-addedInVersion" : "23", - "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.", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4373,7 +4453,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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4381,7 +4461,7 @@ }, "store" : { "x-addedInVersion" : "23", - "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.", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4650,7 +4730,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/platforms/processing-payments#providing-split-information) or [Issuing](https://docs.adyen.com/issuing/manage-funds#split).", + "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).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -4658,7 +4738,7 @@ }, "store" : { "x-addedInVersion" : "23", - "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.", + "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.", "maxLength" : 16, "minLength" : 1, "type" : "string" @@ -4937,7 +5017,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -5177,14 +5257,7 @@ "type" : "string" }, "merchantAdviceCode" : { - "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" - ], + "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).", "type" : "string" }, "merchantReference" : { @@ -5428,7 +5501,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** > **Account** > **API URLs**.", + "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**.", "type" : "object" }, "errorCode" : { @@ -5609,7 +5682,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, @@ -6267,7 +6340,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/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/marketplaces-and-platforms/processing-payments#providing-split-information).", "items" : { "$ref" : "#/components/schemas/Split" }, diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index 4af34c9..09a713b 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -310,7 +283,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2917,7 +2890,7 @@ components: store: x-addedInVersion: '23' 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) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -3206,7 +3179,7 @@ components: store: x-addedInVersion: '23' 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) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -3788,36 +3761,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 635c7f8..aa10dd1 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -395,7 +368,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -3181,7 +3154,7 @@ components: store: x-addedInVersion: '23' 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) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -3487,7 +3460,7 @@ components: store: x-addedInVersion: '23' 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) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4073,36 +4046,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index fcfed39..a4c630f 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -472,7 +445,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2697,7 +2670,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -2989,7 +2962,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3069,7 +3042,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3855,15 +3828,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4198,15 +4171,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4534,15 +4507,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4797,7 +4770,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5163,36 +5136,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. @@ -5648,7 +5597,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5940,7 +5889,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-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 214d853..f9263ce 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -472,7 +445,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2702,7 +2675,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3004,7 +2977,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3089,7 +3062,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3875,15 +3848,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4218,15 +4191,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4554,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4822,7 +4795,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5188,36 +5161,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. @@ -5535,9 +5484,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** - > **Account** > **API URLs**.' + 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**. type: object errorCode: description: The error code mapped to the error message. @@ -5686,7 +5635,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5983,7 +5932,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-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 41d836a..1095f70 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -472,7 +445,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2702,7 +2675,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3004,7 +2977,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3089,7 +3062,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3875,15 +3848,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4218,15 +4191,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4554,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4822,7 +4795,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5188,36 +5161,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. @@ -5535,9 +5484,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** - > **Account** > **API URLs**.' + 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**. type: object errorCode: description: The error code mapped to the error message. @@ -5686,7 +5635,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6027,7 +5976,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-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 cdebdc9..c732e8a 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -472,7 +445,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2719,7 +2692,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3021,7 +2994,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3106,7 +3079,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3892,15 +3865,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4241,15 +4214,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4583,15 +4556,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4857,7 +4830,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5223,36 +5196,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. @@ -5570,9 +5519,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** - > **Account** > **API URLs**.' + 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**. type: object errorCode: description: The error code mapped to the error message. @@ -5721,7 +5670,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6080,7 +6029,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-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 5d80199..fa2dc3e 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -472,7 +445,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2787,7 +2760,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3109,7 +3082,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3194,7 +3167,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3986,15 +3959,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4341,15 +4314,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4689,15 +4662,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4963,7 +4936,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5329,36 +5302,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. @@ -5676,9 +5625,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** - > **Account** > **API URLs**.' + 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**. type: object errorCode: description: The error code mapped to the error message. @@ -5827,7 +5776,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6207,7 +6156,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-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 82ea6a0..4b0c948 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -472,7 +445,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2787,7 +2760,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3109,7 +3082,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3194,7 +3167,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3994,15 +3967,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4349,15 +4322,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4697,15 +4670,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4971,7 +4944,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5337,36 +5310,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. @@ -5684,9 +5633,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** - > **Account** > **API URLs**.' + 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**. type: object errorCode: description: The error code mapped to the error message. @@ -5835,7 +5784,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6215,7 +6164,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-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 5c423eb..7563199 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -472,7 +445,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2787,7 +2760,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3109,7 +3082,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3194,7 +3167,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3448,6 +3421,71 @@ 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: @@ -3803,6 +3841,14 @@ 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 @@ -4008,15 +4054,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4363,15 +4409,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4711,15 +4757,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4985,7 +5031,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5351,36 +5397,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. @@ -5698,9 +5720,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** - > **Account** > **API URLs**.' + 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**. type: object errorCode: description: The error code mapped to the error message. @@ -5849,7 +5871,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6229,7 +6251,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-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 f7d81b7..f0acaa9 100644 --- a/yaml/PaymentService-v67.yaml +++ b/yaml/PaymentService-v67.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -472,7 +445,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2787,7 +2760,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3109,7 +3082,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3194,7 +3167,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3448,6 +3421,71 @@ 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: @@ -3797,6 +3835,14 @@ 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 @@ -4002,15 +4048,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4351,15 +4397,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4693,15 +4739,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4967,7 +5013,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5333,36 +5379,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. @@ -5673,9 +5695,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** - > **Account** > **API URLs**.' + 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**. type: object errorCode: description: The error code mapped to the error message. @@ -5824,7 +5846,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6291,7 +6313,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-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 77ddb01..c342cc1 100644 --- a/yaml/PaymentService-v68.yaml +++ b/yaml/PaymentService-v68.yaml @@ -5,54 +5,27 @@ 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. - - - 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' + 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' termsOfService: https://www.adyen.com/legal/terms-and-conditions contact: name: Adyen Developer Experience team @@ -472,7 +445,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/platforms/processing-payments#providing-split-information)\ + \ 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\ @@ -2934,7 +2907,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3256,7 +3229,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3341,7 +3314,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -3595,6 +3568,71 @@ 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: @@ -3973,6 +4011,14 @@ 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 @@ -4178,15 +4224,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4527,15 +4573,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -4869,15 +4915,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/platforms/processing-payments#providing-split-information) - or [Issuing](https://docs.adyen.com/issuing/manage-funds#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). 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 arrangement integrations](https://docs.adyen.com/platforms/platforms-for-partners#route-payments) + payment. Used in [partner model integrations](https://docs.adyen.com/marketplaces-and-platforms/classic/platforms-for-partners#route-payments) for Adyen for Platforms. maxLength: 16 minLength: 1 @@ -5154,7 +5200,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -5520,36 +5566,12 @@ components: > Contact Support Team to enable this field.' type: string merchantAdviceCode: - 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. + 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. - 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' + For more information see [Mastercard Merchant Advice Codes](https://docs.adyen.com/development-resources/raw-acquirer-responses#mastercard-merchant-advice-codes).' type: string merchantReference: description: The reference provided for the transaction. @@ -5860,9 +5882,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** - > **Account** > **API URLs**.' + 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**. type: object errorCode: description: The error code mapped to the error message. @@ -6011,7 +6033,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array @@ -6680,7 +6702,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/platforms/processing-payments#providing-split-information). + [Providing split information](https://docs.adyen.com/marketplaces-and-platforms/processing-payments#providing-split-information). items: $ref: '#/components/schemas/Split' type: array