From 586e99dd4c4ea83c91e0108acd0ab7e720c41b6e Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Tue, 8 Oct 2024 15:46:44 +0200 Subject: [PATCH] spec release --- json/PayoutService-v30.json | 14 ++-- json/PayoutService-v40.json | 14 ++-- json/PayoutService-v50.json | 14 ++-- json/PayoutService-v51.json | 14 ++-- json/PayoutService-v52.json | 14 ++-- json/PayoutService-v64.json | 14 ++-- json/PayoutService-v67.json | 14 ++-- json/PayoutService-v68.json | 14 ++-- yaml/PayoutService-v30.yaml | 125 +++++++++++++++++++++++++++--------- yaml/PayoutService-v40.yaml | 125 +++++++++++++++++++++++++++--------- yaml/PayoutService-v50.yaml | 125 +++++++++++++++++++++++++++--------- yaml/PayoutService-v51.yaml | 125 +++++++++++++++++++++++++++--------- yaml/PayoutService-v52.yaml | 125 +++++++++++++++++++++++++++--------- yaml/PayoutService-v64.yaml | 125 +++++++++++++++++++++++++++--------- yaml/PayoutService-v67.yaml | 125 +++++++++++++++++++++++++++--------- yaml/PayoutService-v68.yaml | 125 +++++++++++++++++++++++++++--------- 16 files changed, 800 insertions(+), 312 deletions(-) diff --git a/json/PayoutService-v30.json b/json/PayoutService-v30.json index 0d96435..ecd6d3d 100644 --- a/json/PayoutService-v30.json +++ b/json/PayoutService-v30.json @@ -9,7 +9,7 @@ "version" : "30", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "> The **Payout API is deprecated** and no longer supports new integrations, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> If you are already integrated with the Payouts API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v30/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v30/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "description" : "> The **Payout API is deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v30/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v30/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -34,7 +34,7 @@ "Reviewing" ], "summary" : "Confirm a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v40.json b/json/PayoutService-v40.json index baef0f7..234026d 100644 --- a/json/PayoutService-v40.json +++ b/json/PayoutService-v40.json @@ -9,7 +9,7 @@ "version" : "40", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "> The **Payout API is deprecated** and no longer supports new integrations, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> If you are already integrated with the Payouts API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v40/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v40/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "description" : "> The **Payout API is deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v40/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v40/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -34,7 +34,7 @@ "Reviewing" ], "summary" : "Confirm a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v50.json b/json/PayoutService-v50.json index e8b3dd8..f2aa2fa 100644 --- a/json/PayoutService-v50.json +++ b/json/PayoutService-v50.json @@ -9,7 +9,7 @@ "version" : "50", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "> The **Payout API is deprecated** and no longer supports new integrations, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> If you are already integrated with the Payouts API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v50/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v50/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "description" : "> The **Payout API is deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v50/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v50/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -34,7 +34,7 @@ "Reviewing" ], "summary" : "Confirm a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v51.json b/json/PayoutService-v51.json index 863bc33..c2f7fb5 100644 --- a/json/PayoutService-v51.json +++ b/json/PayoutService-v51.json @@ -9,7 +9,7 @@ "version" : "51", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "> The **Payout API is deprecated** and no longer supports new integrations, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> If you are already integrated with the Payouts API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v51/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v51/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "description" : "> The **Payout API is deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v51/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v51/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -34,7 +34,7 @@ "Reviewing" ], "summary" : "Confirm a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v52.json b/json/PayoutService-v52.json index 2fbcc0f..954299c 100644 --- a/json/PayoutService-v52.json +++ b/json/PayoutService-v52.json @@ -9,7 +9,7 @@ "version" : "52", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "> The **Payout API is deprecated** and no longer supports new integrations, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> If you are already integrated with the Payouts API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v52/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v52/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "description" : "> The **Payout API is deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v52/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v52/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -34,7 +34,7 @@ "Reviewing" ], "summary" : "Confirm a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v64.json b/json/PayoutService-v64.json index 8656d5a..07a8cce 100644 --- a/json/PayoutService-v64.json +++ b/json/PayoutService-v64.json @@ -9,7 +9,7 @@ "version" : "64", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "> The **Payout API is deprecated** and no longer supports new integrations, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> If you are already integrated with the Payouts API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v64/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v64/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "description" : "> The **Payout API is deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v64/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v64/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -34,7 +34,7 @@ "Reviewing" ], "summary" : "Confirm a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v67.json b/json/PayoutService-v67.json index ca18d27..123d585 100644 --- a/json/PayoutService-v67.json +++ b/json/PayoutService-v67.json @@ -9,7 +9,7 @@ "version" : "67", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "> The **Payout API is deprecated** and no longer supports new integrations, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> If you are already integrated with the Payouts API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v67/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v67/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "description" : "> The **Payout API is deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v67/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v67/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -34,7 +34,7 @@ "Reviewing" ], "summary" : "Confirm a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v68.json b/json/PayoutService-v68.json index 69abe0c..807d59c 100644 --- a/json/PayoutService-v68.json +++ b/json/PayoutService-v68.json @@ -9,7 +9,7 @@ "version" : "68", "x-publicVersion" : true, "title" : "Adyen Payout API", - "description" : "> The **Payout API is deprecated** and no longer supports new integrations, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> If you are already integrated with the Payouts API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v68/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v68/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", + "description" : "> The **Payout API is deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nA set of API endpoints that allow you to store payout details, confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets): one for storing payout details and submitting payouts, and another one for confirming or declining payouts. If you don't have the required API credentials, contact our [Support Team](https://www.adyen.help/hc/en-us/requests/new).\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](https://docs.adyen.com/development-resources/api-credentials#basic-authentication).\n\nThe following example shows how to authenticate your request with basic authentication when submitting a payout:\n\n```\ncurl\n-U \"storePayout@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/Payout/v68/payout\n```\n\n## Going live\n\nTo authenticate to the live endpoints, you need [API credentials](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/Payout/v68/payout\n```\n\nGet your `{PREFIX}` from your live Customer Area under **Developers** > **API URLs** > **Prefix**.", "termsOfService" : "https://www.adyen.com/legal/terms-and-conditions", "contact" : { "name" : "Adyen Developer Experience team", @@ -34,7 +34,7 @@ "Reviewing" ], "summary" : "Confirm a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nConfirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nCancels a previously submitted payout.\n\nTo confirm and send a payout, use the `/confirmThirdParty` endpoint.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nWith this call, you can pay out to your customers, and funds will be made available within 30 minutes on the cardholder's bank account (this is dependent on whether the issuer supports this functionality). Instant card payouts are only supported for Visa and Mastercard cards.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nStores payment details under the `PAYOUT` recurring contract. These payment details can be used later to submit a payout via the `/submitThirdParty` call.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout and stores its details for subsequent payouts.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "> This endpoint is **deprecated** and no longer supports new integrations. If you are:\n>- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - Already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", + "description" : "> This endpoint is **deprecated** and no longer supports new integrations. Do one of the following:\n>- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead.\n> - If you are already using the Payout API, reach out to your Adyen contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout use cases with a single API.\n> - Use new payout functionalities, such as instant payouts to bank accounts.\n> - Receive webhooks with more details and defined transfer states.\n>\n> For more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation.\n\n\nSubmits a payout using the previously stored payment details. To store payment details, use the `/storeDetail` API call.\n\nThe submitted payout must be confirmed or declined either by a reviewer or via `/confirmThirdParty` or `/declineThirdParty` calls.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/yaml/PayoutService-v30.yaml b/yaml/PayoutService-v30.yaml index f0a74ad..39dde99 100644 --- a/yaml/PayoutService-v30.yaml +++ b/yaml/PayoutService-v30.yaml @@ -5,14 +5,15 @@ info: version: '30' x-publicVersion: true title: Adyen Payout API - description: "> The **Payout API is deprecated** and no longer supports new integrations,\ - \ use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)\ - \ instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout\ - \ use cases with a single API.\n> - Use new payout functionalities, such as instant\ - \ payouts.\n> - Receive webhooks with more details and defined transfer states.\n\ - >\n> If you are already integrated with the Payouts API, reach out to your Adyen\ - \ contact to learn how to migrate to the Transfers API.\n>\n> For more information\ - \ about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ + description: "> The **Payout API is deprecated** and no longer supports new integrations.\ + \ Do one of the following:\n>- If you are building a new integration, use the\ + \ [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview)\ + \ instead.\n> - If you are already using the Payout API, reach out to your Adyen\ + \ contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers\ + \ API, you can:\n> - Handle multiple payout use cases with a single API.\n> -\ + \ Use new payout functionalities, such as instant payouts to bank accounts.\n\ + > - Receive webhooks with more details and defined transfer states.\n>\n> For\ + \ more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ \ documentation.\n\n\nA set of API endpoints that allow you to store payout details,\ \ confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n\ ## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets):\ @@ -49,13 +50,23 @@ paths: - Reviewing summary: Confirm a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -132,13 +143,23 @@ paths: - Reviewing summary: Cancel a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -215,13 +236,23 @@ paths: - Instant payouts summary: Make an instant card payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -297,13 +328,23 @@ paths: - Initialization summary: Store payout details description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -377,13 +418,23 @@ paths: - Initialization summary: Store details and submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -466,13 +517,23 @@ paths: - Initialization summary: Submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > diff --git a/yaml/PayoutService-v40.yaml b/yaml/PayoutService-v40.yaml index c365b35..8267a56 100644 --- a/yaml/PayoutService-v40.yaml +++ b/yaml/PayoutService-v40.yaml @@ -5,14 +5,15 @@ info: version: '40' x-publicVersion: true title: Adyen Payout API - description: "> The **Payout API is deprecated** and no longer supports new integrations,\ - \ use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)\ - \ instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout\ - \ use cases with a single API.\n> - Use new payout functionalities, such as instant\ - \ payouts.\n> - Receive webhooks with more details and defined transfer states.\n\ - >\n> If you are already integrated with the Payouts API, reach out to your Adyen\ - \ contact to learn how to migrate to the Transfers API.\n>\n> For more information\ - \ about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ + description: "> The **Payout API is deprecated** and no longer supports new integrations.\ + \ Do one of the following:\n>- If you are building a new integration, use the\ + \ [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview)\ + \ instead.\n> - If you are already using the Payout API, reach out to your Adyen\ + \ contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers\ + \ API, you can:\n> - Handle multiple payout use cases with a single API.\n> -\ + \ Use new payout functionalities, such as instant payouts to bank accounts.\n\ + > - Receive webhooks with more details and defined transfer states.\n>\n> For\ + \ more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ \ documentation.\n\n\nA set of API endpoints that allow you to store payout details,\ \ confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n\ ## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets):\ @@ -49,13 +50,23 @@ paths: - Reviewing summary: Confirm a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -132,13 +143,23 @@ paths: - Reviewing summary: Cancel a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -215,13 +236,23 @@ paths: - Instant payouts summary: Make an instant card payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -297,13 +328,23 @@ paths: - Initialization summary: Store payout details description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -377,13 +418,23 @@ paths: - Initialization summary: Store details and submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -466,13 +517,23 @@ paths: - Initialization summary: Submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > diff --git a/yaml/PayoutService-v50.yaml b/yaml/PayoutService-v50.yaml index 1479c66..d8c3b48 100644 --- a/yaml/PayoutService-v50.yaml +++ b/yaml/PayoutService-v50.yaml @@ -5,14 +5,15 @@ info: version: '50' x-publicVersion: true title: Adyen Payout API - description: "> The **Payout API is deprecated** and no longer supports new integrations,\ - \ use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)\ - \ instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout\ - \ use cases with a single API.\n> - Use new payout functionalities, such as instant\ - \ payouts.\n> - Receive webhooks with more details and defined transfer states.\n\ - >\n> If you are already integrated with the Payouts API, reach out to your Adyen\ - \ contact to learn how to migrate to the Transfers API.\n>\n> For more information\ - \ about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ + description: "> The **Payout API is deprecated** and no longer supports new integrations.\ + \ Do one of the following:\n>- If you are building a new integration, use the\ + \ [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview)\ + \ instead.\n> - If you are already using the Payout API, reach out to your Adyen\ + \ contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers\ + \ API, you can:\n> - Handle multiple payout use cases with a single API.\n> -\ + \ Use new payout functionalities, such as instant payouts to bank accounts.\n\ + > - Receive webhooks with more details and defined transfer states.\n>\n> For\ + \ more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ \ documentation.\n\n\nA set of API endpoints that allow you to store payout details,\ \ confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n\ ## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets):\ @@ -49,13 +50,23 @@ paths: - Reviewing summary: Confirm a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -132,13 +143,23 @@ paths: - Reviewing summary: Cancel a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -215,13 +236,23 @@ paths: - Instant payouts summary: Make an instant card payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -297,13 +328,23 @@ paths: - Initialization summary: Store payout details description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -377,13 +418,23 @@ paths: - Initialization summary: Store details and submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -466,13 +517,23 @@ paths: - Initialization summary: Submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > diff --git a/yaml/PayoutService-v51.yaml b/yaml/PayoutService-v51.yaml index 7a6f33d..a367bf8 100644 --- a/yaml/PayoutService-v51.yaml +++ b/yaml/PayoutService-v51.yaml @@ -5,14 +5,15 @@ info: version: '51' x-publicVersion: true title: Adyen Payout API - description: "> The **Payout API is deprecated** and no longer supports new integrations,\ - \ use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)\ - \ instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout\ - \ use cases with a single API.\n> - Use new payout functionalities, such as instant\ - \ payouts.\n> - Receive webhooks with more details and defined transfer states.\n\ - >\n> If you are already integrated with the Payouts API, reach out to your Adyen\ - \ contact to learn how to migrate to the Transfers API.\n>\n> For more information\ - \ about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ + description: "> The **Payout API is deprecated** and no longer supports new integrations.\ + \ Do one of the following:\n>- If you are building a new integration, use the\ + \ [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview)\ + \ instead.\n> - If you are already using the Payout API, reach out to your Adyen\ + \ contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers\ + \ API, you can:\n> - Handle multiple payout use cases with a single API.\n> -\ + \ Use new payout functionalities, such as instant payouts to bank accounts.\n\ + > - Receive webhooks with more details and defined transfer states.\n>\n> For\ + \ more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ \ documentation.\n\n\nA set of API endpoints that allow you to store payout details,\ \ confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n\ ## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets):\ @@ -49,13 +50,23 @@ paths: - Reviewing summary: Confirm a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -132,13 +143,23 @@ paths: - Reviewing summary: Cancel a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -215,13 +236,23 @@ paths: - Instant payouts summary: Make an instant card payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -297,13 +328,23 @@ paths: - Initialization summary: Store payout details description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -377,13 +418,23 @@ paths: - Initialization summary: Store details and submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -466,13 +517,23 @@ paths: - Initialization summary: Submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > diff --git a/yaml/PayoutService-v52.yaml b/yaml/PayoutService-v52.yaml index eb7c53d..04cad3c 100644 --- a/yaml/PayoutService-v52.yaml +++ b/yaml/PayoutService-v52.yaml @@ -5,14 +5,15 @@ info: version: '52' x-publicVersion: true title: Adyen Payout API - description: "> The **Payout API is deprecated** and no longer supports new integrations,\ - \ use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)\ - \ instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout\ - \ use cases with a single API.\n> - Use new payout functionalities, such as instant\ - \ payouts.\n> - Receive webhooks with more details and defined transfer states.\n\ - >\n> If you are already integrated with the Payouts API, reach out to your Adyen\ - \ contact to learn how to migrate to the Transfers API.\n>\n> For more information\ - \ about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ + description: "> The **Payout API is deprecated** and no longer supports new integrations.\ + \ Do one of the following:\n>- If you are building a new integration, use the\ + \ [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview)\ + \ instead.\n> - If you are already using the Payout API, reach out to your Adyen\ + \ contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers\ + \ API, you can:\n> - Handle multiple payout use cases with a single API.\n> -\ + \ Use new payout functionalities, such as instant payouts to bank accounts.\n\ + > - Receive webhooks with more details and defined transfer states.\n>\n> For\ + \ more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ \ documentation.\n\n\nA set of API endpoints that allow you to store payout details,\ \ confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n\ ## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets):\ @@ -49,13 +50,23 @@ paths: - Reviewing summary: Confirm a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -132,13 +143,23 @@ paths: - Reviewing summary: Cancel a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -215,13 +236,23 @@ paths: - Instant payouts summary: Make an instant card payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -297,13 +328,23 @@ paths: - Initialization summary: Store payout details description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -377,13 +418,23 @@ paths: - Initialization summary: Store details and submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -466,13 +517,23 @@ paths: - Initialization summary: Submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > diff --git a/yaml/PayoutService-v64.yaml b/yaml/PayoutService-v64.yaml index 554dcb2..f3dcc8c 100644 --- a/yaml/PayoutService-v64.yaml +++ b/yaml/PayoutService-v64.yaml @@ -5,14 +5,15 @@ info: version: '64' x-publicVersion: true title: Adyen Payout API - description: "> The **Payout API is deprecated** and no longer supports new integrations,\ - \ use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)\ - \ instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout\ - \ use cases with a single API.\n> - Use new payout functionalities, such as instant\ - \ payouts.\n> - Receive webhooks with more details and defined transfer states.\n\ - >\n> If you are already integrated with the Payouts API, reach out to your Adyen\ - \ contact to learn how to migrate to the Transfers API.\n>\n> For more information\ - \ about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ + description: "> The **Payout API is deprecated** and no longer supports new integrations.\ + \ Do one of the following:\n>- If you are building a new integration, use the\ + \ [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview)\ + \ instead.\n> - If you are already using the Payout API, reach out to your Adyen\ + \ contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers\ + \ API, you can:\n> - Handle multiple payout use cases with a single API.\n> -\ + \ Use new payout functionalities, such as instant payouts to bank accounts.\n\ + > - Receive webhooks with more details and defined transfer states.\n>\n> For\ + \ more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ \ documentation.\n\n\nA set of API endpoints that allow you to store payout details,\ \ confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n\ ## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets):\ @@ -49,13 +50,23 @@ paths: - Reviewing summary: Confirm a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -132,13 +143,23 @@ paths: - Reviewing summary: Cancel a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -215,13 +236,23 @@ paths: - Instant payouts summary: Make an instant card payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -297,13 +328,23 @@ paths: - Initialization summary: Store payout details description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -377,13 +418,23 @@ paths: - Initialization summary: Store details and submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -466,13 +517,23 @@ paths: - Initialization summary: Submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > diff --git a/yaml/PayoutService-v67.yaml b/yaml/PayoutService-v67.yaml index 19ac2cf..bcd172b 100644 --- a/yaml/PayoutService-v67.yaml +++ b/yaml/PayoutService-v67.yaml @@ -5,14 +5,15 @@ info: version: '67' x-publicVersion: true title: Adyen Payout API - description: "> The **Payout API is deprecated** and no longer supports new integrations,\ - \ use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)\ - \ instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout\ - \ use cases with a single API.\n> - Use new payout functionalities, such as instant\ - \ payouts.\n> - Receive webhooks with more details and defined transfer states.\n\ - >\n> If you are already integrated with the Payouts API, reach out to your Adyen\ - \ contact to learn how to migrate to the Transfers API.\n>\n> For more information\ - \ about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ + description: "> The **Payout API is deprecated** and no longer supports new integrations.\ + \ Do one of the following:\n>- If you are building a new integration, use the\ + \ [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview)\ + \ instead.\n> - If you are already using the Payout API, reach out to your Adyen\ + \ contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers\ + \ API, you can:\n> - Handle multiple payout use cases with a single API.\n> -\ + \ Use new payout functionalities, such as instant payouts to bank accounts.\n\ + > - Receive webhooks with more details and defined transfer states.\n>\n> For\ + \ more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ \ documentation.\n\n\nA set of API endpoints that allow you to store payout details,\ \ confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n\ ## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets):\ @@ -49,13 +50,23 @@ paths: - Reviewing summary: Confirm a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -132,13 +143,23 @@ paths: - Reviewing summary: Cancel a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -215,13 +236,23 @@ paths: - Instant payouts summary: Make an instant card payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -297,13 +328,23 @@ paths: - Initialization summary: Store payout details description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -377,13 +418,23 @@ paths: - Initialization summary: Store details and submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -466,13 +517,23 @@ paths: - Initialization summary: Submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > diff --git a/yaml/PayoutService-v68.yaml b/yaml/PayoutService-v68.yaml index 64c6c51..ee7cf6d 100644 --- a/yaml/PayoutService-v68.yaml +++ b/yaml/PayoutService-v68.yaml @@ -5,14 +5,15 @@ info: version: '68' x-publicVersion: true title: Adyen Payout API - description: "> The **Payout API is deprecated** and no longer supports new integrations,\ - \ use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers)\ - \ instead.\n>\n> With the Transfers API, you can:\n> - Handle multiple payout\ - \ use cases with a single API.\n> - Use new payout functionalities, such as instant\ - \ payouts.\n> - Receive webhooks with more details and defined transfer states.\n\ - >\n> If you are already integrated with the Payouts API, reach out to your Adyen\ - \ contact to learn how to migrate to the Transfers API.\n>\n> For more information\ - \ about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ + description: "> The **Payout API is deprecated** and no longer supports new integrations.\ + \ Do one of the following:\n>- If you are building a new integration, use the\ + \ [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview)\ + \ instead.\n> - If you are already using the Payout API, reach out to your Adyen\ + \ contact to learn how to migrate to the Transfers API.\n>\n> With the Transfers\ + \ API, you can:\n> - Handle multiple payout use cases with a single API.\n> -\ + \ Use new payout functionalities, such as instant payouts to bank accounts.\n\ + > - Receive webhooks with more details and defined transfer states.\n>\n> For\ + \ more information about the payout features of the Transfers API, see our [Payouts](https://docs.adyen.com/payouts/payout-service)\ \ documentation.\n\n\nA set of API endpoints that allow you to store payout details,\ \ confirm, or decline a payout.\n\nFor more information, refer to [Online payouts](https://docs.adyen.com/online-payments/online-payouts).\n\ ## Authentication\nTo use the Payout API, you need to have [two API credentials](https://docs.adyen.com/online-payments/online-payouts#payouts-to-bank-accounts-and-wallets):\ @@ -49,13 +50,23 @@ paths: - Reviewing summary: Confirm a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -132,13 +143,23 @@ paths: - Reviewing summary: Cancel a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -215,13 +236,23 @@ paths: - Instant payouts summary: Make an instant card payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -297,13 +328,23 @@ paths: - Initialization summary: Store payout details description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) + >- If you are building a new integration, use the [Transfers API](https://docs.adyen.com/api-explorer/transfers/latest/overview) instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -377,13 +418,23 @@ paths: - Initialization summary: Store details and submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. > @@ -466,13 +517,23 @@ paths: - Initialization summary: Submit a payout description: '> This endpoint is **deprecated** and no longer supports new integrations. - If you are: + Do one of the following: - >- Building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) + >- If you are building a new integration, use the POST [/transfers](https://docs.adyen.com/api-explorer/transfers/latest/post/transfers) endpoint instead. - > - Already using the Payout API, reach out to your Adyen contact to learn - how to migrate to the Transfers API. + > - If you are already using the Payout API, reach out to your Adyen contact + to learn how to migrate to the Transfers API. + + > + + > With the Transfers API, you can: + + > - Handle multiple payout use cases with a single API. + + > - Use new payout functionalities, such as instant payouts to bank accounts. + + > - Receive webhooks with more details and defined transfer states. >