From b2d8c07c73752410b215d840178bd17093b19560 Mon Sep 17 00:00:00 2001 From: Adyen Automation Date: Wed, 25 Sep 2024 11:05:13 +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 +- json/TerminalAPI-v1.json | 293 +++--- yaml/PayoutService-v30.yaml | 131 ++- yaml/PayoutService-v40.yaml | 131 ++- yaml/PayoutService-v50.yaml | 131 ++- yaml/PayoutService-v51.yaml | 131 ++- yaml/PayoutService-v52.yaml | 131 ++- yaml/PayoutService-v64.yaml | 131 ++- yaml/PayoutService-v67.yaml | 131 ++- yaml/PayoutService-v68.yaml | 131 ++- yaml/TerminalAPI-v1.yaml | 1883 ++++++++++++++++++++++++++++++++--- 18 files changed, 2876 insertions(+), 460 deletions(-) diff --git a/json/PayoutService-v30.json b/json/PayoutService-v30.json index 50cbb98..0d96435 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" : "A 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, 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**.", "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" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "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.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "Cancels 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "With 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. 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.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "Stores 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. 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.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v40.json b/json/PayoutService-v40.json index 196f9c1..baef0f7 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" : "A 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, 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**.", "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" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "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.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "Cancels 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "With 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. 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.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "Stores 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. 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.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v50.json b/json/PayoutService-v50.json index d93355a..e8b3dd8 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" : "A 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, 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**.", "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" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "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.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "Cancels 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "With 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. 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.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "Stores 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. 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.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v51.json b/json/PayoutService-v51.json index f0e8d8e..863bc33 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" : "A 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, 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**.", "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" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "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.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "Cancels 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "With 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. 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.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "Stores 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. 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.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v52.json b/json/PayoutService-v52.json index 61bbae3..2fbcc0f 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" : "A 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, 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**.", "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" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "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.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "Cancels 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "With 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. 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.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "Stores 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. 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.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v64.json b/json/PayoutService-v64.json index 760b276..8656d5a 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" : "A 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, 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**.", "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" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "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.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "Cancels 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "With 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. 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.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "Stores 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. 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.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v67.json b/json/PayoutService-v67.json index 7c90911..ca18d27 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" : "A 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, 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**.", "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" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "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.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "Cancels 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "With 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. 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.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "Stores 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. 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.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/PayoutService-v68.json b/json/PayoutService-v68.json index d0bb63f..69abe0c 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" : "A 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, 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**.", "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" : "Confirms a previously submitted payout.\n\nTo cancel a payout, use the `/declineThirdParty` endpoint.", + "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.", "x-addedInVersion" : "10", "operationId" : "post-confirmThirdParty", "x-sortIndex" : 1, @@ -143,7 +143,7 @@ "Reviewing" ], "summary" : "Cancel a payout", - "description" : "Cancels 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-declineThirdParty", "x-sortIndex" : 2, @@ -252,7 +252,7 @@ "Instant payouts" ], "summary" : "Make an instant card payout", - "description" : "With 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. 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.", "x-addedInVersion" : "11", "operationId" : "post-payout", "x-sortIndex" : 1, @@ -359,7 +359,7 @@ "Initialization" ], "summary" : "Store payout details", - "description" : "Stores 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. 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.", "operationId" : "post-storeDetail", "x-sortIndex" : 2, "x-methodName" : "storeDetail", @@ -467,7 +467,7 @@ "Initialization" ], "summary" : "Store details and submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-storeDetailAndSubmitThirdParty", "x-sortIndex" : 1, @@ -583,7 +583,7 @@ "Initialization" ], "summary" : "Submit a payout", - "description" : "Submits 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. 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.", "x-addedInVersion" : "10", "operationId" : "post-submitThirdParty", "x-sortIndex" : 3, diff --git a/json/TerminalAPI-v1.json b/json/TerminalAPI-v1.json index 654154e..0f48c6f 100644 --- a/json/TerminalAPI-v1.json +++ b/json/TerminalAPI-v1.json @@ -475,6 +475,41 @@ } } }, + "/abort": { + "post": { + "description": "Body of the Abort Request message.\nIt conveys Information requested for identification of the message request carrying the transaction to abort. A message to display on the CustomerError Device could be sent by the Sale System (DisplayOutput).", + "summary": "Abort Request", + "security": [ + { + "BasicAuth": [] + }, + { + "ApiKeyAuth": [] + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AbortRequest" + } + } + } + }, + "responses": { + "200": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/AbortResponse" + } + } + }, + "description": "A successful `AbortRequest` returns a response with a **200 OK** HTTP status code and no body." + } + } + } + }, "/diagnosis": { "post": { "description": "It conveys Information related to the target POI for which the diagnosis is requested.\nContent of the Diagnosis Request message.", @@ -655,7 +690,7 @@ "schemas": { "TerminalEnvironment": { "type": "string", - "description": "Environment of the Terminal. Sent in the Login Request (Response) to identify the environment of the Sale System (POI System) during the session. Sent in other messages when the data has changed since the Login.", + "description": "Environment of the Terminal. Sent in the Login Request (Response) to identify the environment of the Sale System (POI System) during the session. Sent in other messages when the data has changed since the Login.\nPossible values:\n* **Attended**\n* **SemiAttended**\n* **Unattended**", "enum": [ "Attended", "SemiAttended", @@ -664,7 +699,7 @@ }, "GenericProfile": { "type": "string", - "description": "Functional profile of the Sale to POI protocol. Sent in the Login Request to identify the messages that might be requested or received by the Sale Terminal during the session. Sent in the Login Response to identify the messages that might be processed or sent by the POI Terminal during the session.", + "description": "Functional profile of the Sale to POI protocol. Sent in the Login Request to identify the messages that might be requested or received by the Sale Terminal during the session. Sent in the Login Response to identify the messages that might be processed or sent by the POI Terminal during the session.\nPossible values:\n* **Basic**\n* **Extended**\n* **Standard**", "enum": [ "Basic", "Extended", @@ -673,7 +708,7 @@ }, "ServiceProfiles": { "type": "array", - "description": "Service profiles of the Sale to POI protocol. Sent in the Login Request to identify the specific services that might be requested by the Sale Terminal during the session. Sent in the Login Response to identify the specific services that might be processed by the POI Terminal during the session.", + "description": "Service profiles of the Sale to POI protocol. Sent in the Login Request to identify the specific services that might be requested by the Sale Terminal during the session. Sent in the Login Response to identify the specific services that might be processed by the POI Terminal during the session.\nPossible values:\n* **Batch**\n* **CardReader**\n* **Communication**\n* **Loyalty**\n* **OneTimeRes**\n* **PIN**\n* **Reservation**\n* **Sound**\n* **StoredValue**\n* **Synchro**", "items": { "type": "string", "enum": [ @@ -692,7 +727,7 @@ }, "SaleCapabilities": { "type": "array", - "description": "place holder!", + "description": "place holder!\nPossible values:\n* **CashierDisplay**\n* **CashierError**\n* **CashierInput**\n* **CashierStatus**\n* **CustomerAssistance**\n* **CustomerDisplay**\n* **CustomerError**\n* **CustomerInput**\n* **EMVContactless**\n* **ICC**\n* **MagStripe**\n* **POIReplication**\n* **PrinterDocument**\n* **PrinterReceipt**\n* **PrinterVoucher**", "items": { "type": "string", "enum": [ @@ -716,7 +751,7 @@ }, "TokenRequestedType": { "type": "string", - "description": "Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period.", + "description": "Type of token replacing the PAN of a payment card to identify the payment mean of the customer. It allows, for a merchant, to use a token for a transaction only or for a longer period.\nPossible values:\n* **Customer**\n* **Transaction**", "enum": [ "Customer", "Transaction" @@ -724,7 +759,7 @@ }, "CustomerOrderReq": { "type": "array", - "description": "List of customer order open, closed or both to be sent in the response messages.", + "description": "List of customer order open, closed or both to be sent in the response messages.\nPossible values:\n* **Both**\n* **Closed**\n* **Open**", "items": { "type": "string", "enum": [ @@ -736,7 +771,7 @@ }, "TrackFormat": { "type": "string", - "description": "Magnetic track or magnetic ink characters line.", + "description": "Magnetic track or magnetic ink characters line.\nPossible values:\n* **AAMVA**\n* **ISO**", "enum": [ "AAMVA", "ISO" @@ -802,7 +837,7 @@ }, "PrinterStatus": { "type": "string", - "description": "Indicates if the printer is working and usable.", + "description": "Indicates if the printer is working and usable.\nPossible values:\n* **NoPaper**\n* **OK**\n* **OutOfOrder**\n* **PaperJam**\n* **PaperLow**", "enum": [ "NoPaper", "OK", @@ -813,7 +848,7 @@ }, "POICapabilities": { "type": "array", - "description": "Hardware capabilities of the POI Terminal. They are the POI capabilities the POI System allows the Sale System to use. These POI capabilities include the logical devices enumerated in the devices data element (most of these devices could be on the POI part), plus card reader devices. Sent in the Login Response to identify the devices of the POI Terminal which can be used by the Sale System during the session.", + "description": "Hardware capabilities of the POI Terminal. They are the POI capabilities the POI System allows the Sale System to use. These POI capabilities include the logical devices enumerated in the devices data element (most of these devices could be on the POI part), plus card reader devices. Sent in the Login Response to identify the devices of the POI Terminal which can be used by the Sale System during the session.\nPossible values:\n* **CashHandling**\n* **CashierDisplay**\n* **CashierError**\n* **CashierInput**\n* **CustomerDisplay**\n* **CustomerError**\n* **CustomerInput**\n* **EMVContactless**\n* **ICC**\n* **MagStripe**\n* **PrinterDocument**\n* **PrinterReceipt**\n* **PrinterVoucher**", "items": { "type": "string", "enum": [ @@ -859,7 +894,7 @@ }, "OutputFormat": { "type": "string", - "description": "Format of the content to display or print. Display or print device function.", + "description": "Format of the content to display or print. Display or print device function.\nPossible values:\n* **BarCode**\n* **MessageRef**\n* **Text**\n* **XHTML**", "enum": [ "BarCode", "MessageRef", @@ -915,7 +950,7 @@ }, "BarcodeType": { "type": "string", - "description": "Type of Barcode coding. Qualification of the barcode value to display or print.", + "description": "Type of Barcode coding. Qualification of the barcode value to display or print.\nPossible values:\n* **Code128**\n* **Code25**\n* **EAN13**\n* **EAN8**\n* **PDF417**\n* **QRCode**\n* **UPCA**", "enum": [ "Code128", "Code25", @@ -928,7 +963,7 @@ }, "MenuEntryTag": { "type": "string", - "description": "Characteristics related to the selection of a menu entry.", + "description": "Characteristics related to the selection of a menu entry.\nPossible values:\n* **NonSelectable**\n* **NonSelectableSubMenu**\n* **Selectable**\n* **SubMenu**", "enum": [ "NonSelectable", "NonSelectableSubMenu", @@ -938,7 +973,7 @@ }, "TransactionAction": { "type": "string", - "description": "Action to realise on a transaction. In an `EnableService` request message:\n - Starts a transaction by a swipe-ahead mechanism, with the services which are enabled.\n - Aborts a swipe-ahead transaction or started by a `CardAcquisition`, and not followed by a service request from the Sale System to complete the transaction.", + "description": "Action to realise on a transaction. In an `EnableService` request message:\n - Starts a transaction by a swipe-ahead mechanism, with the services which are enabled.\n - Aborts a swipe-ahead transaction or started by a `CardAcquisition`, and not followed by a service request from the Sale System to complete the transaction.\nPossible values:\n* **AbortTransaction**\n* **StartTransaction**", "enum": [ "AbortTransaction", "StartTransaction" @@ -946,7 +981,7 @@ }, "ServicesEnabled": { "type": "array", - "description": "Services which are enabled before the start-up of a transaction.\nMandatory if `TransactionAction` is `StartTransaction`, absent if not.", + "description": "Services which are enabled before the start-up of a transaction.\nMandatory if `TransactionAction` is `StartTransaction`, absent if not.\nPossible values:\n* **CardAcquisition**\n* **Loyalty**\n* **Payment**", "items": { "type": "string", "enum": [ @@ -1041,7 +1076,7 @@ }, "IdentificationSupport": { "type": "string", - "description": "Support of the loyalty account identification. Allows knowing where and how you have found the loyalty account identification.", + "description": "Support of the loyalty account identification. Allows knowing where and how you have found the loyalty account identification.\nPossible values:\n* **HybridCard**\n* **LinkedCard**\n* **LoyaltyCard**\n* **NoCard**", "enum": [ "HybridCard", "LinkedCard", @@ -1051,7 +1086,7 @@ }, "InstalmentType": { "type": "string", - "description": "Type of instalment transaction. For requesting an instalment payment transaction.", + "description": "Type of instalment transaction. For requesting an instalment payment transaction.\nPossible values:\n* **DeferredInstalments**\n* **EqualInstalments**\n* **InequalInstalments**", "enum": [ "DeferredInstalments", "EqualInstalments", @@ -1060,7 +1095,7 @@ }, "PeriodUnit": { "type": "string", - "description": "Type of instalment transaction.", + "description": "Type of instalment transaction.\nPossible values:\n* **Annual**\n* **Daily**\n* **Monthly**\n* **Weekly**", "enum": [ "Annual", "Daily", @@ -1110,7 +1145,7 @@ }, "AuthenticationMethod": { "type": "array", - "description": "Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction.", + "description": "Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction.\nPossible values:\n* **Bypass**\n* **ManualVerification**\n* **MerchantAuthentication**\n* **OfflinePIN**\n* **OnlinePIN**\n* **PaperSignature**\n* **SecureCertificate**\n* **SecureNoCertificate**\n* **SecuredChannel**\n* **SignatureCapture**\n* **UnknownMethod**", "items": { "type": "string", "enum": [ @@ -1130,7 +1165,7 @@ }, "LoyaltyTransactionType": { "type": "string", - "description": "Type of loyalty transaction. These types of loyalty transactions use the same message requests:\n * **Award**: direct or payment-related award on a loyalty account.\n * **Rebate**: rebate on a total amount, sale item amount, or sale items.\n * **Redemption**: redemption on a loyalty account.\n * **AwardRefund**: refund of a loyalty award transaction.\n * **RebateRefund**: refund of a loyalty rebate transaction.\n * **RedemptionRefund**: refund of a loyalty redemption transaction.", + "description": "Type of loyalty transaction. These types of loyalty transactions use the same message requests:\n * **Award**: direct or payment-related award on a loyalty account.\n * **Rebate**: rebate on a total amount, sale item amount, or sale items.\n * **Redemption**: redemption on a loyalty account.\n * **AwardRefund**: refund of a loyalty award transaction.\n * **RebateRefund**: refund of a loyalty rebate transaction.\n * **RedemptionRefund**: refund of a loyalty redemption transaction.\nPossible values:\n* **Award**\n* **AwardRefund**\n* **Rebate**\n* **RebateRefund**\n* **Redemption**\n* **RedemptionRefund**", "enum": [ "Award", "AwardRefund", @@ -1153,7 +1188,7 @@ }, "ReversalReason": { "type": "string", - "description": "Reason of the payment or loyalty reversal..", + "description": "Reason of the payment or loyalty reversal..\nPossible values:\n* **CustCancel**\n* **Malfunction**\n* **MerchantCancel**\n* **Unable2Compl**", "enum": [ "CustCancel", "Malfunction", @@ -1196,7 +1231,7 @@ }, "TotalDetails": { "type": "array", - "description": "Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation.\nRequired to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID).", + "description": "Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation.\nRequired to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID).\nPossible values:\n* **OperatorID**\n* **POIID**\n* **SaleID**\n* **ShiftNumber**\n* **TotalsGroupID**", "items": { "type": "string", "enum": [ @@ -1210,7 +1245,7 @@ }, "AccountType": { "type": "string", - "description": "Type of cardholder account used for the transaction. Allows a cardholder to select the type of account used for the transaction.", + "description": "Type of cardholder account used for the transaction. Allows a cardholder to select the type of account used for the transaction.\nPossible values:\n* **CardTotals**\n* **Checking**\n* **CreditCard**\n* **Default**\n* **EpurseCard**\n* **Investment**\n* **Savings**\n* **Universal**", "enum": [ "CardTotals", "Checking", @@ -1267,7 +1302,7 @@ }, "EventToNotify": { "type": "string", - "description": "Event the POI notifies to the Sale System.", + "description": "Event the POI notifies to the Sale System.\nPossible values:\n* **Abort**\n* **BeginMaintenance**\n* **CardInserted**\n* **CardRemoved**\n* **Completed**\n* **CustomerLanguage**\n* **EndMaintenance**\n* **Initialised**\n* **KeyPressed**\n* **OutOfOrder**\n* **Reject**\n* **SaleAdmin**\n* **SaleWakeUp**\n* **SecurityAlarm**\n* **Shutdown**\n* **StopAssistance**\n* **UseAnotherCardForPreauth**", "enum": [ "Abort", "BeginMaintenance", @@ -1338,7 +1373,7 @@ }, "PINRequestType": { "type": "string", - "description": "Type of PIN Service.", + "description": "Type of PIN Service.\nPossible values:\n* **PINEnter**\n* **PINVerify**\n* **PINVerifyOnly**", "enum": [ "PINEnter", "PINVerify", @@ -1369,7 +1404,7 @@ }, "TrackFormat": { "$ref": "#/components/schemas/TrackFormat", - "description": "Card track format." + "description": "Card track format.\nPossible values:\n* **AAMVA**\n* **ISO**" }, "TrackValue": { "type": "string", @@ -1418,7 +1453,7 @@ "properties": { "TokenRequestedType": { "$ref": "#/components/schemas/TokenRequestedType", - "description": "Type of token replacing the PAN of a payment card to identify the payment\n mean of the customer. It allows, for a merchant, to use a token for a transaction\n only or for a longer period." + "description": "Type of token replacing the PAN of a payment card to identify the payment\n mean of the customer. It allows, for a merchant, to use a token for a transaction\n only or for a longer period.\nPossible values:\n* **Customer**\n* **Transaction**" }, "TokenValue": { "type": "string", @@ -1550,7 +1585,7 @@ }, "EntryMode": { "$ref": "#/components/schemas/EntryMode", - "description": "Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument." + "description": "Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument.\nPossible values:\n* **Contactless**\n* **File**\n* **ICC**\n* **Keyed**\n* **MagStripe**\n* **Manual**\n* **Mobile**\n* **RFID**\n* **Scanned**\n* **SynchronousICC**\n* **Tapped**" }, "CardCountryCode": { "type": "integer", @@ -1661,7 +1696,7 @@ }, "TokenRequestedType": { "$ref": "#/components/schemas/TokenRequestedType", - "description": "Type of token replacing the PAN of a payment card to identify the payment\n mean of the customer. It allows, for a merchant, to use a token for a transaction\n only or for a longer period." + "description": "Type of token replacing the PAN of a payment card to identify the payment\n mean of the customer. It allows, for a merchant, to use a token for a transaction\n only or for a longer period.\nPossible values:\n* **Customer**\n* **Transaction**" }, "CustomerOrderID": { "type": "string", @@ -1670,7 +1705,7 @@ }, "CustomerOrderReq": { "$ref": "#/components/schemas/CustomerOrderReq", - "description": "List of customer order open, closed or both to be sent in the response messages." + "description": "List of customer order open, closed or both to be sent in the response messages.\nPossible values:\n* **Both**\n* **Closed**\n* **Open**" }, "SaleToPOIData": { "type": "string", @@ -1793,7 +1828,7 @@ "properties": { "GlobalStatus": { "$ref": "#/components/schemas/GlobalStatus", - "description": "Global status of a POI Server or POI Terminal." + "description": "Global status of a POI Server or POI Terminal.\nPossible values:\n* **Busy**\n* **Maintenance**\n* **OK**\n* **Unreachable**" }, "SecurityOKFlag": { "type": "boolean", @@ -1808,7 +1843,8 @@ "description": "Indicates if the card readers are working and usable.\nIf card reader device present." }, "PrinterStatus": { - "$ref": "#/components/schemas/PrinterStatus" + "$ref": "#/components/schemas/PrinterStatus", + "description": "Possible values:\n* **NoPaper**\n* **OK**\n* **OutOfOrder**\n* **PaperJam**\n* **PaperLow**" }, "CommunicationOKFlag": { "type": "boolean", @@ -1836,11 +1872,11 @@ "properties": { "Result": { "$ref": "#/components/schemas/Result", - "description": "Result of the processing of the message." + "description": "Result of the processing of the message.\nPossible values:\n* **Failure**\n* **Partial**\n* **Success**" }, "ErrorCondition": { "$ref": "#/components/schemas/ErrorCondition", - "description": "Condition that has produced an error on the processing of a message request.\nReturned if Result is not Success." + "description": "Condition that has produced an error on the processing of a message request.\nReturned if Result is not Success.\nPossible values:\n* **Aborted**\n* **Busy**\n* **Cancel**\n* **DeviceOut**\n* **InProgress**\n* **InsertedCard**\n* **InvalidCard**\n* **LoggedOut**\n* **MessageFormat**\n* **NotAllowed**\n* **NotFound**\n* **PaymentRestriction**\n* **Refusal**\n* **UnavailableDevice**\n* **UnavailableService**\n* **UnreachableHost**\n* **WrongPIN**" }, "AdditionalResponse": { "type": "string", @@ -1888,10 +1924,12 @@ "type": "object", "properties": { "GenericProfile": { - "$ref": "#/components/schemas/GenericProfile" + "$ref": "#/components/schemas/GenericProfile", + "description": "Possible values:\n* **Basic**\n* **Extended**\n* **Standard**" }, "ServiceProfiles": { - "$ref": "#/components/schemas/ServiceProfiles" + "$ref": "#/components/schemas/ServiceProfiles", + "description": "Possible values:\n* **Batch**\n* **CardReader**\n* **Communication**\n* **Loyalty**\n* **OneTimeRes**\n* **PIN**\n* **Reservation**\n* **Sound**\n* **StoredValue**\n* **Synchro**" } } }, @@ -1901,11 +1939,11 @@ "properties": { "TerminalEnvironment": { "$ref": "#/components/schemas/TerminalEnvironment", - "description": "Environment of the Terminal. Sent in the Login Request (Response) to identify the environment of the Sale System (POI System) during the session. In other message, when the data has changed since the Login." + "description": "Environment of the Terminal. Sent in the Login Request (Response) to identify the environment of the Sale System (POI System) during the session. In other message, when the data has changed since the Login.\nPossible values:\n* **Attended**\n* **SemiAttended**\n* **Unattended**" }, "POICapabilities": { "$ref": "#/components/schemas/POICapabilities", - "description": "Hardware capabilities of the POI Terminal. They are the POI capabilities the POI System allows the Sale System to use. These POI capabilities include the logical devices enumerated in the devices data element (most of these devices could be on the POI part), plus card reader devices. Sent in the Login Response to identify the devices of the POI Terminal which can be used by the Sale System during the session." + "description": "Hardware capabilities of the POI Terminal. They are the POI capabilities the POI System allows the Sale System to use. These POI capabilities include the logical devices enumerated in the devices data element (most of these devices could be on the POI part), plus card reader devices. Sent in the Login Response to identify the devices of the POI Terminal which can be used by the Sale System during the session.\nPossible values:\n* **CashHandling**\n* **CashierDisplay**\n* **CashierError**\n* **CashierInput**\n* **CustomerDisplay**\n* **CustomerError**\n* **CustomerInput**\n* **EMVContactless**\n* **ICC**\n* **MagStripe**\n* **PrinterDocument**\n* **PrinterReceipt**\n* **PrinterVoucher**" }, "POIProfile": { "$ref": "#/components/schemas/POIProfile", @@ -1977,23 +2015,23 @@ }, "Color": { "$ref": "#/components/schemas/Color", - "description": "Color of the text string to display or print." + "description": "Color of the text string to display or print.\nPossible values:\n* **Black**\n* **Blue**\n* **Cyan**\n* **Green**\n* **Magenta**\n* **Red**\n* **White**\n* **Yellow**" }, "CharacterWidth": { "$ref": "#/components/schemas/CharacterWidth", - "description": "Character width of the text string to display or print. Absence of this data element means the characters have normal width." + "description": "Character width of the text string to display or print. Absence of this data element means the characters have normal width.\nPossible values:\n* **DoubleWidth**\n* **SingleWidth**" }, "CharacterHeight": { "$ref": "#/components/schemas/CharacterHeight", - "description": "Character height of the text string to display or print. Absence of this data element means the characters have normal height." + "description": "Character height of the text string to display or print. Absence of this data element means the characters have normal height.\nPossible values:\n* **DoubleHeight**\n* **HalfHeight**\n* **SingleHeight**" }, "CharacterStyle": { "$ref": "#/components/schemas/CharacterStyle", - "description": "Typographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style." + "description": "Typographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style.\nPossible values:\n* **Bold**\n* **Italic**\n* **Normal**\n* **Underline**" }, "Alignment": { "$ref": "#/components/schemas/Alignment", - "description": "Alignment of the text string on the display line or print line. Absence of this data element means the characters have normal alignment." + "description": "Alignment of the text string on the display line or print line. Absence of this data element means the characters have normal alignment.\nPossible values:\n* **Centred**\n* **Justified**\n* **Left**\n* **Right**" }, "EndOfLineFlag": { "type": "boolean", @@ -2029,7 +2067,7 @@ "properties": { "BarcodeType": { "$ref": "#/components/schemas/BarcodeType", - "description": "Type of Barcode coding. Qualification of the barcode value to display or print." + "description": "Type of Barcode coding. Qualification of the barcode value to display or print.\nPossible values:\n* **Code128**\n* **Code25**\n* **EAN13**\n* **EAN8**\n* **PDF417**\n* **QRCode**\n* **UPCA**" }, "BarcodeValue": { "type": "string", @@ -2047,7 +2085,7 @@ "properties": { "OutputFormat": { "$ref": "#/components/schemas/OutputFormat", - "description": "Format of the content to display or print." + "description": "Format of the content to display or print.\nPossible values:\n* **BarCode**\n* **MessageRef**\n* **Text**\n* **XHTML**" }, "PredefinedContent": { "$ref": "#/components/schemas/PredefinedContent", @@ -2081,7 +2119,7 @@ "properties": { "MenuEntryTag": { "$ref": "#/components/schemas/MenuEntryTag", - "description": "Characteristics related to the selection of a menu entry." + "description": "Characteristics related to the selection of a menu entry.\nPossible values:\n* **NonSelectable**\n* **NonSelectableSubMenu**\n* **Selectable**\n* **SubMenu**" }, "DefaultSelectedFlag": { "type": "boolean", @@ -2089,7 +2127,8 @@ "description": "Selection of a menu entry to be displayed. In Input request message, it allows selection of one or several menu entries before any user action." }, "OutputFormat": { - "$ref": "#/components/schemas/OutputFormat" + "$ref": "#/components/schemas/OutputFormat", + "description": "Possible values:\n* **BarCode**\n* **MessageRef**\n* **Text**\n* **XHTML**" }, "PredefinedContent": { "$ref": "#/components/schemas/PredefinedContent" @@ -2130,11 +2169,11 @@ }, "Device": { "$ref": "#/components/schemas/Device", - "description": "Logical device located on a Sale Terminal or a POI Terminal, in terms of class of information to output (display, print, or store), or input (keyboard) for the Cashier or the Customer." + "description": "Logical device located on a Sale Terminal or a POI Terminal, in terms of class of information to output (display, print, or store), or input (keyboard) for the Cashier or the Customer.\nPossible values:\n* **CashierDisplay**\n* **CashierInput**\n* **CustomerDisplay**\n* **CustomerInput**" }, "InfoQualify": { "$ref": "#/components/schemas/InfoQualify", - "description": "Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer. Allows the manager of the device, Sale or POI Terminal, to send the information to a particular physical device or to present the information accordingly." + "description": "Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer. Allows the manager of the device, Sale or POI Terminal, to send the information to a particular physical device or to present the information accordingly.\nPossible values:\n* **CustomerAssistance**\n* **Display**\n* **Document**\n* **Error**\n* **Input**\n* **POIReplication**\n* **Receipt**\n* **Sound**\n* **Status**\n* **Voucher**" }, "OutputContent": { "$ref": "#/components/schemas/OutputContent", @@ -2180,7 +2219,7 @@ }, "UnitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasure", - "description": "Unit of measure of a quantity.\nIf Quantity is present." + "description": "Unit of measure of a quantity.\nIf Quantity is present.\nPossible values:\n* **Case**\n* **Centilitre**\n* **Centimetre**\n* **Foot**\n* **Gram**\n* **Inch**\n* **Kilogram**\n* **Kilometre**\n* **Litre**\n* **Meter**\n* **Mile**\n* **Other**\n* **Ounce**\n* **Pint**\n* **Pound**\n* **Quart**\n* **UKGallon**\n* **USGallon**\n* **Yard**" }, "Quantity": { "type": "string", @@ -2229,7 +2268,7 @@ "properties": { "LoyaltyUnit": { "$ref": "#/components/schemas/LoyaltyUnit", - "description": "Unit of a loyalty amount. The amount could be expressed in point or in a monetary value and a currency." + "description": "Unit of a loyalty amount. The amount could be expressed in point or in a monetary value and a currency.\nPossible values:\n* **Monetary**\n* **Point**" }, "Currency": { "type": "string", @@ -2253,15 +2292,15 @@ "properties": { "EntryMode": { "$ref": "#/components/schemas/EntryMode", - "description": "Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument." + "description": "Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument.\nPossible values:\n* **Contactless**\n* **File**\n* **ICC**\n* **Keyed**\n* **MagStripe**\n* **Manual**\n* **Mobile**\n* **RFID**\n* **Scanned**\n* **SynchronousICC**\n* **Tapped**" }, "IdentificationType": { "$ref": "#/components/schemas/IdentificationType", - "description": "Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification." + "description": "Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification.\nPossible values:\n* **AccountNumber**\n* **BarCode**\n* **ISOTrack2**\n* **PAN**\n* **PhoneNumber**" }, "IdentificationSupport": { "$ref": "#/components/schemas/IdentificationSupport", - "description": "Support of the loyalty account identification. Allows knowing where and how you have found the loyalty account identification." + "description": "Support of the loyalty account identification. Allows knowing where and how you have found the loyalty account identification.\nPossible values:\n* **HybridCard**\n* **LinkedCard**\n* **LoyaltyCard**\n* **NoCard**" }, "LoyaltyID": { "type": "string", @@ -2322,7 +2361,7 @@ }, "TypeCode": { "$ref": "#/components/schemas/TypeCode", - "description": "Type of bank check." + "description": "Type of bank check.\nPossible values:\n* **Company**\n* **Personal**" }, "Country": { "type": "string", @@ -2445,7 +2484,7 @@ "properties": { "InstalmentType": { "$ref": "#/components/schemas/InstalmentType", - "description": "Type of instalment transaction. For requesting an instalment payment transaction." + "description": "Type of instalment transaction. For requesting an instalment payment transaction.\nPossible values:\n* **DeferredInstalments**\n* **EqualInstalments**\n* **InequalInstalments**" }, "SequenceNumber": { "type": "integer", @@ -2462,7 +2501,7 @@ }, "PeriodUnit": { "$ref": "#/components/schemas/PeriodUnit", - "description": "Type of instalment transaction." + "description": "Type of instalment transaction.\nPossible values:\n* **Annual**\n* **Daily**\n* **Monthly**\n* **Weekly**" }, "FirstPaymentDate": { "type": "string", @@ -2499,7 +2538,7 @@ "properties": { "StoredValueAccountType": { "$ref": "#/components/schemas/StoredValueAccountType", - "description": "Type of stored value account. Allows the distinction of the stored value instrument to access the stored value account." + "description": "Type of stored value account. Allows the distinction of the stored value instrument to access the stored value account.\nPossible values:\n* **GiftCard**\n* **Other**\n* **PhoneCard**" }, "StoredValueProvider": { "type": "string", @@ -2519,11 +2558,11 @@ }, "EntryMode": { "$ref": "#/components/schemas/EntryMode", - "description": "Entry mode of the payment instrument information. In the Payment, Loyalty, or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. (e.g. because the payment instrument information are a barcode read by the Cashier on a scanner device)." + "description": "Entry mode of the payment instrument information. In the Payment, Loyalty, or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. (e.g. because the payment instrument information are a barcode read by the Cashier on a scanner device).\nPossible values:\n* **Contactless**\n* **File**\n* **ICC**\n* **Keyed**\n* **MagStripe**\n* **Manual**\n* **Mobile**\n* **RFID**\n* **Scanned**\n* **SynchronousICC**\n* **Tapped**" }, "IdentificationType": { "$ref": "#/components/schemas/IdentificationType", - "description": "Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification." + "description": "Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification.\nPossible values:\n* **AccountNumber**\n* **BarCode**\n* **ISOTrack2**\n* **PAN**\n* **PhoneNumber**" }, "StoredValueID": { "type": "string", @@ -2544,7 +2583,7 @@ "properties": { "PaymentInstrumentType": { "$ref": "#/components/schemas/PaymentInstrumentType", - "description": "Type of payment instrument." + "description": "Type of payment instrument.\nPossible values:\n* **Card**\n* **Cash**\n* **Check**\n* **Mobile**\n* **StoredValue**" }, "ProtectedCardData": { "type": "string", @@ -2598,11 +2637,6 @@ "pattern": "^.+$", "description": "Code assigned to a transaction approval by the Acquirer.\nIf referral." }, - "CustomerLanguage": { - "type": "string", - "pattern": "^[a-z]{2,2}$", - "description": "Language of the Customer.\nIf the language is selected by the Sale System before the request to the POI." - }, "AcquirerID": { "type": "integer", "description": "Identification of the Acquirer.\nRestrict to the Acquirer if present." @@ -2655,12 +2689,7 @@ }, "LoyaltyHandling": { "$ref": "#/components/schemas/LoyaltyHandling", - "description": "Type of Loyalty processing requested by the Sale System." - }, - "CustomerLanguage": { - "type": "string", - "pattern": "^[a-z]{2,2}$", - "description": "Language of the Customer.\nIf the language is selected by the Sale System before the request to the POI." + "description": "Type of Loyalty processing requested by the Sale System.\nPossible values:\n* **Allowed**\n* **Forbidden**\n* **Processed**\n* **Proposed**\n* **Required**" }, "ForceOnlineFlag": { "type": "boolean", @@ -2669,7 +2698,7 @@ }, "ForceEntryMode": { "$ref": "#/components/schemas/ForceEntryMode", - "description": "Payment instrument entry mode requested by the Sale System.\nRestrict entry mode if sent." + "description": "Payment instrument entry mode requested by the Sale System.\nRestrict entry mode if sent.\nPossible values:\n* **CheckReader**\n* **Contactless**\n* **File**\n* **ICC**\n* **Keyed**\n* **MagStripe**\n* **Manual**\n* **RFID**\n* **Scanned**\n* **SynchronousICC**\n* **Tapped**" }, "MerchantCategoryCode": { "type": "string", @@ -2683,7 +2712,7 @@ "properties": { "PaymentType": { "$ref": "#/components/schemas/PaymentType", - "description": "Type of payment transaction. Elements requested by the Sale System that are related to the payment only." + "description": "Type of payment transaction. Elements requested by the Sale System that are related to the payment only.\nPossible values:\n* **CashAdvance**\n* **CashDeposit**\n* **Completion**\n* **FirstReservation**\n* **Instalment**\n* **IssuerInstalment**\n* **Normal**\n* **OneTimeReservation**\n* **PaidOut**\n* **Recurring**\n* **Refund**\n* **UpdateReservation**" }, "SplitPaymentFlag": { "type": "boolean", @@ -2886,7 +2915,7 @@ }, "UnitOfMeasure": { "$ref": "#/components/schemas/UnitOfMeasure", - "description": "Unit of measure of a quantity.\nIf Quantity present." + "description": "Unit of measure of a quantity.\nIf Quantity present.\nPossible values:\n* **Case**\n* **Centilitre**\n* **Centimetre**\n* **Foot**\n* **Gram**\n* **Inch**\n* **Kilogram**\n* **Kilometre**\n* **Litre**\n* **Meter**\n* **Mile**\n* **Other**\n* **Ounce**\n* **Pint**\n* **Pound**\n* **Quart**\n* **UKGallon**\n* **USGallon**\n* **Yard**" }, "Quantity": { "type": "string", @@ -3010,7 +3039,7 @@ "properties": { "DocumentQualifier": { "$ref": "#/components/schemas/DocumentQualifier", - "description": "Qualification of the document to print to the Cashier or the Customer.\nSaleReceipt or CashierReceipt." + "description": "Qualification of the document to print to the Cashier or the Customer.\nSaleReceipt or CashierReceipt.\nPossible values:\n* **CashierReceipt**\n* **CustomerReceipt**\n* **Document**\n* **Journal**\n* **SaleReceipt**\n* **Voucher**" }, "IntegratedPrintFlag": { "type": "boolean", @@ -3150,7 +3179,7 @@ "properties": { "PaymentType": { "$ref": "#/components/schemas/PaymentType", - "description": "Type of payment transaction. Elements requested by the Sale System that are related to the payment only." + "description": "Type of payment transaction. Elements requested by the Sale System that are related to the payment only.\nPossible values:\n* **CashAdvance**\n* **CashDeposit**\n* **Completion**\n* **FirstReservation**\n* **Instalment**\n* **IssuerInstalment**\n* **Normal**\n* **OneTimeReservation**\n* **PaidOut**\n* **Recurring**\n* **Refund**\n* **UpdateReservation**" }, "PaymentInstrumentData": { "$ref": "#/components/schemas/PaymentInstrumentData" @@ -3183,11 +3212,6 @@ "type": "string", "description": "Numeric value of a handwritten signature. Contains the value of a handwritten signature, e.g. the signature of a cardholder on the merchant payment receipt. The format before encryption is the encoded data structure CapturedSignature. The data structure before encryption includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding." }, - "CustomerLanguage": { - "type": "string", - "pattern": "^[a-z]{2,2}$", - "description": "Language of the Customer. Allows choice of the Customer language when the POI displays messages or print text to Merchant interface." - }, "OnlineFlag": { "type": "boolean", "default": true, @@ -3195,7 +3219,7 @@ }, "AuthenticationMethod": { "$ref": "#/components/schemas/AuthenticationMethod", - "description": "Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction." + "description": "Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction.\nPossible values:\n* **Bypass**\n* **ManualVerification**\n* **MerchantAuthentication**\n* **OfflinePIN**\n* **OnlinePIN**\n* **PaperSignature**\n* **SecureCertificate**\n* **SecureNoCertificate**\n* **SecuredChannel**\n* **SignatureCapture**\n* **UnknownMethod**" }, "ValidityDate": { "type": "string", @@ -3230,16 +3254,11 @@ }, "LoyaltyHandling": { "$ref": "#/components/schemas/LoyaltyHandling", - "description": "Type of Loyalty processing requested by the Sale System. An way to specify what the POI has to handle concerning the loyalty." - }, - "CustomerLanguage": { - "type": "string", - "pattern": "^[a-z]{2,2}$", - "description": "Language of the Customer. Allows choice of the Customer language when the POI displays messages or print text to Merchant interface." + "description": "Type of Loyalty processing requested by the Sale System. An way to specify what the POI has to handle concerning the loyalty.\nPossible values:\n* **Allowed**\n* **Forbidden**\n* **Processed**\n* **Proposed**\n* **Required**" }, "ForceEntryMode": { "$ref": "#/components/schemas/ForceEntryMode", - "description": "Payment instrument entry mode requested by the Sale System. Avoid retry on an out of order card reading device, when the sale system knows that some card entry modes on the POI do not work." + "description": "Payment instrument entry mode requested by the Sale System. Avoid retry on an out of order card reading device, when the sale system knows that some card entry modes on the POI do not work.\nPossible values:\n* **CheckReader**\n* **Contactless**\n* **File**\n* **ICC**\n* **Keyed**\n* **MagStripe**\n* **Manual**\n* **RFID**\n* **Scanned**\n* **SynchronousICC**\n* **Tapped**" }, "ForceCustomerSelectionFlag": { "type": "boolean", @@ -3253,7 +3272,7 @@ }, "PaymentType": { "$ref": "#/components/schemas/PaymentType", - "description": "Type of payment transaction. Elements requested by the Sale System that are related to the payment only." + "description": "Type of payment transaction. Elements requested by the Sale System that are related to the payment only.\nPossible values:\n* **CashAdvance**\n* **CashDeposit**\n* **Completion**\n* **FirstReservation**\n* **Instalment**\n* **IssuerInstalment**\n* **Normal**\n* **OneTimeReservation**\n* **PaidOut**\n* **Recurring**\n* **Refund**\n* **UpdateReservation**" }, "CashBackFlag": { "type": "boolean", @@ -3266,7 +3285,7 @@ "properties": { "LoyaltyTransactionType": { "$ref": "#/components/schemas/LoyaltyTransactionType", - "description": "Type of loyalty transaction. These types of loyalty transactions use the same message requests:\n * **Award**: direct or payment-related award on a loyalty account.\n * **Rebate**: rebate on a total amount, sale item amount, or sale items.\n * **Redemption**: redemption on a loyalty account.\n * **AwardRefund**: refund of a loyalty award transaction.\n * **RebateRefund**: refund of a loyalty rebate transaction.\n * **RedemptionRefund**: refund of a loyalty redemption transaction." + "description": "Type of loyalty transaction. These types of loyalty transactions use the same message requests:\n * **Award**: direct or payment-related award on a loyalty account.\n * **Rebate**: rebate on a total amount, sale item amount, or sale items.\n * **Redemption**: redemption on a loyalty account.\n * **AwardRefund**: refund of a loyalty award transaction.\n * **RebateRefund**: refund of a loyalty rebate transaction.\n * **RedemptionRefund**: refund of a loyalty redemption transaction.\nPossible values:\n* **Award**\n* **AwardRefund**\n* **Rebate**\n* **RebateRefund**\n* **Redemption**\n* **RedemptionRefund**" }, "Currency": { "type": "string", @@ -3308,7 +3327,7 @@ }, "StoredValueTransactionType": { "$ref": "#/components/schemas/StoredValueTransactionType", - "description": "Identification of operation to proceed on the stored value account or the stored value card." + "description": "Identification of operation to proceed on the stored value account or the stored value card.\nPossible values:\n* **Activate**\n* **Duplicate**\n* **Load**\n* **Reserve**\n* **Reverse**\n* **Unload**" }, "StoredValueAccountID": { "$ref": "#/components/schemas/StoredValueAccountID", @@ -3367,7 +3386,7 @@ "properties": { "StoredValueTransactionType": { "$ref": "#/components/schemas/StoredValueTransactionType", - "description": "Identification of operation to proceed on the stored value account or the stored value card.\nCopy." + "description": "Identification of operation to proceed on the stored value account or the stored value card.\nCopy.\nPossible values:\n* **Activate**\n* **Duplicate**\n* **Load**\n* **Reserve**\n* **Reverse**\n* **Unload**" }, "ProductCode": { "type": "integer", @@ -3440,7 +3459,7 @@ "properties": { "TransactionType": { "$ref": "#/components/schemas/TransactionType", - "description": "Type of transaction for which totals are grouped.\nDebit, Credit, ReverseDebit, ReverseCredit, OneTimeReservation, CompletedDeffered, FirstReservation, UpdateReservation, CompletedReservation, CashAdvance." + "description": "Type of transaction for which totals are grouped.\nDebit, Credit, ReverseDebit, ReverseCredit, OneTimeReservation, CompletedDeffered, FirstReservation, UpdateReservation, CompletedReservation, CashAdvance.\nPossible values:\n* **Award**\n* **CashAdvance**\n* **CompletedDeffered**\n* **CompletedReservation**\n* **Credit**\n* **Debit**\n* **Declined**\n* **Failed**\n* **FirstReservation**\n* **IssuerInstalment**\n* **OneTimeReservation**\n* **Rebate**\n* **Redemption**\n* **ReverseAward**\n* **ReverseCredit**\n* **ReverseDebit**\n* **ReverseRebate**\n* **ReverseRedemption**\n* **UpdateReservation**" }, "TransactionCount": { "type": "integer", @@ -3465,7 +3484,7 @@ "properties": { "TransactionType": { "$ref": "#/components/schemas/TransactionType", - "description": "Type of transaction for which totals are grouped.\nAward, ReverseAward, Redemption, ReverseRedemption, Rebate, ReverseRebate." + "description": "Type of transaction for which totals are grouped.\nAward, ReverseAward, Redemption, ReverseRedemption, Rebate, ReverseRebate.\nPossible values:\n* **Award**\n* **CashAdvance**\n* **CompletedDeffered**\n* **CompletedReservation**\n* **Credit**\n* **Debit**\n* **Declined**\n* **Failed**\n* **FirstReservation**\n* **IssuerInstalment**\n* **OneTimeReservation**\n* **Rebate**\n* **Redemption**\n* **ReverseAward**\n* **ReverseCredit**\n* **ReverseDebit**\n* **ReverseRebate**\n* **ReverseRedemption**\n* **UpdateReservation**" }, "TransactionCount": { "type": "integer", @@ -3490,7 +3509,7 @@ "properties": { "PaymentInstrumentType": { "$ref": "#/components/schemas/PaymentInstrumentType", - "description": "Type of payment instrument." + "description": "Type of payment instrument.\nPossible values:\n* **Card**\n* **Cash**\n* **Check**\n* **Mobile**\n* **StoredValue**" }, "AcquirerID": { "type": "integer", @@ -3545,7 +3564,7 @@ }, "LoyaltyUnit": { "$ref": "#/components/schemas/LoyaltyUnit", - "description": "Unit of a loyalty amount." + "description": "Unit of a loyalty amount.\nPossible values:\n* **Monetary**\n* **Point**" }, "LoyaltyCurrency": { "type": "string", @@ -3599,7 +3618,7 @@ "properties": { "AccountType": { "$ref": "#/components/schemas/AccountType", - "description": "Type of cardholder account used for the transaction. Allows a cardholder to select the type of account used for the transaction." + "description": "Type of cardholder account used for the transaction. Allows a cardholder to select the type of account used for the transaction.\nPossible values:\n* **CardTotals**\n* **Checking**\n* **CreditCard**\n* **Default**\n* **EpurseCard**\n* **Investment**\n* **Savings**\n* **Universal**" }, "CardAcquisitionReference": { "$ref": "#/components/schemas/TransactionIDType" @@ -3656,7 +3675,7 @@ }, "LoyaltyUnit": { "$ref": "#/components/schemas/LoyaltyUnit", - "description": "Unit of a loyalty amount. The amount could be expressed in point or in a monetary value and a currency." + "description": "Unit of a loyalty amount. The amount could be expressed in point or in a monetary value and a currency.\nPossible values:\n* **Monetary**\n* **Point**" }, "Currency": { "type": "string", @@ -3674,7 +3693,7 @@ "properties": { "MessageCategory": { "$ref": "#/components/schemas/MessageCategory", - "description": "Category of message.\nCardAcquisition, Display, Input, Loyalty, Payment, Print, CardReaderAPDU, CardReaderInit, CardReaderPowerOff." + "description": "Category of message.\nCardAcquisition, Display, Input, Loyalty, Payment, Print, CardReaderAPDU, CardReaderInit, CardReaderPowerOff.\nPossible values:\n* **Abort**\n* **Admin**\n* **BalanceInquiry**\n* **Batch**\n* **CardAcquisition**\n* **CardReaderAPDU**\n* **CardReaderInit**\n* **CardReaderPowerOff**\n* **Diagnosis**\n* **Display**\n* **EnableService**\n* **Event**\n* **GetTotals**\n* **Input**\n* **InputUpdate**\n* **Login**\n* **Logout**\n* **Loyalty**\n* **None**\n* **PIN**\n* **Payment**\n* **Print**\n* **Reconciliation**\n* **Reversal**\n* **Sound**\n* **StoredValue**\n* **TransactionStatus**\n* **Transmit**" }, "ServiceID": { "type": "string", @@ -3709,15 +3728,15 @@ }, "MessageClass": { "$ref": "#/components/schemas/MessageClass", - "description": "Class of the message." + "description": "Class of the message.\nPossible values:\n* **Device**\n* **Event**\n* **Service**" }, "MessageCategory": { "$ref": "#/components/schemas/MessageCategory", - "description": "Category of message." + "description": "Category of message.\nPossible values:\n* **Abort**\n* **Admin**\n* **BalanceInquiry**\n* **Batch**\n* **CardAcquisition**\n* **CardReaderAPDU**\n* **CardReaderInit**\n* **CardReaderPowerOff**\n* **Diagnosis**\n* **Display**\n* **EnableService**\n* **Event**\n* **GetTotals**\n* **Input**\n* **InputUpdate**\n* **Login**\n* **Logout**\n* **Loyalty**\n* **None**\n* **PIN**\n* **Payment**\n* **Print**\n* **Reconciliation**\n* **Reversal**\n* **Sound**\n* **StoredValue**\n* **TransactionStatus**\n* **Transmit**" }, "MessageType": { "$ref": "#/components/schemas/MessageType", - "description": "Type of message of the Sale to POI protocol." + "description": "Type of message of the Sale to POI protocol.\nPossible values:\n* **Notification**\n* **Request**\n* **Response**" }, "ServiceID": { "type": "string", @@ -3810,11 +3829,11 @@ "properties": { "Device": { "$ref": "#/components/schemas/Device", - "description": "Logical device located on a Sale Terminal or a POI Terminal, in term of class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer.\nCopy." + "description": "Logical device located on a Sale Terminal or a POI Terminal, in term of class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer.\nCopy.\nPossible values:\n* **CashierDisplay**\n* **CashierInput**\n* **CustomerDisplay**\n* **CustomerInput**" }, "InfoQualify": { "$ref": "#/components/schemas/InfoQualify", - "description": "Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer.\nCopy." + "description": "Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer.\nCopy.\nPossible values:\n* **CustomerAssistance**\n* **Display**\n* **Document**\n* **Error**\n* **Input**\n* **POIReplication**\n* **Receipt**\n* **Sound**\n* **Status**\n* **Voucher**" }, "Response": { "$ref": "#/components/schemas/Response", @@ -3832,15 +3851,15 @@ "properties": { "Device": { "$ref": "#/components/schemas/Device", - "description": "Logical device located on a Sale Terminal or a POI Terminal, regarding the class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer." + "description": "Logical device located on a Sale Terminal or a POI Terminal, regarding the class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer.\nPossible values:\n* **CashierDisplay**\n* **CashierInput**\n* **CustomerDisplay**\n* **CustomerInput**" }, "InfoQualify": { "$ref": "#/components/schemas/InfoQualify", - "description": "Qualification of the information to send to an output logical device, to display or print to the Cashier or the Customer." + "description": "Qualification of the information to send to an output logical device, to display or print to the Cashier or the Customer.\nPossible values:\n* **CustomerAssistance**\n* **Display**\n* **Document**\n* **Error**\n* **Input**\n* **POIReplication**\n* **Receipt**\n* **Sound**\n* **Status**\n* **Voucher**" }, "InputCommand": { "$ref": "#/components/schemas/InputCommand", - "description": "Type of requested input. Can be: **GetConfirmation**, **TextString**, **DigitString**, **DecimalString** or **GetMenuEntry**." + "description": "Type of requested input. Can be: **GetConfirmation**, **TextString**, **DigitString**, **DecimalString** or **GetMenuEntry**.\nPossible values:\n* **DecimalString**\n* **DigitString**\n* **GetAnyKey**\n* **GetConfirmation**\n* **GetFunctionKey**\n* **GetMenuEntry**\n* **Password**\n* **SiteManager**\n* **TextString**" }, "NotifyCardInputFlag": { "type": "boolean", @@ -3939,7 +3958,7 @@ "properties": { "InputCommand": { "$ref": "#/components/schemas/InputCommand", - "description": "Type of requested input. Can be: **GetConfirmation**, **TextString**, **DigitString**, **DecimalString** or **GetMenuEntry**." + "description": "Type of requested input. Can be: **GetConfirmation**, **TextString**, **DigitString**, **DecimalString** or **GetMenuEntry**.\nPossible values:\n* **DecimalString**\n* **DigitString**\n* **GetAnyKey**\n* **GetConfirmation**\n* **GetFunctionKey**\n* **GetMenuEntry**\n* **Password**\n* **SiteManager**\n* **TextString**" }, "ConfirmedFlag": { "type": "boolean", @@ -3979,11 +3998,11 @@ "properties": { "Device": { "$ref": "#/components/schemas/Device", - "description": "Logical device located on a Sale Terminal or a POI Terminal, in terms of class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer." + "description": "Logical device located on a Sale Terminal or a POI Terminal, in terms of class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer.\nPossible values:\n* **CashierDisplay**\n* **CashierInput**\n* **CustomerDisplay**\n* **CustomerInput**" }, "InfoQualify": { "$ref": "#/components/schemas/InfoQualify", - "description": "Qualification of the information to send to an output logical device, to display or print to the Cashier or the Customer." + "description": "Qualification of the information to send to an output logical device, to display or print to the Cashier or the Customer.\nPossible values:\n* **CustomerAssistance**\n* **Display**\n* **Document**\n* **Error**\n* **Input**\n* **POIReplication**\n* **Receipt**\n* **Sound**\n* **Status**\n* **Voucher**" }, "Response": { "$ref": "#/components/schemas/Response" @@ -4004,11 +4023,11 @@ "properties": { "DocumentQualifier": { "$ref": "#/components/schemas/DocumentQualifier", - "description": "Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send information to a physical printer or to use the paper type accordingly." + "description": "Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send information to a physical printer or to use the paper type accordingly.\nPossible values:\n* **CashierReceipt**\n* **CustomerReceipt**\n* **Document**\n* **Journal**\n* **SaleReceipt**\n* **Voucher**" }, "ResponseMode": { "$ref": "#/components/schemas/ResponseMode", - "description": "Message response awaited by the initiator of the Request. Allows various types and synchronisation of requests for Print or Sound." + "description": "Message response awaited by the initiator of the Request. Allows various types and synchronisation of requests for Print or Sound.\nPossible values:\n* **Immediate**\n* **NotRequired**\n* **PrintEnd**\n* **SoundEnd**" }, "IntegratedPrintFlag": { "type": "boolean", @@ -4035,7 +4054,8 @@ "type": "object", "properties": { "SoundFormat": { - "$ref": "#/components/schemas/SoundFormat" + "$ref": "#/components/schemas/SoundFormat", + "description": "Possible values:\n* **MessageRef**\n* **SoundRef**\n* **Text**" }, "Language": { "type": "string", @@ -4061,7 +4081,8 @@ "type": "string" }, "PINFormat": { - "$ref": "#/components/schemas/PINFormat" + "$ref": "#/components/schemas/PINFormat", + "description": "Possible values:\n* **ISO0**\n* **ISO1**\n* **ISO2**\n* **ISO3**" }, "AdditionalInput": { "type": "string", @@ -4160,11 +4181,11 @@ }, "TokenRequestedType": { "$ref": "#/components/schemas/TokenRequestedType", - "description": "Type of token replacing the PAN of a payment card to identify the payment\n mean of the customer. It allows, for a merchant, to use a token for a transaction\n only or for a longer period." + "description": "Type of token replacing the PAN of a payment card to identify the payment\n mean of the customer. It allows, for a merchant, to use a token for a transaction\n only or for a longer period.\nPossible values:\n* **Customer**\n* **Transaction**" }, "CustomerOrderReq": { "$ref": "#/components/schemas/CustomerOrderReq", - "description": "List of customer order open, closed or both to be sent in the response messages." + "description": "List of customer order open, closed or both to be sent in the response messages.\nPossible values:\n* **Both**\n* **Closed**\n* **Open**" }, "POISerialNumber": { "type": "string", @@ -4195,11 +4216,11 @@ "properties": { "TransactionAction": { "$ref": "#/components/schemas/TransactionAction", - "description": "Action to realise on a transaction. In an `EnableService` request message:\n - Starts a transaction by a swipe-ahead mechanism, with the services which are enabled.\n - Aborts a swipe-ahead transaction or started by a `CardAcquisition`, and not followed by a service request from the Sale System to complete the transaction." + "description": "Action to realise on a transaction. In an `EnableService` request message:\n - Starts a transaction by a swipe-ahead mechanism, with the services which are enabled.\n - Aborts a swipe-ahead transaction or started by a `CardAcquisition`, and not followed by a service request from the Sale System to complete the transaction.\nPossible values:\n* **AbortTransaction**\n* **StartTransaction**" }, "ServicesEnabled": { "$ref": "#/components/schemas/ServicesEnabled", - "description": "Services which are enabled before the start-up of a transaction.\nMandatory if `TransactionAction` is `StartTransaction`, absent if not." + "description": "Services which are enabled before the start-up of a transaction.\nMandatory if `TransactionAction` is `StartTransaction`, absent if not.\nPossible values:\n* **CardAcquisition**\n* **Loyalty**\n* **Payment**" }, "DisplayOutput": { "$ref": "#/components/schemas/DisplayOutput", @@ -4299,11 +4320,6 @@ "$ref": "#/components/schemas/SaleData", "description": "Data related to the Sale System." }, - "CustomerLanguage": { - "type": "string", - "pattern": "^[a-z]{2,2}$", - "description": "Language of the Customer.\nIf the language is selected by the Sale System before the request to the POI." - }, "StoredValueData": { "type": "array", "items": { @@ -4336,7 +4352,7 @@ }, "ReversalReason": { "$ref": "#/components/schemas/ReversalReason", - "description": "Reason of the payment or loyalty reversal.." + "description": "Reason of the payment or loyalty reversal..\nPossible values:\n* **CustCancel**\n* **Malfunction**\n* **MerchantCancel**\n* **Unable2Compl**" }, "CustomerOrder": { "$ref": "#/components/schemas/CustomerOrder" @@ -4353,7 +4369,7 @@ "properties": { "ReconciliationType": { "$ref": "#/components/schemas/ReconciliationType", - "description": "Type of Reconciliation requested by the Sale to the POI." + "description": "Type of Reconciliation requested by the Sale to the POI.\nPossible values:\n* **AcquirerReconciliation**\n* **AcquirerSynchronisation**\n* **PreviousReconciliation**\n* **SaleReconciliation**" }, "AcquirerID": { "type": "array", @@ -4378,7 +4394,7 @@ "properties": { "TotalDetails": { "$ref": "#/components/schemas/TotalDetails", - "description": "Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation.\nRequired to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID)." + "description": "Indicates the hierarchical structure of the reconciliation result of the Sale to POI reconciliation.\nRequired to present totals per value of element included in this cluster (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID).\nPossible values:\n* **OperatorID**\n* **POIID**\n* **SaleID**\n* **ShiftNumber**\n* **TotalsGroupID**" }, "TotalFilter": { "$ref": "#/components/schemas/TotalFilter", @@ -4418,7 +4434,7 @@ "items": { "$ref": "#/components/schemas/DocumentQualifier" }, - "description": "Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send the information to a particular physical printer or to use the paper type accordingly." + "description": "Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send the information to a particular physical printer or to use the paper type accordingly.\nPossible values:\n* **CashierReceipt**\n* **CustomerReceipt**\n* **Document**\n* **Journal**\n* **SaleReceipt**\n* **Voucher**" } } }, @@ -4456,7 +4472,7 @@ }, "EventToNotify": { "$ref": "#/components/schemas/EventToNotify", - "description": "Event the POI notifies to the Sale System." + "description": "Event the POI notifies to the Sale System.\nPossible values:\n* **Abort**\n* **BeginMaintenance**\n* **CardInserted**\n* **CardRemoved**\n* **Completed**\n* **CustomerLanguage**\n* **EndMaintenance**\n* **Initialised**\n* **KeyPressed**\n* **OutOfOrder**\n* **Reject**\n* **SaleAdmin**\n* **SaleWakeUp**\n* **SecurityAlarm**\n* **Shutdown**\n* **StopAssistance**\n* **UseAnotherCardForPreauth**" }, "EventDetails": { "type": "string", @@ -4474,11 +4490,6 @@ "default": false, "description": "Indicates if the occurred event requires maintenance call or action." }, - "CustomerLanguage": { - "type": "string", - "pattern": "^[a-z]{2,2}$", - "description": "Language of the Customer.\nIf the language is selected by the Sale System before the request to the POI." - }, "DisplayOutput": { "type": "array", "items": { @@ -4773,11 +4784,6 @@ "$ref": "#/components/schemas/POIData", "description": "Data related to the POI System." }, - "CustomerLanguage": { - "type": "string", - "pattern": "^[a-z]{2,2}$", - "description": "Data related to the POI System." - }, "PaymentBrand": { "type": "array", "items": { @@ -4925,7 +4931,7 @@ }, "ReconciliationType": { "$ref": "#/components/schemas/ReconciliationType", - "description": "Type of Reconciliation requested by the Sale to the POI." + "description": "Type of Reconciliation requested by the Sale to the POI.\nPossible values:\n* **AcquirerReconciliation**\n* **AcquirerSynchronisation**\n* **PreviousReconciliation**\n* **SaleReconciliation**" }, "POIReconciliationID": { "type": "integer", @@ -5043,6 +5049,11 @@ "Response" ] }, + "AbortResponse": { + "type": "object", + "description": "A successful `AbortRequest` returns a response with a **200 OK** HTTP status code and no body.", + "properties": {} + }, "DiagnosisResponse": { "type": "object", "description": "It conveys the result of the requested diagnosis and a possible message to display on a logical device.\nContent of the Diagnosis Response message.", @@ -5115,7 +5126,7 @@ "properties": { "DocumentQualifier": { "$ref": "#/components/schemas/DocumentQualifier", - "description": "Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send information to a physical printer or to use the paper type accordingly." + "description": "Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send information to a physical printer or to use the paper type accordingly.\nPossible values:\n* **CashierReceipt**\n* **CustomerReceipt**\n* **Document**\n* **Journal**\n* **SaleReceipt**\n* **Voucher**" }, "Response": { "$ref": "#/components/schemas/Response", diff --git a/yaml/PayoutService-v30.yaml b/yaml/PayoutService-v30.yaml index cbb7323..f0a74ad 100644 --- a/yaml/PayoutService-v30.yaml +++ b/yaml/PayoutService-v30.yaml @@ -5,8 +5,16 @@ info: version: '30' x-publicVersion: true title: Adyen Payout API - description: "A 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\ + 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\ @@ -40,7 +48,23 @@ paths: tags: - Reviewing summary: Confirm a payout - description: 'Confirms a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' @@ -107,7 +131,23 @@ paths: tags: - Reviewing summary: Cancel a payout - description: 'Cancels a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' @@ -174,10 +214,26 @@ paths: tags: - Instant payouts summary: Make an instant card payout - description: With 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + With 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 @@ -240,9 +296,24 @@ paths: tags: - Initialization summary: Store payout details - description: Stores 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Stores 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 @@ -305,7 +376,23 @@ paths: tags: - Initialization summary: Store details and submit a payout - description: 'Submits a payout and stores its details for subsequent payouts. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or @@ -378,8 +465,24 @@ paths: tags: - Initialization summary: Submit a payout - description: 'Submits a payout using the previously stored payment details. - To store payment details, use the `/storeDetail` API call. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout using the previously stored payment details. To store payment + details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or diff --git a/yaml/PayoutService-v40.yaml b/yaml/PayoutService-v40.yaml index 7cc7544..c365b35 100644 --- a/yaml/PayoutService-v40.yaml +++ b/yaml/PayoutService-v40.yaml @@ -5,8 +5,16 @@ info: version: '40' x-publicVersion: true title: Adyen Payout API - description: "A 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\ + 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\ @@ -40,7 +48,23 @@ paths: tags: - Reviewing summary: Confirm a payout - description: 'Confirms a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' @@ -107,7 +131,23 @@ paths: tags: - Reviewing summary: Cancel a payout - description: 'Cancels a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' @@ -174,10 +214,26 @@ paths: tags: - Instant payouts summary: Make an instant card payout - description: With 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + With 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 @@ -240,9 +296,24 @@ paths: tags: - Initialization summary: Store payout details - description: Stores 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Stores 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 @@ -305,7 +376,23 @@ paths: tags: - Initialization summary: Store details and submit a payout - description: 'Submits a payout and stores its details for subsequent payouts. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or @@ -378,8 +465,24 @@ paths: tags: - Initialization summary: Submit a payout - description: 'Submits a payout using the previously stored payment details. - To store payment details, use the `/storeDetail` API call. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout using the previously stored payment details. To store payment + details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or diff --git a/yaml/PayoutService-v50.yaml b/yaml/PayoutService-v50.yaml index d6adff0..1479c66 100644 --- a/yaml/PayoutService-v50.yaml +++ b/yaml/PayoutService-v50.yaml @@ -5,8 +5,16 @@ info: version: '50' x-publicVersion: true title: Adyen Payout API - description: "A 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\ + 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\ @@ -40,7 +48,23 @@ paths: tags: - Reviewing summary: Confirm a payout - description: 'Confirms a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' @@ -107,7 +131,23 @@ paths: tags: - Reviewing summary: Cancel a payout - description: 'Cancels a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' @@ -174,10 +214,26 @@ paths: tags: - Instant payouts summary: Make an instant card payout - description: With 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + With 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 @@ -240,9 +296,24 @@ paths: tags: - Initialization summary: Store payout details - description: Stores 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Stores 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 @@ -305,7 +376,23 @@ paths: tags: - Initialization summary: Store details and submit a payout - description: 'Submits a payout and stores its details for subsequent payouts. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or @@ -378,8 +465,24 @@ paths: tags: - Initialization summary: Submit a payout - description: 'Submits a payout using the previously stored payment details. - To store payment details, use the `/storeDetail` API call. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout using the previously stored payment details. To store payment + details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or diff --git a/yaml/PayoutService-v51.yaml b/yaml/PayoutService-v51.yaml index 9e35f91..7a6f33d 100644 --- a/yaml/PayoutService-v51.yaml +++ b/yaml/PayoutService-v51.yaml @@ -5,8 +5,16 @@ info: version: '51' x-publicVersion: true title: Adyen Payout API - description: "A 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\ + 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\ @@ -40,7 +48,23 @@ paths: tags: - Reviewing summary: Confirm a payout - description: 'Confirms a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' @@ -107,7 +131,23 @@ paths: tags: - Reviewing summary: Cancel a payout - description: 'Cancels a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' @@ -174,10 +214,26 @@ paths: tags: - Instant payouts summary: Make an instant card payout - description: With 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + With 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 @@ -240,9 +296,24 @@ paths: tags: - Initialization summary: Store payout details - description: Stores 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Stores 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 @@ -305,7 +376,23 @@ paths: tags: - Initialization summary: Store details and submit a payout - description: 'Submits a payout and stores its details for subsequent payouts. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or @@ -378,8 +465,24 @@ paths: tags: - Initialization summary: Submit a payout - description: 'Submits a payout using the previously stored payment details. - To store payment details, use the `/storeDetail` API call. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout using the previously stored payment details. To store payment + details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or diff --git a/yaml/PayoutService-v52.yaml b/yaml/PayoutService-v52.yaml index 3bc93d1..eb7c53d 100644 --- a/yaml/PayoutService-v52.yaml +++ b/yaml/PayoutService-v52.yaml @@ -5,8 +5,16 @@ info: version: '52' x-publicVersion: true title: Adyen Payout API - description: "A 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\ + 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\ @@ -40,7 +48,23 @@ paths: tags: - Reviewing summary: Confirm a payout - description: 'Confirms a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' @@ -107,7 +131,23 @@ paths: tags: - Reviewing summary: Cancel a payout - description: 'Cancels a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' @@ -174,10 +214,26 @@ paths: tags: - Instant payouts summary: Make an instant card payout - description: With 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + With 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 @@ -240,9 +296,24 @@ paths: tags: - Initialization summary: Store payout details - description: Stores 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Stores 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 @@ -305,7 +376,23 @@ paths: tags: - Initialization summary: Store details and submit a payout - description: 'Submits a payout and stores its details for subsequent payouts. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or @@ -378,8 +465,24 @@ paths: tags: - Initialization summary: Submit a payout - description: 'Submits a payout using the previously stored payment details. - To store payment details, use the `/storeDetail` API call. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout using the previously stored payment details. To store payment + details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or diff --git a/yaml/PayoutService-v64.yaml b/yaml/PayoutService-v64.yaml index b1ac94a..554dcb2 100644 --- a/yaml/PayoutService-v64.yaml +++ b/yaml/PayoutService-v64.yaml @@ -5,8 +5,16 @@ info: version: '64' x-publicVersion: true title: Adyen Payout API - description: "A 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\ + 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\ @@ -40,7 +48,23 @@ paths: tags: - Reviewing summary: Confirm a payout - description: 'Confirms a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' @@ -107,7 +131,23 @@ paths: tags: - Reviewing summary: Cancel a payout - description: 'Cancels a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' @@ -174,10 +214,26 @@ paths: tags: - Instant payouts summary: Make an instant card payout - description: With 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + With 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 @@ -240,9 +296,24 @@ paths: tags: - Initialization summary: Store payout details - description: Stores 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Stores 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 @@ -305,7 +376,23 @@ paths: tags: - Initialization summary: Store details and submit a payout - description: 'Submits a payout and stores its details for subsequent payouts. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or @@ -378,8 +465,24 @@ paths: tags: - Initialization summary: Submit a payout - description: 'Submits a payout using the previously stored payment details. - To store payment details, use the `/storeDetail` API call. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout using the previously stored payment details. To store payment + details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or diff --git a/yaml/PayoutService-v67.yaml b/yaml/PayoutService-v67.yaml index 6a4c856..19ac2cf 100644 --- a/yaml/PayoutService-v67.yaml +++ b/yaml/PayoutService-v67.yaml @@ -5,8 +5,16 @@ info: version: '67' x-publicVersion: true title: Adyen Payout API - description: "A 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\ + 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\ @@ -40,7 +48,23 @@ paths: tags: - Reviewing summary: Confirm a payout - description: 'Confirms a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' @@ -107,7 +131,23 @@ paths: tags: - Reviewing summary: Cancel a payout - description: 'Cancels a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' @@ -174,10 +214,26 @@ paths: tags: - Instant payouts summary: Make an instant card payout - description: With 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + With 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 @@ -240,9 +296,24 @@ paths: tags: - Initialization summary: Store payout details - description: Stores 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Stores 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 @@ -305,7 +376,23 @@ paths: tags: - Initialization summary: Store details and submit a payout - description: 'Submits a payout and stores its details for subsequent payouts. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or @@ -378,8 +465,24 @@ paths: tags: - Initialization summary: Submit a payout - description: 'Submits a payout using the previously stored payment details. - To store payment details, use the `/storeDetail` API call. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout using the previously stored payment details. To store payment + details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or diff --git a/yaml/PayoutService-v68.yaml b/yaml/PayoutService-v68.yaml index 8911246..64c6c51 100644 --- a/yaml/PayoutService-v68.yaml +++ b/yaml/PayoutService-v68.yaml @@ -5,8 +5,16 @@ info: version: '68' x-publicVersion: true title: Adyen Payout API - description: "A 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\ + 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\ @@ -40,7 +48,23 @@ paths: tags: - Reviewing summary: Confirm a payout - description: 'Confirms a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Confirms a previously submitted payout. To cancel a payout, use the `/declineThirdParty` endpoint.' @@ -107,7 +131,23 @@ paths: tags: - Reviewing summary: Cancel a payout - description: 'Cancels a previously submitted payout. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Cancels a previously submitted payout. To confirm and send a payout, use the `/confirmThirdParty` endpoint.' @@ -174,10 +214,26 @@ paths: tags: - Instant payouts summary: Make an instant card payout - description: With 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + With 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 @@ -240,9 +296,24 @@ paths: tags: - Initialization summary: Store payout details - description: Stores 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. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Stores 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 @@ -305,7 +376,23 @@ paths: tags: - Initialization summary: Store details and submit a payout - description: 'Submits a payout and stores its details for subsequent payouts. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout and stores its details for subsequent payouts. The submitted payout must be confirmed or declined either by a reviewer or @@ -378,8 +465,24 @@ paths: tags: - Initialization summary: Submit a payout - description: 'Submits a payout using the previously stored payment details. - To store payment details, use the `/storeDetail` API call. + description: '> This endpoint is **deprecated** and no longer supports new integrations. + 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. + + > + + > For more information about the payout features of the Transfers API, see + our [Payouts](https://docs.adyen.com/payouts/payout-service) documentation. + + + + Submits a payout using the previously stored payment details. To store payment + details, use the `/storeDetail` API call. The submitted payout must be confirmed or declined either by a reviewer or diff --git a/yaml/TerminalAPI-v1.yaml b/yaml/TerminalAPI-v1.yaml index 5434f02..c8c28d0 100644 --- a/yaml/TerminalAPI-v1.yaml +++ b/yaml/TerminalAPI-v1.yaml @@ -411,6 +411,30 @@ paths: It conveys Information related to the status of the last or current Payment, Loyalty or Reversal transaction.' + /abort: + post: + description: 'Body of the Abort Request message. + + It conveys Information requested for identification of the message request + carrying the transaction to abort. A message to display on the CustomerError + Device could be sent by the Sale System (DisplayOutput).' + summary: Abort Request + security: + - BasicAuth: [] + - ApiKeyAuth: [] + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AbortRequest' + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AbortResponse' + description: A successful `AbortRequest` returns a response with a **200 + OK** HTTP status code and no body. /diagnosis: post: description: 'It conveys Information related to the target POI for which the @@ -541,29 +565,67 @@ components: schemas: TerminalEnvironment: type: string - description: Environment of the Terminal. Sent in the Login Request (Response) + description: 'Environment of the Terminal. Sent in the Login Request (Response) to identify the environment of the Sale System (POI System) during the session. Sent in other messages when the data has changed since the Login. + + Possible values: + + * **Attended** + + * **SemiAttended** + + * **Unattended**' enum: - Attended - SemiAttended - Unattended GenericProfile: type: string - description: Functional profile of the Sale to POI protocol. Sent in the Login + description: 'Functional profile of the Sale to POI protocol. Sent in the Login Request to identify the messages that might be requested or received by the Sale Terminal during the session. Sent in the Login Response to identify the messages that might be processed or sent by the POI Terminal during the session. + + Possible values: + + * **Basic** + + * **Extended** + + * **Standard**' enum: - Basic - Extended - Standard ServiceProfiles: type: array - description: Service profiles of the Sale to POI protocol. Sent in the Login + description: 'Service profiles of the Sale to POI protocol. Sent in the Login Request to identify the specific services that might be requested by the Sale Terminal during the session. Sent in the Login Response to identify the specific services that might be processed by the POI Terminal during the session. + + Possible values: + + * **Batch** + + * **CardReader** + + * **Communication** + + * **Loyalty** + + * **OneTimeRes** + + * **PIN** + + * **Reservation** + + * **Sound** + + * **StoredValue** + + * **Synchro**' items: type: string enum: @@ -579,7 +641,39 @@ components: - Synchro SaleCapabilities: type: array - description: place holder! + description: 'place holder! + + Possible values: + + * **CashierDisplay** + + * **CashierError** + + * **CashierInput** + + * **CashierStatus** + + * **CustomerAssistance** + + * **CustomerDisplay** + + * **CustomerError** + + * **CustomerInput** + + * **EMVContactless** + + * **ICC** + + * **MagStripe** + + * **POIReplication** + + * **PrinterDocument** + + * **PrinterReceipt** + + * **PrinterVoucher**' items: type: string enum: @@ -600,16 +694,30 @@ components: - PrinterVoucher TokenRequestedType: type: string - description: Type of token replacing the PAN of a payment card to identify the - payment mean of the customer. It allows, for a merchant, to use a token for - a transaction only or for a longer period. + description: 'Type of token replacing the PAN of a payment card to identify + the payment mean of the customer. It allows, for a merchant, to use a token + for a transaction only or for a longer period. + + Possible values: + + * **Customer** + + * **Transaction**' enum: - Customer - Transaction CustomerOrderReq: type: array - description: List of customer order open, closed or both to be sent in the response - messages. + description: 'List of customer order open, closed or both to be sent in the + response messages. + + Possible values: + + * **Both** + + * **Closed** + + * **Open**' items: type: string enum: @@ -618,7 +726,13 @@ components: - Open TrackFormat: type: string - description: Magnetic track or magnetic ink characters line. + description: 'Magnetic track or magnetic ink characters line. + + Possible values: + + * **AAMVA** + + * **ISO**' enum: - AAMVA - ISO @@ -673,7 +787,19 @@ components: - Unreachable PrinterStatus: type: string - description: Indicates if the printer is working and usable. + description: 'Indicates if the printer is working and usable. + + Possible values: + + * **NoPaper** + + * **OK** + + * **OutOfOrder** + + * **PaperJam** + + * **PaperLow**' enum: - NoPaper - OK @@ -682,12 +808,40 @@ components: - PaperLow POICapabilities: type: array - description: Hardware capabilities of the POI Terminal. They are the POI capabilities + description: 'Hardware capabilities of the POI Terminal. They are the POI capabilities the POI System allows the Sale System to use. These POI capabilities include the logical devices enumerated in the devices data element (most of these devices could be on the POI part), plus card reader devices. Sent in the Login Response to identify the devices of the POI Terminal which can be used by the Sale System during the session. + + Possible values: + + * **CashHandling** + + * **CashierDisplay** + + * **CashierError** + + * **CashierInput** + + * **CustomerDisplay** + + * **CustomerError** + + * **CustomerInput** + + * **EMVContactless** + + * **ICC** + + * **MagStripe** + + * **PrinterDocument** + + * **PrinterReceipt** + + * **PrinterVoucher**' items: type: string enum: @@ -726,8 +880,18 @@ components: - Voucher OutputFormat: type: string - description: Format of the content to display or print. Display or print device + description: 'Format of the content to display or print. Display or print device function. + + Possible values: + + * **BarCode** + + * **MessageRef** + + * **Text** + + * **XHTML**' enum: - BarCode - MessageRef @@ -771,8 +935,24 @@ components: - Right BarcodeType: type: string - description: Type of Barcode coding. Qualification of the barcode value to display - or print. + description: 'Type of Barcode coding. Qualification of the barcode value to + display or print. + + Possible values: + + * **Code128** + + * **Code25** + + * **EAN13** + + * **EAN8** + + * **PDF417** + + * **QRCode** + + * **UPCA**' enum: - Code128 - Code25 @@ -783,7 +963,17 @@ components: - UPCA MenuEntryTag: type: string - description: Characteristics related to the selection of a menu entry. + description: 'Characteristics related to the selection of a menu entry. + + Possible values: + + * **NonSelectable** + + * **NonSelectableSubMenu** + + * **Selectable** + + * **SubMenu**' enum: - NonSelectable - NonSelectableSubMenu @@ -795,7 +985,8 @@ components: \ message:\n - Starts a transaction by a swipe-ahead mechanism, with the\ \ services which are enabled.\n - Aborts a swipe-ahead transaction or started\ \ by a `CardAcquisition`, and not followed by a service request from the Sale\ - \ System to complete the transaction." + \ System to complete the transaction.\nPossible values:\n* **AbortTransaction**\n\ + * **StartTransaction**" enum: - AbortTransaction - StartTransaction @@ -803,7 +994,15 @@ components: type: array description: 'Services which are enabled before the start-up of a transaction. - Mandatory if `TransactionAction` is `StartTransaction`, absent if not.' + Mandatory if `TransactionAction` is `StartTransaction`, absent if not. + + Possible values: + + * **CardAcquisition** + + * **Loyalty** + + * **Payment**' items: type: string enum: @@ -881,8 +1080,18 @@ components: - Point IdentificationSupport: type: string - description: Support of the loyalty account identification. Allows knowing where - and how you have found the loyalty account identification. + description: 'Support of the loyalty account identification. Allows knowing + where and how you have found the loyalty account identification. + + Possible values: + + * **HybridCard** + + * **LinkedCard** + + * **LoyaltyCard** + + * **NoCard**' enum: - HybridCard - LinkedCard @@ -890,15 +1099,33 @@ components: - NoCard InstalmentType: type: string - description: Type of instalment transaction. For requesting an instalment payment + description: 'Type of instalment transaction. For requesting an instalment payment transaction. + + Possible values: + + * **DeferredInstalments** + + * **EqualInstalments** + + * **InequalInstalments**' enum: - DeferredInstalments - EqualInstalments - InequalInstalments PeriodUnit: type: string - description: Type of instalment transaction. + description: 'Type of instalment transaction. + + Possible values: + + * **Annual** + + * **Daily** + + * **Monthly** + + * **Weekly**' enum: - Annual - Daily @@ -939,8 +1166,32 @@ components: - Voucher AuthenticationMethod: type: array - description: Method for customer authentication. Allows the Sale System informed + description: 'Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. + + Possible values: + + * **Bypass** + + * **ManualVerification** + + * **MerchantAuthentication** + + * **OfflinePIN** + + * **OnlinePIN** + + * **PaperSignature** + + * **SecureCertificate** + + * **SecureNoCertificate** + + * **SecuredChannel** + + * **SignatureCapture** + + * **UnknownMethod**' items: type: string enum: @@ -963,7 +1214,8 @@ components: \ item amount, or sale items.\n * **Redemption**: redemption on a loyalty\ \ account.\n * **AwardRefund**: refund of a loyalty award transaction.\n\ \ * **RebateRefund**: refund of a loyalty rebate transaction.\n * **RedemptionRefund**:\ - \ refund of a loyalty redemption transaction." + \ refund of a loyalty redemption transaction.\nPossible values:\n* **Award**\n\ + * **AwardRefund**\n* **Rebate**\n* **RebateRefund**\n* **Redemption**\n* **RedemptionRefund**" enum: - Award - AwardRefund @@ -982,7 +1234,17 @@ components: - Unload ReversalReason: type: string - description: Reason of the payment or loyalty reversal.. + description: 'Reason of the payment or loyalty reversal.. + + Possible values: + + * **CustCancel** + + * **Malfunction** + + * **MerchantCancel** + + * **Unable2Compl**' enum: - CustCancel - Malfunction @@ -1023,7 +1285,19 @@ components: of the Sale to POI reconciliation. Required to present totals per value of element included in this cluster (POI - Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID).' + Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID). + + Possible values: + + * **OperatorID** + + * **POIID** + + * **SaleID** + + * **ShiftNumber** + + * **TotalsGroupID**' items: type: string enum: @@ -1034,8 +1308,26 @@ components: - TotalsGroupID AccountType: type: string - description: Type of cardholder account used for the transaction. Allows a cardholder - to select the type of account used for the transaction. + description: 'Type of cardholder account used for the transaction. Allows a + cardholder to select the type of account used for the transaction. + + Possible values: + + * **CardTotals** + + * **Checking** + + * **CreditCard** + + * **Default** + + * **EpurseCard** + + * **Investment** + + * **Savings** + + * **Universal**' enum: - CardTotals - Checking @@ -1084,7 +1376,43 @@ components: - Service EventToNotify: type: string - description: Event the POI notifies to the Sale System. + description: 'Event the POI notifies to the Sale System. + + Possible values: + + * **Abort** + + * **BeginMaintenance** + + * **CardInserted** + + * **CardRemoved** + + * **Completed** + + * **CustomerLanguage** + + * **EndMaintenance** + + * **Initialised** + + * **KeyPressed** + + * **OutOfOrder** + + * **Reject** + + * **SaleAdmin** + + * **SaleWakeUp** + + * **SecurityAlarm** + + * **Shutdown** + + * **StopAssistance** + + * **UseAnotherCardForPreauth**' enum: - Abort - BeginMaintenance @@ -1143,7 +1471,15 @@ components: - ISO3 PINRequestType: type: string - description: Type of PIN Service. + description: 'Type of PIN Service. + + Possible values: + + * **PINEnter** + + * **PINVerify** + + * **PINVerifyOnly**' enum: - PINEnter - PINVerify @@ -1178,7 +1514,13 @@ components: description: Card track number. TrackFormat: $ref: '#/components/schemas/TrackFormat' - description: Card track format. + description: 'Card track format. + + Possible values: + + * **AAMVA** + + * **ISO**' TrackValue: type: string pattern: ^.{1,104}$ @@ -1239,7 +1581,8 @@ components: $ref: '#/components/schemas/TokenRequestedType' description: "Type of token replacing the PAN of a payment card to identify\ \ the payment\n mean of the customer. It allows, for a merchant, to use\ - \ a token for a transaction\n only or for a longer period." + \ a token for a transaction\n only or for a longer period.\nPossible values:\n\ + * **Customer**\n* **Transaction**" TokenValue: type: string pattern: ^.+$ @@ -1388,11 +1731,35 @@ components: control of the card issuer, and cannot be used for a payment transaction. EntryMode: $ref: '#/components/schemas/EntryMode' - description: Entry mode of the payment instrument information. In the Payment, + description: 'Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. + + Possible values: + + * **Contactless** + + * **File** + + * **ICC** + + * **Keyed** + + * **MagStripe** + + * **Manual** + + * **Mobile** + + * **RFID** + + * **Scanned** + + * **SynchronousICC** + + * **Tapped**' CardCountryCode: type: integer minimum: 3 @@ -1553,15 +1920,24 @@ components: $ref: '#/components/schemas/TokenRequestedType' description: "Type of token replacing the PAN of a payment card to identify\ \ the payment\n mean of the customer. It allows, for a merchant, to use\ - \ a token for a transaction\n only or for a longer period." + \ a token for a transaction\n only or for a longer period.\nPossible values:\n\ + * **Customer**\n* **Transaction**" CustomerOrderID: type: string pattern: ^.+$ description: Additional and optional identification of a customer order. CustomerOrderReq: $ref: '#/components/schemas/CustomerOrderReq' - description: List of customer order open, closed or both to be sent in the - response messages. + description: 'List of customer order open, closed or both to be sent in + the response messages. + + Possible values: + + * **Both** + + * **Closed** + + * **Open**' SaleToPOIData: type: string pattern: ^.+$ @@ -1676,7 +2052,17 @@ components: properties: GlobalStatus: $ref: '#/components/schemas/GlobalStatus' - description: Global status of a POI Server or POI Terminal. + description: 'Global status of a POI Server or POI Terminal. + + Possible values: + + * **Busy** + + * **Maintenance** + + * **OK** + + * **Unreachable**' SecurityOKFlag: type: boolean description: 'Indicates if the security module of the POI is working and @@ -1695,6 +2081,17 @@ components: If card reader device present.' PrinterStatus: $ref: '#/components/schemas/PrinterStatus' + description: 'Possible values: + + * **NoPaper** + + * **OK** + + * **OutOfOrder** + + * **PaperJam** + + * **PaperLow**' CommunicationOKFlag: type: boolean description: 'Indicates if the communication infrastructure is working and @@ -1729,13 +2126,57 @@ components: properties: Result: $ref: '#/components/schemas/Result' - description: Result of the processing of the message. + description: 'Result of the processing of the message. + + Possible values: + + * **Failure** + + * **Partial** + + * **Success**' ErrorCondition: $ref: '#/components/schemas/ErrorCondition' description: 'Condition that has produced an error on the processing of a message request. - Returned if Result is not Success.' + Returned if Result is not Success. + + Possible values: + + * **Aborted** + + * **Busy** + + * **Cancel** + + * **DeviceOut** + + * **InProgress** + + * **InsertedCard** + + * **InvalidCard** + + * **LoggedOut** + + * **MessageFormat** + + * **NotAllowed** + + * **NotFound** + + * **PaymentRestriction** + + * **Refusal** + + * **UnavailableDevice** + + * **UnavailableService** + + * **UnreachableHost** + + * **WrongPIN**' AdditionalResponse: type: string pattern: ^.+$ @@ -1785,8 +2226,36 @@ components: properties: GenericProfile: $ref: '#/components/schemas/GenericProfile' + description: 'Possible values: + + * **Basic** + + * **Extended** + + * **Standard**' ServiceProfiles: $ref: '#/components/schemas/ServiceProfiles' + description: 'Possible values: + + * **Batch** + + * **CardReader** + + * **Communication** + + * **Loyalty** + + * **OneTimeRes** + + * **PIN** + + * **Reservation** + + * **Sound** + + * **StoredValue** + + * **Synchro**' POITerminalData: type: object description: Information related to the software and hardware features of the @@ -1795,17 +2264,53 @@ components: properties: TerminalEnvironment: $ref: '#/components/schemas/TerminalEnvironment' - description: Environment of the Terminal. Sent in the Login Request (Response) + description: 'Environment of the Terminal. Sent in the Login Request (Response) to identify the environment of the Sale System (POI System) during the session. In other message, when the data has changed since the Login. + + Possible values: + + * **Attended** + + * **SemiAttended** + + * **Unattended**' POICapabilities: $ref: '#/components/schemas/POICapabilities' - description: Hardware capabilities of the POI Terminal. They are the POI + description: 'Hardware capabilities of the POI Terminal. They are the POI capabilities the POI System allows the Sale System to use. These POI capabilities include the logical devices enumerated in the devices data element (most of these devices could be on the POI part), plus card reader devices. Sent in the Login Response to identify the devices of the POI Terminal which can be used by the Sale System during the session. + + Possible values: + + * **CashHandling** + + * **CashierDisplay** + + * **CashierError** + + * **CashierInput** + + * **CustomerDisplay** + + * **CustomerError** + + * **CustomerInput** + + * **EMVContactless** + + * **ICC** + + * **MagStripe** + + * **PrinterDocument** + + * **PrinterReceipt** + + * **PrinterVoucher**' POIProfile: $ref: '#/components/schemas/POIProfile' description: Functional profile of the POI Terminal. Sent in the Login Response @@ -1869,24 +2374,76 @@ components: description: Column where the text string has to be displayed or printed. Color: $ref: '#/components/schemas/Color' - description: Color of the text string to display or print. + description: 'Color of the text string to display or print. + + Possible values: + + * **Black** + + * **Blue** + + * **Cyan** + + * **Green** + + * **Magenta** + + * **Red** + + * **White** + + * **Yellow**' CharacterWidth: $ref: '#/components/schemas/CharacterWidth' - description: Character width of the text string to display or print. Absence + description: 'Character width of the text string to display or print. Absence of this data element means the characters have normal width. + + Possible values: + + * **DoubleWidth** + + * **SingleWidth**' CharacterHeight: $ref: '#/components/schemas/CharacterHeight' - description: Character height of the text string to display or print. Absence + description: 'Character height of the text string to display or print. Absence of this data element means the characters have normal height. + + Possible values: + + * **DoubleHeight** + + * **HalfHeight** + + * **SingleHeight**' CharacterStyle: $ref: '#/components/schemas/CharacterStyle' - description: Typographic style of the sequence of characters to display + description: 'Typographic style of the sequence of characters to display or print. Absence of this data element means the characters have normal style. + + Possible values: + + * **Bold** + + * **Italic** + + * **Normal** + + * **Underline**' Alignment: $ref: '#/components/schemas/Alignment' - description: Alignment of the text string on the display line or print line. - Absence of this data element means the characters have normal alignment. + description: 'Alignment of the text string on the display line or print + line. Absence of this data element means the characters have normal alignment. + + Possible values: + + * **Centred** + + * **Justified** + + * **Left** + + * **Right**' EndOfLineFlag: type: boolean default: true @@ -1916,8 +2473,24 @@ components: properties: BarcodeType: $ref: '#/components/schemas/BarcodeType' - description: Type of Barcode coding. Qualification of the barcode value + description: 'Type of Barcode coding. Qualification of the barcode value to display or print. + + Possible values: + + * **Code128** + + * **Code25** + + * **EAN13** + + * **EAN8** + + * **PDF417** + + * **QRCode** + + * **UPCA**' BarcodeValue: type: string pattern: ^.+$ @@ -1933,7 +2506,17 @@ components: properties: OutputFormat: $ref: '#/components/schemas/OutputFormat' - description: Format of the content to display or print. + description: 'Format of the content to display or print. + + Possible values: + + * **BarCode** + + * **MessageRef** + + * **Text** + + * **XHTML**' PredefinedContent: $ref: '#/components/schemas/PredefinedContent' description: 'Reference of a predefined message to display or print. @@ -1971,7 +2554,17 @@ components: properties: MenuEntryTag: $ref: '#/components/schemas/MenuEntryTag' - description: Characteristics related to the selection of a menu entry. + description: 'Characteristics related to the selection of a menu entry. + + Possible values: + + * **NonSelectable** + + * **NonSelectableSubMenu** + + * **Selectable** + + * **SubMenu**' DefaultSelectedFlag: type: boolean default: false @@ -1980,6 +2573,15 @@ components: user action. OutputFormat: $ref: '#/components/schemas/OutputFormat' + description: 'Possible values: + + * **BarCode** + + * **MessageRef** + + * **Text** + + * **XHTML**' PredefinedContent: $ref: '#/components/schemas/PredefinedContent' OutputText: @@ -2017,15 +2619,47 @@ components: description: Number of seconds the message has to be displayed. Device: $ref: '#/components/schemas/Device' - description: Logical device located on a Sale Terminal or a POI Terminal, + description: 'Logical device located on a Sale Terminal or a POI Terminal, in terms of class of information to output (display, print, or store), or input (keyboard) for the Cashier or the Customer. + + Possible values: + + * **CashierDisplay** + + * **CashierInput** + + * **CustomerDisplay** + + * **CustomerInput**' InfoQualify: $ref: '#/components/schemas/InfoQualify' - description: Qualification of the information to sent to an output logical + description: 'Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer. Allows the manager of the device, Sale or POI Terminal, to send the information to a particular physical device or to present the information accordingly. + + Possible values: + + * **CustomerAssistance** + + * **Display** + + * **Document** + + * **Error** + + * **Input** + + * **POIReplication** + + * **Receipt** + + * **Sound** + + * **Status** + + * **Voucher**' OutputContent: $ref: '#/components/schemas/OutputContent' description: Content to display or print. @@ -2075,7 +2709,47 @@ components: $ref: '#/components/schemas/UnitOfMeasure' description: 'Unit of measure of a quantity. - If Quantity is present.' + If Quantity is present. + + Possible values: + + * **Case** + + * **Centilitre** + + * **Centimetre** + + * **Foot** + + * **Gram** + + * **Inch** + + * **Kilogram** + + * **Kilometre** + + * **Litre** + + * **Meter** + + * **Mile** + + * **Other** + + * **Ounce** + + * **Pint** + + * **Pound** + + * **Quart** + + * **UKGallon** + + * **USGallon** + + * **Yard**' Quantity: type: string description: 'Product quantity. @@ -2131,8 +2805,14 @@ components: properties: LoyaltyUnit: $ref: '#/components/schemas/LoyaltyUnit' - description: Unit of a loyalty amount. The amount could be expressed in + description: 'Unit of a loyalty amount. The amount could be expressed in point or in a monetary value and a currency. + + Possible values: + + * **Monetary** + + * **Point**' Currency: type: string pattern: ^[A-Z]{3,3}$ @@ -2154,22 +2834,68 @@ components: properties: EntryMode: $ref: '#/components/schemas/EntryMode' - description: Entry mode of the payment instrument information. In the Payment, + description: 'Entry mode of the payment instrument information. In the Payment, Loyalty or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. In the Payment, Loyalty or StoredValue Response messages, it informs the Sale System the entry mode of the payment instrument. + + Possible values: + + * **Contactless** + + * **File** + + * **ICC** + + * **Keyed** + + * **MagStripe** + + * **Manual** + + * **Mobile** + + * **RFID** + + * **Scanned** + + * **SynchronousICC** + + * **Tapped**' IdentificationType: $ref: '#/components/schemas/IdentificationType' - description: Type of account identification. In a request message, it informs + description: 'Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification. + + Possible values: + + * **AccountNumber** + + * **BarCode** + + * **ISOTrack2** + + * **PAN** + + * **PhoneNumber**' IdentificationSupport: $ref: '#/components/schemas/IdentificationSupport' - description: Support of the loyalty account identification. Allows knowing + description: 'Support of the loyalty account identification. Allows knowing where and how you have found the loyalty account identification. + + Possible values: + + * **HybridCard** + + * **LinkedCard** + + * **LoyaltyCard** + + * **NoCard**' LoyaltyID: type: string description: Loyalty account identification conforming to the IdentificationType. @@ -2239,7 +2965,13 @@ components: If provided by the customer.' TypeCode: $ref: '#/components/schemas/TypeCode' - description: Type of bank check. + description: 'Type of bank check. + + Possible values: + + * **Company** + + * **Personal**' Country: type: string pattern: ^[A-Z]{3,3}$ @@ -2356,8 +3088,16 @@ components: properties: InstalmentType: $ref: '#/components/schemas/InstalmentType' - description: Type of instalment transaction. For requesting an instalment + description: 'Type of instalment transaction. For requesting an instalment payment transaction. + + Possible values: + + * **DeferredInstalments** + + * **EqualInstalments** + + * **InequalInstalments**' SequenceNumber: type: integer description: Sequence number of the instalment. For an instalment payment @@ -2372,7 +3112,17 @@ components: 2 payment instalments. PeriodUnit: $ref: '#/components/schemas/PeriodUnit' - description: Type of instalment transaction. + description: 'Type of instalment transaction. + + Possible values: + + * **Annual** + + * **Daily** + + * **Monthly** + + * **Weekly**' FirstPaymentDate: type: string format: date @@ -2406,8 +3156,16 @@ components: properties: StoredValueAccountType: $ref: '#/components/schemas/StoredValueAccountType' - description: Type of stored value account. Allows the distinction of the + description: 'Type of stored value account. Allows the distinction of the stored value instrument to access the stored value account. + + Possible values: + + * **GiftCard** + + * **Other** + + * **PhoneCard**' StoredValueProvider: type: string pattern: ^.+$ @@ -2427,18 +3185,54 @@ components: is present, it overrides Track2 information. Format is MMYY. EntryMode: $ref: '#/components/schemas/EntryMode' - description: Entry mode of the payment instrument information. In the Payment, + description: 'Entry mode of the payment instrument information. In the Payment, Loyalty, or StoredValue Request messages, it informs the POI System the entry mode of the payment instrument information when read by the Sale Terminal. (e.g. because the payment instrument information are a barcode read by the Cashier on a scanner device). + + Possible values: + + * **Contactless** + + * **File** + + * **ICC** + + * **Keyed** + + * **MagStripe** + + * **Manual** + + * **Mobile** + + * **RFID** + + * **Scanned** + + * **SynchronousICC** + + * **Tapped**' IdentificationType: $ref: '#/components/schemas/IdentificationType' - description: Type of account identification. In a request message, it informs + description: 'Type of account identification. In a request message, it informs the POI System the type of the account or card identification, when provided by the Sale Terminal. (e.g. because the card information is a barcode read by the Cashier on a scanner device). In a response message, it informs the Sale System the type of the account or card identification. + + Possible values: + + * **AccountNumber** + + * **BarCode** + + * **ISOTrack2** + + * **PAN** + + * **PhoneNumber**' StoredValueID: type: string pattern: ^.+$ @@ -2458,7 +3252,19 @@ components: properties: PaymentInstrumentType: $ref: '#/components/schemas/PaymentInstrumentType' - description: Type of payment instrument. + description: 'Type of payment instrument. + + Possible values: + + * **Card** + + * **Cash** + + * **Check** + + * **Mobile** + + * **StoredValue**' ProtectedCardData: type: string description: 'Sensitive information related to the payment card, protected @@ -2518,13 +3324,6 @@ components: description: 'Code assigned to a transaction approval by the Acquirer. If referral.' - CustomerLanguage: - type: string - pattern: ^[a-z]{2,2}$ - description: 'Language of the Customer. - - If the language is selected by the Sale System before the request to the - POI.' AcquirerID: type: integer description: 'Identification of the Acquirer. @@ -2589,14 +3388,19 @@ components: Restrict brand if data sent.' LoyaltyHandling: $ref: '#/components/schemas/LoyaltyHandling' - description: Type of Loyalty processing requested by the Sale System. - CustomerLanguage: - type: string - pattern: ^[a-z]{2,2}$ - description: 'Language of the Customer. + description: 'Type of Loyalty processing requested by the Sale System. - If the language is selected by the Sale System before the request to the - POI.' + Possible values: + + * **Allowed** + + * **Forbidden** + + * **Processed** + + * **Proposed** + + * **Required**' ForceOnlineFlag: type: boolean default: false @@ -2608,7 +3412,31 @@ components: $ref: '#/components/schemas/ForceEntryMode' description: 'Payment instrument entry mode requested by the Sale System. - Restrict entry mode if sent.' + Restrict entry mode if sent. + + Possible values: + + * **CheckReader** + + * **Contactless** + + * **File** + + * **ICC** + + * **Keyed** + + * **MagStripe** + + * **Manual** + + * **RFID** + + * **Scanned** + + * **SynchronousICC** + + * **Tapped**' MerchantCategoryCode: type: string pattern: ^.{3,4}$ @@ -2621,8 +3449,34 @@ components: properties: PaymentType: $ref: '#/components/schemas/PaymentType' - description: Type of payment transaction. Elements requested by the Sale + description: 'Type of payment transaction. Elements requested by the Sale System that are related to the payment only. + + Possible values: + + * **CashAdvance** + + * **CashDeposit** + + * **Completion** + + * **FirstReservation** + + * **Instalment** + + * **IssuerInstalment** + + * **Normal** + + * **OneTimeReservation** + + * **PaidOut** + + * **Recurring** + + * **Refund** + + * **UpdateReservation**' SplitPaymentFlag: type: boolean default: false @@ -2809,7 +3663,47 @@ components: $ref: '#/components/schemas/UnitOfMeasure' description: 'Unit of measure of a quantity. - If Quantity present.' + If Quantity present. + + Possible values: + + * **Case** + + * **Centilitre** + + * **Centimetre** + + * **Foot** + + * **Gram** + + * **Inch** + + * **Kilogram** + + * **Kilometre** + + * **Litre** + + * **Meter** + + * **Mile** + + * **Other** + + * **Ounce** + + * **Pint** + + * **Pound** + + * **Quart** + + * **UKGallon** + + * **USGallon** + + * **Yard**' Quantity: type: string description: 'Product quantity. @@ -2937,7 +3831,21 @@ components: description: 'Qualification of the document to print to the Cashier or the Customer. - SaleReceipt or CashierReceipt.' + SaleReceipt or CashierReceipt. + + Possible values: + + * **CashierReceipt** + + * **CustomerReceipt** + + * **Document** + + * **Journal** + + * **SaleReceipt** + + * **Voucher**' IntegratedPrintFlag: type: boolean description: Type of the print integrated to other prints. @@ -3063,8 +3971,34 @@ components: properties: PaymentType: $ref: '#/components/schemas/PaymentType' - description: Type of payment transaction. Elements requested by the Sale + description: 'Type of payment transaction. Elements requested by the Sale System that are related to the payment only. + + Possible values: + + * **CashAdvance** + + * **CashDeposit** + + * **Completion** + + * **FirstReservation** + + * **Instalment** + + * **IssuerInstalment** + + * **Normal** + + * **OneTimeReservation** + + * **PaidOut** + + * **Recurring** + + * **Refund** + + * **UpdateReservation**' PaymentInstrumentData: $ref: '#/components/schemas/PaymentInstrumentData' AmountsResp: @@ -3110,11 +4044,6 @@ components: includes the start and end tags for an XML encoding, the identifier and length bytes for an ASN.1 encoding, and the complete member ProtectedSignature for a JSON encoding. - CustomerLanguage: - type: string - pattern: ^[a-z]{2,2}$ - description: Language of the Customer. Allows choice of the Customer language - when the POI displays messages or print text to Merchant interface. OnlineFlag: type: boolean default: true @@ -3123,8 +4052,32 @@ components: was online or offline. AuthenticationMethod: $ref: '#/components/schemas/AuthenticationMethod' - description: Method for customer authentication. Allows the Sale System + description: 'Method for customer authentication. Allows the Sale System informed about customer authentication for the payment transaction. + + Possible values: + + * **Bypass** + + * **ManualVerification** + + * **MerchantAuthentication** + + * **OfflinePIN** + + * **OnlinePIN** + + * **PaperSignature** + + * **SecureCertificate** + + * **SecureNoCertificate** + + * **SecuredChannel** + + * **SignatureCapture** + + * **UnknownMethod**' ValidityDate: type: string format: date @@ -3155,18 +4108,49 @@ components: loyalty transaction. LoyaltyHandling: $ref: '#/components/schemas/LoyaltyHandling' - description: Type of Loyalty processing requested by the Sale System. An + description: 'Type of Loyalty processing requested by the Sale System. An way to specify what the POI has to handle concerning the loyalty. - CustomerLanguage: - type: string - pattern: ^[a-z]{2,2}$ - description: Language of the Customer. Allows choice of the Customer language - when the POI displays messages or print text to Merchant interface. + + Possible values: + + * **Allowed** + + * **Forbidden** + + * **Processed** + + * **Proposed** + + * **Required**' ForceEntryMode: $ref: '#/components/schemas/ForceEntryMode' - description: Payment instrument entry mode requested by the Sale System. + description: 'Payment instrument entry mode requested by the Sale System. Avoid retry on an out of order card reading device, when the sale system knows that some card entry modes on the POI do not work. + + Possible values: + + * **CheckReader** + + * **Contactless** + + * **File** + + * **ICC** + + * **Keyed** + + * **MagStripe** + + * **Manual** + + * **RFID** + + * **Scanned** + + * **SynchronousICC** + + * **Tapped**' ForceCustomerSelectionFlag: type: boolean description: Indicates if the Customer realises the selection of the card @@ -3179,8 +4163,34 @@ components: it allows the processing of a contactless card. PaymentType: $ref: '#/components/schemas/PaymentType' - description: Type of payment transaction. Elements requested by the Sale + description: 'Type of payment transaction. Elements requested by the Sale System that are related to the payment only. + + Possible values: + + * **CashAdvance** + + * **CashDeposit** + + * **Completion** + + * **FirstReservation** + + * **Instalment** + + * **IssuerInstalment** + + * **Normal** + + * **OneTimeReservation** + + * **PaidOut** + + * **Recurring** + + * **Refund** + + * **UpdateReservation**' CashBackFlag: type: boolean description: Cash back has been requested with the payment transaction. @@ -3197,7 +4207,9 @@ components: \ sale item amount, or sale items.\n * **Redemption**: redemption on\ \ a loyalty account.\n * **AwardRefund**: refund of a loyalty award transaction.\n\ \ * **RebateRefund**: refund of a loyalty rebate transaction.\n * **RedemptionRefund**:\ - \ refund of a loyalty redemption transaction." + \ refund of a loyalty redemption transaction.\nPossible values:\n* **Award**\n\ + * **AwardRefund**\n* **Rebate**\n* **RebateRefund**\n* **Redemption**\n\ + * **RedemptionRefund**" Currency: type: string pattern: ^[A-Z]{3,3}$ @@ -3244,8 +4256,22 @@ components: absent.' StoredValueTransactionType: $ref: '#/components/schemas/StoredValueTransactionType' - description: Identification of operation to proceed on the stored value + description: 'Identification of operation to proceed on the stored value account or the stored value card. + + Possible values: + + * **Activate** + + * **Duplicate** + + * **Load** + + * **Reserve** + + * **Reverse** + + * **Unload**' StoredValueAccountID: $ref: '#/components/schemas/StoredValueAccountID' description: 'Identification of the stored value account or the stored value @@ -3301,7 +4327,21 @@ components: description: 'Identification of operation to proceed on the stored value account or the stored value card. - Copy.' + Copy. + + Possible values: + + * **Activate** + + * **Duplicate** + + * **Load** + + * **Reserve** + + * **Reverse** + + * **Unload**' ProductCode: type: integer minimum: 1 @@ -3366,7 +4406,47 @@ components: description: 'Type of transaction for which totals are grouped. Debit, Credit, ReverseDebit, ReverseCredit, OneTimeReservation, CompletedDeffered, - FirstReservation, UpdateReservation, CompletedReservation, CashAdvance.' + FirstReservation, UpdateReservation, CompletedReservation, CashAdvance. + + Possible values: + + * **Award** + + * **CashAdvance** + + * **CompletedDeffered** + + * **CompletedReservation** + + * **Credit** + + * **Debit** + + * **Declined** + + * **Failed** + + * **FirstReservation** + + * **IssuerInstalment** + + * **OneTimeReservation** + + * **Rebate** + + * **Redemption** + + * **ReverseAward** + + * **ReverseCredit** + + * **ReverseDebit** + + * **ReverseRebate** + + * **ReverseRedemption** + + * **UpdateReservation**' TransactionCount: type: integer description: Number of processed transaction during the period. @@ -3387,7 +4467,47 @@ components: $ref: '#/components/schemas/TransactionType' description: 'Type of transaction for which totals are grouped. - Award, ReverseAward, Redemption, ReverseRedemption, Rebate, ReverseRebate.' + Award, ReverseAward, Redemption, ReverseRedemption, Rebate, ReverseRebate. + + Possible values: + + * **Award** + + * **CashAdvance** + + * **CompletedDeffered** + + * **CompletedReservation** + + * **Credit** + + * **Debit** + + * **Declined** + + * **Failed** + + * **FirstReservation** + + * **IssuerInstalment** + + * **OneTimeReservation** + + * **Rebate** + + * **Redemption** + + * **ReverseAward** + + * **ReverseCredit** + + * **ReverseDebit** + + * **ReverseRebate** + + * **ReverseRedemption** + + * **UpdateReservation**' TransactionCount: type: integer description: Number of processed transaction during the period. @@ -3410,7 +4530,19 @@ components: properties: PaymentInstrumentType: $ref: '#/components/schemas/PaymentInstrumentType' - description: Type of payment instrument. + description: 'Type of payment instrument. + + Possible values: + + * **Card** + + * **Cash** + + * **Check** + + * **Mobile** + + * **StoredValue**' AcquirerID: type: integer description: Identification of the Acquirer. @@ -3473,7 +4605,13 @@ components: If both `TransactionCount` and `TransactionAmount` are not equal to zero.' LoyaltyUnit: $ref: '#/components/schemas/LoyaltyUnit' - description: Unit of a loyalty amount. + description: 'Unit of a loyalty amount. + + Possible values: + + * **Monetary** + + * **Point**' LoyaltyCurrency: type: string pattern: ^[A-Z]{3,3}$ @@ -3521,8 +4659,26 @@ components: properties: AccountType: $ref: '#/components/schemas/AccountType' - description: Type of cardholder account used for the transaction. Allows + description: 'Type of cardholder account used for the transaction. Allows a cardholder to select the type of account used for the transaction. + + Possible values: + + * **CardTotals** + + * **Checking** + + * **CreditCard** + + * **Default** + + * **EpurseCard** + + * **Investment** + + * **Savings** + + * **Universal**' CardAcquisitionReference: $ref: '#/components/schemas/TransactionIDType' PaymentInstrumentData: @@ -3562,8 +4718,14 @@ components: description: Balance of an account after processing of the transaction. LoyaltyUnit: $ref: '#/components/schemas/LoyaltyUnit' - description: Unit of a loyalty amount. The amount could be expressed in + description: 'Unit of a loyalty amount. The amount could be expressed in point or in a monetary value and a currency. + + Possible values: + + * **Monetary** + + * **Point**' Currency: type: string pattern: ^[A-Z]{3,3}$ @@ -3583,7 +4745,65 @@ components: description: 'Category of message. CardAcquisition, Display, Input, Loyalty, Payment, Print, CardReaderAPDU, - CardReaderInit, CardReaderPowerOff.' + CardReaderInit, CardReaderPowerOff. + + Possible values: + + * **Abort** + + * **Admin** + + * **BalanceInquiry** + + * **Batch** + + * **CardAcquisition** + + * **CardReaderAPDU** + + * **CardReaderInit** + + * **CardReaderPowerOff** + + * **Diagnosis** + + * **Display** + + * **EnableService** + + * **Event** + + * **GetTotals** + + * **Input** + + * **InputUpdate** + + * **Login** + + * **Logout** + + * **Loyalty** + + * **None** + + * **PIN** + + * **Payment** + + * **Print** + + * **Reconciliation** + + * **Reversal** + + * **Sound** + + * **StoredValue** + + * **TransactionStatus** + + * **Transmit**' ServiceID: type: string pattern: ^.{1,10}$ @@ -3618,13 +4838,87 @@ components: description: If MessageCategory is Login or Diagnosis. MessageClass: $ref: '#/components/schemas/MessageClass' - description: Class of the message. + description: 'Class of the message. + + Possible values: + + * **Device** + + * **Event** + + * **Service**' MessageCategory: $ref: '#/components/schemas/MessageCategory' - description: Category of message. + description: 'Category of message. + + Possible values: + + * **Abort** + + * **Admin** + + * **BalanceInquiry** + + * **Batch** + + * **CardAcquisition** + + * **CardReaderAPDU** + + * **CardReaderInit** + + * **CardReaderPowerOff** + + * **Diagnosis** + + * **Display** + + * **EnableService** + + * **Event** + + * **GetTotals** + + * **Input** + + * **InputUpdate** + + * **Login** + + * **Logout** + + * **Loyalty** + + * **None** + + * **PIN** + + * **Payment** + + * **Print** + + * **Reconciliation** + + * **Reversal** + + * **Sound** + + * **StoredValue** + + * **TransactionStatus** + + * **Transmit**' MessageType: $ref: '#/components/schemas/MessageType' - description: Type of message of the Sale to POI protocol. + description: 'Type of message of the Sale to POI protocol. + + Possible values: + + * **Notification** + + * **Request** + + * **Response**' ServiceID: type: string pattern: ^.{1,10}$ @@ -3707,13 +5001,45 @@ components: in term of class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer. - Copy.' + Copy. + + Possible values: + + * **CashierDisplay** + + * **CashierInput** + + * **CustomerDisplay** + + * **CustomerInput**' InfoQualify: $ref: '#/components/schemas/InfoQualify' description: 'Qualification of the information to sent to an output logical device, to display or print to the Cashier or the Customer. - Copy.' + Copy. + + Possible values: + + * **CustomerAssistance** + + * **Display** + + * **Document** + + * **Error** + + * **Input** + + * **POIReplication** + + * **Receipt** + + * **Sound** + + * **Status** + + * **Voucher**' Response: $ref: '#/components/schemas/Response' description: Result of a message request processing. @@ -3726,17 +5052,69 @@ components: properties: Device: $ref: '#/components/schemas/Device' - description: Logical device located on a Sale Terminal or a POI Terminal, + description: 'Logical device located on a Sale Terminal or a POI Terminal, regarding the class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer. + + Possible values: + + * **CashierDisplay** + + * **CashierInput** + + * **CustomerDisplay** + + * **CustomerInput**' InfoQualify: $ref: '#/components/schemas/InfoQualify' - description: Qualification of the information to send to an output logical + description: 'Qualification of the information to send to an output logical device, to display or print to the Cashier or the Customer. + + Possible values: + + * **CustomerAssistance** + + * **Display** + + * **Document** + + * **Error** + + * **Input** + + * **POIReplication** + + * **Receipt** + + * **Sound** + + * **Status** + + * **Voucher**' InputCommand: $ref: '#/components/schemas/InputCommand' description: 'Type of requested input. Can be: **GetConfirmation**, **TextString**, - **DigitString**, **DecimalString** or **GetMenuEntry**.' + **DigitString**, **DecimalString** or **GetMenuEntry**. + + Possible values: + + * **DecimalString** + + * **DigitString** + + * **GetAnyKey** + + * **GetConfirmation** + + * **GetFunctionKey** + + * **GetMenuEntry** + + * **Password** + + * **SiteManager** + + * **TextString**' NotifyCardInputFlag: type: boolean default: false @@ -3841,7 +5219,27 @@ components: InputCommand: $ref: '#/components/schemas/InputCommand' description: 'Type of requested input. Can be: **GetConfirmation**, **TextString**, - **DigitString**, **DecimalString** or **GetMenuEntry**.' + **DigitString**, **DecimalString** or **GetMenuEntry**. + + Possible values: + + * **DecimalString** + + * **DigitString** + + * **GetAnyKey** + + * **GetConfirmation** + + * **GetFunctionKey** + + * **GetMenuEntry** + + * **Password** + + * **SiteManager** + + * **TextString**' ConfirmedFlag: type: boolean description: Indicates te response of the user from the `GetConfirmation` @@ -3881,13 +5279,45 @@ components: properties: Device: $ref: '#/components/schemas/Device' - description: Logical device located on a Sale Terminal or a POI Terminal, + description: 'Logical device located on a Sale Terminal or a POI Terminal, in terms of class of information to output (display, print or store), or input (keyboard) for the Cashier or the Customer. + + Possible values: + + * **CashierDisplay** + + * **CashierInput** + + * **CustomerDisplay** + + * **CustomerInput**' InfoQualify: $ref: '#/components/schemas/InfoQualify' - description: Qualification of the information to send to an output logical + description: 'Qualification of the information to send to an output logical device, to display or print to the Cashier or the Customer. + + Possible values: + + * **CustomerAssistance** + + * **Display** + + * **Document** + + * **Error** + + * **Input** + + * **POIReplication** + + * **Receipt** + + * **Sound** + + * **Status** + + * **Voucher**' Response: $ref: '#/components/schemas/Response' Input: @@ -3902,13 +5332,37 @@ components: properties: DocumentQualifier: $ref: '#/components/schemas/DocumentQualifier' - description: Qualification of the document to print to the Cashier or the + description: 'Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send information to a physical printer or to use the paper type accordingly. + + Possible values: + + * **CashierReceipt** + + * **CustomerReceipt** + + * **Document** + + * **Journal** + + * **SaleReceipt** + + * **Voucher**' ResponseMode: $ref: '#/components/schemas/ResponseMode' - description: Message response awaited by the initiator of the Request. Allows - various types and synchronisation of requests for Print or Sound. + description: 'Message response awaited by the initiator of the Request. + Allows various types and synchronisation of requests for Print or Sound. + + Possible values: + + * **Immediate** + + * **NotRequired** + + * **PrintEnd** + + * **SoundEnd**' IntegratedPrintFlag: type: boolean default: false @@ -3934,6 +5388,13 @@ components: properties: SoundFormat: $ref: '#/components/schemas/SoundFormat' + description: 'Possible values: + + * **MessageRef** + + * **SoundRef** + + * **Text**' Language: type: string pattern: ^[a-z]{2,2}$ @@ -3952,6 +5413,15 @@ components: type: string PINFormat: $ref: '#/components/schemas/PINFormat' + description: 'Possible values: + + * **ISO0** + + * **ISO1** + + * **ISO2** + + * **ISO3**' AdditionalInput: type: string pattern: ^.+$ @@ -4056,11 +5526,20 @@ components: $ref: '#/components/schemas/TokenRequestedType' description: "Type of token replacing the PAN of a payment card to identify\ \ the payment\n mean of the customer. It allows, for a merchant, to use\ - \ a token for a transaction\n only or for a longer period." + \ a token for a transaction\n only or for a longer period.\nPossible values:\n\ + * **Customer**\n* **Transaction**" CustomerOrderReq: $ref: '#/components/schemas/CustomerOrderReq' - description: List of customer order open, closed or both to be sent in the - response messages. + description: 'List of customer order open, closed or both to be sent in + the response messages. + + Possible values: + + * **Both** + + * **Closed** + + * **Open**' POISerialNumber: type: string pattern: ^.+$ @@ -4098,12 +5577,21 @@ components: \ request message:\n - Starts a transaction by a swipe-ahead mechanism,\ \ with the services which are enabled.\n - Aborts a swipe-ahead transaction\ \ or started by a `CardAcquisition`, and not followed by a service request\ - \ from the Sale System to complete the transaction." + \ from the Sale System to complete the transaction.\nPossible values:\n\ + * **AbortTransaction**\n* **StartTransaction**" ServicesEnabled: $ref: '#/components/schemas/ServicesEnabled' description: 'Services which are enabled before the start-up of a transaction. - Mandatory if `TransactionAction` is `StartTransaction`, absent if not.' + Mandatory if `TransactionAction` is `StartTransaction`, absent if not. + + Possible values: + + * **CardAcquisition** + + * **Loyalty** + + * **Payment**' DisplayOutput: $ref: '#/components/schemas/DisplayOutput' description: Information to display and the way to process the display. @@ -4194,13 +5682,6 @@ components: SaleData: $ref: '#/components/schemas/SaleData' description: Data related to the Sale System. - CustomerLanguage: - type: string - pattern: ^[a-z]{2,2}$ - description: 'Language of the Customer. - - If the language is selected by the Sale System before the request to the - POI.' StoredValueData: type: array items: @@ -4230,7 +5711,17 @@ components: ReversedAmount is implicitely the AuthorizedAmount if absent.' ReversalReason: $ref: '#/components/schemas/ReversalReason' - description: Reason of the payment or loyalty reversal.. + description: 'Reason of the payment or loyalty reversal.. + + Possible values: + + * **CustCancel** + + * **Malfunction** + + * **MerchantCancel** + + * **Unable2Compl**' CustomerOrder: $ref: '#/components/schemas/CustomerOrder' required: @@ -4245,7 +5736,17 @@ components: properties: ReconciliationType: $ref: '#/components/schemas/ReconciliationType' - description: Type of Reconciliation requested by the Sale to the POI. + description: 'Type of Reconciliation requested by the Sale to the POI. + + Possible values: + + * **AcquirerReconciliation** + + * **AcquirerSynchronisation** + + * **PreviousReconciliation** + + * **SaleReconciliation**' AcquirerID: type: array items: @@ -4279,7 +5780,19 @@ components: result of the Sale to POI reconciliation. Required to present totals per value of element included in this cluster - (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID).' + (POI Terminal, Sale Terminal, Cashier, Shift, TotalsGroupID). + + Possible values: + + * **OperatorID** + + * **POIID** + + * **SaleID** + + * **ShiftNumber** + + * **TotalsGroupID**' TotalFilter: $ref: '#/components/schemas/TotalFilter' description: 'Filter to compute the totals. @@ -4321,10 +5834,24 @@ components: type: array items: $ref: '#/components/schemas/DocumentQualifier' - description: Qualification of the document to print to the Cashier or the + description: 'Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send the information to a particular physical printer or to use the paper type accordingly. + + Possible values: + + * **CashierReceipt** + + * **CustomerReceipt** + + * **Document** + + * **Journal** + + * **SaleReceipt** + + * **Voucher**' AbortRequest: type: object description: 'Body of the Abort Request message. @@ -4362,7 +5889,43 @@ components: System or the Acquirer. EventToNotify: $ref: '#/components/schemas/EventToNotify' - description: Event the POI notifies to the Sale System. + description: 'Event the POI notifies to the Sale System. + + Possible values: + + * **Abort** + + * **BeginMaintenance** + + * **CardInserted** + + * **CardRemoved** + + * **Completed** + + * **CustomerLanguage** + + * **EndMaintenance** + + * **Initialised** + + * **KeyPressed** + + * **OutOfOrder** + + * **Reject** + + * **SaleAdmin** + + * **SaleWakeUp** + + * **SecurityAlarm** + + * **Shutdown** + + * **StopAssistance** + + * **UseAnotherCardForPreauth**' EventDetails: type: string pattern: ^.+$ @@ -4381,13 +5944,6 @@ components: default: false description: Indicates if the occurred event requires maintenance call or action. - CustomerLanguage: - type: string - pattern: ^[a-z]{2,2}$ - description: 'Language of the Customer. - - If the language is selected by the Sale System before the request to the - POI.' DisplayOutput: type: array items: @@ -4664,10 +6220,6 @@ components: POIData: $ref: '#/components/schemas/POIData' description: Data related to the POI System. - CustomerLanguage: - type: string - pattern: ^[a-z]{2,2}$ - description: Data related to the POI System. PaymentBrand: type: array items: @@ -4803,7 +6355,17 @@ components: description: Result of a message request processing. ReconciliationType: $ref: '#/components/schemas/ReconciliationType' - description: Type of Reconciliation requested by the Sale to the POI. + description: 'Type of Reconciliation requested by the Sale to the POI. + + Possible values: + + * **AcquirerReconciliation** + + * **AcquirerSynchronisation** + + * **PreviousReconciliation** + + * **SaleReconciliation**' POIReconciliationID: type: integer description: 'Identification of the reconciliation period between Sale and @@ -4915,6 +6477,11 @@ components: If Result is Success (process completed).' required: - Response + AbortResponse: + type: object + description: A successful `AbortRequest` returns a response with a **200 OK** + HTTP status code and no body. + properties: {} DiagnosisResponse: type: object description: 'It conveys the result of the requested diagnosis and a possible @@ -4992,9 +6559,23 @@ components: properties: DocumentQualifier: $ref: '#/components/schemas/DocumentQualifier' - description: Qualification of the document to print to the Cashier or the + description: 'Qualification of the document to print to the Cashier or the Customer. Allows the manager of the printer, Sale or POI Terminal, to send information to a physical printer or to use the paper type accordingly. + + Possible values: + + * **CashierReceipt** + + * **CustomerReceipt** + + * **Document** + + * **Journal** + + * **SaleReceipt** + + * **Voucher**' Response: $ref: '#/components/schemas/Response' description: Result of a message request processing.