diff --git a/json/PaymentService-v25.json b/json/PaymentService-v25.json index 24d2875e..9c6b05a6 100644 --- a/json/PaymentService-v25.json +++ b/json/PaymentService-v25.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,19 +25,19 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -163,12 +163,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -1041,7 +1041,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1117,7 +1117,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1146,16 +1146,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1213,7 +1203,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -1326,7 +1316,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -1342,7 +1332,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -3016,7 +3006,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -3025,6 +3015,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", diff --git a/json/PaymentService-v30.json b/json/PaymentService-v30.json index 0cb543bc..7899e0db 100644 --- a/json/PaymentService-v30.json +++ b/json/PaymentService-v30.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -281,12 +281,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -1279,7 +1279,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1355,7 +1355,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1384,16 +1384,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1451,7 +1441,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -1564,7 +1554,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -1580,7 +1570,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -3387,7 +3377,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -3396,6 +3386,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", diff --git a/json/PaymentService-v40.json b/json/PaymentService-v40.json index 15094241..39dd3cf6 100644 --- a/json/PaymentService-v40.json +++ b/json/PaymentService-v40.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -284,12 +284,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -398,13 +398,13 @@ "/authorise3ds2" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS2 authorisation", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 3, "x-methodName" : "authorise3ds2", "security" : [ @@ -1099,13 +1099,13 @@ "/retrieve3ds2Result" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS2 authentication result", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "retrieve3ds2Result", "security" : [ @@ -1746,7 +1746,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1822,7 +1822,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1851,16 +1851,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1918,7 +1908,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -2031,7 +2021,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -2047,7 +2037,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -4463,7 +4453,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -4472,6 +4462,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", diff --git a/json/PaymentService-v46.json b/json/PaymentService-v46.json index 59b686c4..4b0bf33e 100644 --- a/json/PaymentService-v46.json +++ b/json/PaymentService-v46.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -284,12 +284,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -398,13 +398,13 @@ "/authorise3ds2" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS2 authorisation", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 3, "x-methodName" : "authorise3ds2", "security" : [ @@ -1099,13 +1099,13 @@ "/retrieve3ds2Result" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS2 authentication result", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "retrieve3ds2Result", "security" : [ @@ -1746,7 +1746,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1822,7 +1822,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1851,16 +1851,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1918,7 +1908,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -2031,7 +2021,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -2047,7 +2037,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -4483,7 +4473,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -4492,6 +4482,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", diff --git a/json/PaymentService-v49.json b/json/PaymentService-v49.json index eaa22ca8..4405c8b3 100644 --- a/json/PaymentService-v49.json +++ b/json/PaymentService-v49.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -284,12 +284,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -398,13 +398,13 @@ "/authorise3ds2" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS2 authorisation", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 3, "x-methodName" : "authorise3ds2", "security" : [ @@ -1099,13 +1099,13 @@ "/retrieve3ds2Result" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS2 authentication result", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "retrieve3ds2Result", "security" : [ @@ -1746,7 +1746,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1822,7 +1822,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1851,16 +1851,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1918,7 +1908,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -2031,7 +2021,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -2047,7 +2037,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -4483,7 +4473,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -4492,6 +4482,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", diff --git a/json/PaymentService-v50.json b/json/PaymentService-v50.json index 2558a4cd..1acf4fa7 100644 --- a/json/PaymentService-v50.json +++ b/json/PaymentService-v50.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -284,12 +284,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -398,13 +398,13 @@ "/authorise3ds2" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS2 authorisation", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 3, "x-methodName" : "authorise3ds2", "security" : [ @@ -1099,13 +1099,13 @@ "/retrieve3ds2Result" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS2 authentication result", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "retrieve3ds2Result", "security" : [ @@ -1756,7 +1756,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1832,7 +1832,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1861,16 +1861,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -1928,7 +1918,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -2041,7 +2031,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -2057,7 +2047,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -4511,7 +4501,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -4520,6 +4510,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", diff --git a/json/PaymentService-v51.json b/json/PaymentService-v51.json index 600c009c..5e6c96f2 100644 --- a/json/PaymentService-v51.json +++ b/json/PaymentService-v51.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -284,12 +284,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -398,13 +398,13 @@ "/authorise3ds2" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS2 authorisation", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 3, "x-methodName" : "authorise3ds2", "security" : [ @@ -980,13 +980,13 @@ "/getAuthenticationResult" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS authentication result", "description" : "Return the authentication result after doing a 3D Secure authentication only.", "x-addedInVersion" : "51", "operationId" : "post-getAuthenticationResult", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "getAuthenticationResult", "security" : [ @@ -1214,13 +1214,13 @@ "/retrieve3ds2Result" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS2 authentication result", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "retrieve3ds2Result", "security" : [ @@ -1871,7 +1871,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1947,7 +1947,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1976,16 +1976,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -2043,7 +2033,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -2156,7 +2146,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -2172,7 +2162,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -4674,7 +4664,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -4683,6 +4673,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", diff --git a/json/PaymentService-v52.json b/json/PaymentService-v52.json index 361507cd..40ca6f7d 100644 --- a/json/PaymentService-v52.json +++ b/json/PaymentService-v52.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -284,12 +284,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -398,13 +398,13 @@ "/authorise3ds2" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS2 authorisation", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 3, "x-methodName" : "authorise3ds2", "security" : [ @@ -980,13 +980,13 @@ "/getAuthenticationResult" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS authentication result", "description" : "Return the authentication result after doing a 3D Secure authentication only.", "x-addedInVersion" : "51", "operationId" : "post-getAuthenticationResult", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "getAuthenticationResult", "security" : [ @@ -1214,13 +1214,13 @@ "/retrieve3ds2Result" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS2 authentication result", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "retrieve3ds2Result", "security" : [ @@ -1871,7 +1871,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1947,7 +1947,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1976,16 +1976,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -2043,7 +2033,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -2156,7 +2146,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -2172,7 +2162,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -4682,7 +4672,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -4691,6 +4681,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", diff --git a/json/PaymentService-v64.json b/json/PaymentService-v64.json index 0b7f6749..d999a5b4 100644 --- a/json/PaymentService-v64.json +++ b/json/PaymentService-v64.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -284,12 +284,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -398,13 +398,13 @@ "/authorise3ds2" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS2 authorisation", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 3, "x-methodName" : "authorise3ds2", "security" : [ @@ -980,13 +980,13 @@ "/getAuthenticationResult" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS authentication result", "description" : "Return the authentication result after doing a 3D Secure authentication only.", "x-addedInVersion" : "51", "operationId" : "post-getAuthenticationResult", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "getAuthenticationResult", "security" : [ @@ -1214,13 +1214,13 @@ "/retrieve3ds2Result" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS2 authentication result", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "retrieve3ds2Result", "security" : [ @@ -1871,7 +1871,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1947,7 +1947,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1976,16 +1976,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -2043,7 +2033,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -2156,7 +2146,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -2172,7 +2162,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -4777,7 +4767,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -4786,6 +4776,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", diff --git a/json/PaymentService-v67.json b/json/PaymentService-v67.json index 18ebe779..07b6ca3e 100644 --- a/json/PaymentService-v67.json +++ b/json/PaymentService-v67.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -284,12 +284,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -398,13 +398,13 @@ "/authorise3ds2" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS2 authorisation", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 3, "x-methodName" : "authorise3ds2", "security" : [ @@ -980,13 +980,13 @@ "/getAuthenticationResult" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS authentication result", "description" : "Return the authentication result after doing a 3D Secure authentication only.", "x-addedInVersion" : "51", "operationId" : "post-getAuthenticationResult", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "getAuthenticationResult", "security" : [ @@ -1214,13 +1214,13 @@ "/retrieve3ds2Result" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS2 authentication result", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "retrieve3ds2Result", "security" : [ @@ -1871,7 +1871,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -1947,7 +1947,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -1976,16 +1976,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -2043,7 +2033,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -2156,7 +2146,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -2172,7 +2162,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -4759,7 +4749,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -4768,6 +4758,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", @@ -5820,17 +5811,6 @@ ], "type" : "string" }, - "challengeIndicator" : { - "x-addedInVersion" : "67", - "description" : "Specifies a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", - "enum" : [ - "noPreference", - "requestNoChallenge", - "requestChallenge", - "requestChallengeAsMandate" - ], - "type" : "string" - }, "dsTransID" : { "description" : "The `dsTransID` value as defined in the 3D Secure 2 specification.", "type" : "string" diff --git a/json/PaymentService-v68.json b/json/PaymentService-v68.json index 5667d4fe..332fbc83 100644 --- a/json/PaymentService-v68.json +++ b/json/PaymentService-v68.json @@ -17,7 +17,7 @@ } }, "x-groups" : [ - "General", + "Payments", "Modifications" ], "tags" : [ @@ -25,7 +25,7 @@ "name" : "Modifications" }, { - "name" : "General" + "name" : "Payments" } ], "paths" : { @@ -152,12 +152,12 @@ "/authorise" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Create an authorisation", "description" : "Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured or cancelled later. Non-card payment methods typically don't support this and will automatically capture as part of the authorisation.\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.", "operationId" : "post-authorise", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 1, "x-methodName" : "authorise", "security" : [ @@ -284,12 +284,12 @@ "/authorise3d" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS authorisation", "description" : "For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters that you get from the card issuer after a shopper pays via 3D Secure.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "operationId" : "post-authorise3d", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 2, "x-methodName" : "authorise3d", "security" : [ @@ -398,13 +398,13 @@ "/authorise3ds2" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Complete a 3DS2 authorisation", "description" : "For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` parameters.\n\n> This endpoint is part of our [classic API integration](https://docs.adyen.com/online-payments/classic-integrations/api-integration-ecommerce/3d-secure). If using a [newer integration](https://docs.adyen.com/online-payments), use the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.", "x-addedInVersion" : "37", "operationId" : "post-authorise3ds2", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 3, "x-methodName" : "authorise3ds2", "security" : [ @@ -980,13 +980,13 @@ "/getAuthenticationResult" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS authentication result", "description" : "Return the authentication result after doing a 3D Secure authentication only.", "x-addedInVersion" : "51", "operationId" : "post-getAuthenticationResult", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "getAuthenticationResult", "security" : [ @@ -1214,13 +1214,13 @@ "/retrieve3ds2Result" : { "post" : { "tags" : [ - "General" + "Payments" ], "summary" : "Get the 3DS2 authentication result", "description" : "Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only.", "x-addedInVersion" : "40", "operationId" : "post-retrieve3ds2Result", - "x-groupName" : "General", + "x-groupName" : "Payments", "x-sortIndex" : 4, "x-methodName" : "retrieve3ds2Result", "security" : [ @@ -2006,7 +2006,7 @@ "type" : "string" }, "carRental.daysRented" : { - "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 2\n* Must not be all spaces", + "description" : "Number of days for which the car is being rented.\n* Format: Numeric\n* maxLength: 4\n* Must not be all spaces", "type" : "string" }, "carRental.fuelCharges" : { @@ -2082,7 +2082,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 2", + "description" : "Number of days the car is rented for. This should be included in the auth message.\n* Format: Numeric\n* maxLength: 4", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -2111,16 +2111,6 @@ "type" : "string" }, "industryUsage" : { - "x-enum" : [ - { - "description" : "An incremental charge is carried out because of a no-show for a guaranteed reservation.", - "value" : "NoShow" - }, - { - "description" : "An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", - "value" : "DelayedCharge" - } - ], "description" : "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation), this field denotes why the additional payment is made.\n\nPossible values:\n\n * **NoShow**: An incremental charge is carried out because of a no-show for a guaranteed reservation.\n\n * **DelayedCharge**: An incremental charge is carried out to process an additional payment after the original services have been rendered and the respective payment has been processed.", "enum" : [ "NoShow", @@ -2178,7 +2168,7 @@ "AdditionalDataLevel23" : { "properties" : { "enhancedSchemeData.customerReference" : { - "description" : "The customer code, if supplied by a customer.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", + "description" : "The customer code.\n\nEncoding: ASCII\n\nMax length: 25 characters\n\nMust not start with a space or be all spaces\n\nMust not be all zeros", "type" : "string" }, "enhancedSchemeData.destinationCountryCode" : { @@ -2291,7 +2281,7 @@ "type" : "string" }, "lodging.room1.numberOfNights" : { - "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 2 characters", + "description" : "The total number of nights the room is booked for.\n* Format: numeric\n* Must be a number between 0 and 99\n* Max length: 4 characters", "type" : "string" }, "lodging.room1.rate" : { @@ -2307,7 +2297,7 @@ "type" : "string" }, "travelEntertainmentAuthData.duration" : { - "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 2 characters", + "description" : "The number of nights. This should be included in the auth message.\n* Format: numeric\n* Max length: 4 characters", "type" : "string" }, "travelEntertainmentAuthData.market" : { @@ -4977,7 +4967,7 @@ "type" : "string" }, "resultCode" : { - "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", + "description" : "The result of the payment. For more information, see [Result codes](https://docs.adyen.com/online-payments/payment-result-codes).\n\nPossible values:\n\n* **AuthenticationFinished** – The payment has been successfully authenticated with 3D Secure 2. Returned for 3D Secure 2 authentication-only transactions.\n* **AuthenticationNotRequired** – The transaction does not require 3D Secure authentication. Returned for [standalone authentication-only integrations](https://docs.adyen.com/online-payments/3d-secure/other-3ds-flows/authentication-only).\n* **Authorised** – The payment was successfully authorised. This state serves as an indicator to proceed with the delivery of goods and services. This is a final state.\n* **Cancelled** – Indicates the payment has been cancelled (either by the shopper or the merchant) before processing was completed. This is a final state.\n* **ChallengeShopper** – The issuer requires further shopper interaction before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **Error** – There was an error when the payment was being processed. The reason is given in the `refusalReason` field. This is a final state.\n* **IdentifyShopper** – The issuer requires the shopper's device fingerprint before the payment can be authenticated. Returned for 3D Secure 2 transactions.\n* **PartiallyAuthorised** – The payment has been authorised for a partial amount.\nThis happens for card payments when the merchant supports Partial Authorisations and the cardholder has insufficient funds.\n* **Pending** – Indicates that it is not possible to obtain the final status of the payment. This can happen if the systems providing final status information for the payment are unavailable, or if the shopper needs to take further action to complete the payment.\n* **PresentToShopper** – Indicates that the response contains additional information that you need to present to a shopper, so that they can use it to complete a payment.\n* **Received** – Indicates the payment has successfully been received by Adyen, and will be processed. This is the initial state for all payments.\n* **RedirectShopper** – Indicates the shopper should be redirected to an external web page or app to complete the authorisation.\n* **Refused** – Indicates the payment was refused. The reason is given in the `refusalReason` field. This is a final state.", "enum" : [ "AuthenticationFinished", "AuthenticationNotRequired", @@ -4986,6 +4976,7 @@ "ChallengeShopper", "Error", "IdentifyShopper", + "PartiallyAuthorised", "Pending", "PresentToShopper", "Received", @@ -6110,32 +6101,6 @@ }, "threeDSRequestorChallengeInd" : { "x-addedInVersion" : "68", - "x-enum" : [ - { - "description" : "No preference", - "value" : "01" - }, - { - "description" : "No challenge requested", - "value" : "02" - }, - { - "description" : "Challenge requested (3DS Requestor preference)", - "value" : "03" - }, - { - "description" : "Challenge requested (Mandate)", - "value" : "04" - }, - { - "description" : "No challenge (transactional risk analysis is already performed)", - "value" : "05" - }, - { - "description" : "Data only", - "value" : "06" - } - ], "description" : "Indicates whether a challenge is requested for this transaction. Possible values:\n* **01** — No preference\n* **02** — No challenge requested\n* **03** — Challenge requested (3DS Requestor preference)\n* **04** — Challenge requested (Mandate)\n* **05** — No challenge (transactional risk analysis is already performed)\n* **06** — Data Only", "enum" : [ "01", @@ -6231,17 +6196,6 @@ ], "type" : "string" }, - "challengeIndicator" : { - "x-addedInVersion" : "67", - "description" : "Specifies a preference for receiving a challenge from the issuer.\nAllowed values:\n* `noPreference`\n* `requestNoChallenge`\n* `requestChallenge`\n* `requestChallengeAsMandate`\n", - "enum" : [ - "noPreference", - "requestNoChallenge", - "requestChallenge", - "requestChallengeAsMandate" - ], - "type" : "string" - }, "dsTransID" : { "description" : "The `dsTransID` value as defined in the 3D Secure 2 specification.", "type" : "string" @@ -6271,6 +6225,19 @@ "description" : "Risk score calculated by Cartes Bancaires Directory Server (DS).", "type" : "string" }, + "threeDSRequestorChallengeInd" : { + "x-addedInVersion" : "68", + "description" : "Indicates whether a challenge is requested for this transaction. Possible values:\n* **01** — No preference\n* **02** — No challenge requested\n* **03** — Challenge requested (3DS Requestor preference)\n* **04** — Challenge requested (Mandate)\n* **05** — No challenge (transactional risk analysis is already performed)\n* **06** — Data Only", + "enum" : [ + "01", + "02", + "03", + "04", + "05", + "06" + ], + "type" : "string" + }, "threeDSServerTransID" : { "description" : "The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.", "type" : "string" diff --git a/yaml/PaymentService-v25.yaml b/yaml/PaymentService-v25.yaml index 95c7f206..ad2e6290 100644 --- a/yaml/PaymentService-v25.yaml +++ b/yaml/PaymentService-v25.yaml @@ -30,16 +30,16 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -51,7 +51,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -125,7 +125,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -137,7 +137,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -1042,7 +1042,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1222,7 +1222,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1282,14 +1282,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1409,7 +1401,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -1729,7 +1721,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -1764,7 +1756,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -3550,7 +3542,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -3571,6 +3566,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received diff --git a/yaml/PaymentService-v30.yaml b/yaml/PaymentService-v30.yaml index 373afbb3..49ba2349 100644 --- a/yaml/PaymentService-v30.yaml +++ b/yaml/PaymentService-v30.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -211,7 +211,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -223,7 +223,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -1206,7 +1206,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1386,7 +1386,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1446,14 +1446,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1573,7 +1565,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -1893,7 +1885,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -1928,7 +1920,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -3836,7 +3828,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -3857,6 +3852,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received diff --git a/yaml/PaymentService-v40.yaml b/yaml/PaymentService-v40.yaml index 10f63c19..43da8496 100644 --- a/yaml/PaymentService-v40.yaml +++ b/yaml/PaymentService-v40.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -213,7 +213,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -225,7 +225,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -288,7 +288,7 @@ paths: /authorise3ds2: post: tags: - - General + - Payments summary: Complete a 3DS2 authorisation description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -301,7 +301,7 @@ paths: endpoint under Checkout API instead.' x-addedInVersion: '37' operationId: post-authorise3ds2 - x-groupName: General + x-groupName: Payments x-sortIndex: 3 x-methodName: authorise3ds2 security: @@ -781,13 +781,13 @@ paths: /retrieve3ds2Result: post: tags: - - General + - Payments summary: Get the 3DS2 authentication result description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-addedInVersion: '40' operationId: post-retrieve3ds2Result - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: retrieve3ds2Result security: @@ -1586,7 +1586,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1766,7 +1766,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1826,14 +1826,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1953,7 +1945,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -2273,7 +2265,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2308,7 +2300,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -4926,7 +4918,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -4947,6 +4942,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received diff --git a/yaml/PaymentService-v46.yaml b/yaml/PaymentService-v46.yaml index b9d2f2a9..e3b99737 100644 --- a/yaml/PaymentService-v46.yaml +++ b/yaml/PaymentService-v46.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -213,7 +213,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -225,7 +225,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -288,7 +288,7 @@ paths: /authorise3ds2: post: tags: - - General + - Payments summary: Complete a 3DS2 authorisation description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -301,7 +301,7 @@ paths: endpoint under Checkout API instead.' x-addedInVersion: '37' operationId: post-authorise3ds2 - x-groupName: General + x-groupName: Payments x-sortIndex: 3 x-methodName: authorise3ds2 security: @@ -781,13 +781,13 @@ paths: /retrieve3ds2Result: post: tags: - - General + - Payments summary: Get the 3DS2 authentication result description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-addedInVersion: '40' operationId: post-retrieve3ds2Result - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: retrieve3ds2Result security: @@ -1586,7 +1586,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1766,7 +1766,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1826,14 +1826,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1953,7 +1945,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -2273,7 +2265,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2308,7 +2300,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -4946,7 +4938,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -4967,6 +4962,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received diff --git a/yaml/PaymentService-v49.yaml b/yaml/PaymentService-v49.yaml index 7b233284..8f40eefa 100644 --- a/yaml/PaymentService-v49.yaml +++ b/yaml/PaymentService-v49.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -213,7 +213,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -225,7 +225,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -288,7 +288,7 @@ paths: /authorise3ds2: post: tags: - - General + - Payments summary: Complete a 3DS2 authorisation description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -301,7 +301,7 @@ paths: endpoint under Checkout API instead.' x-addedInVersion: '37' operationId: post-authorise3ds2 - x-groupName: General + x-groupName: Payments x-sortIndex: 3 x-methodName: authorise3ds2 security: @@ -781,13 +781,13 @@ paths: /retrieve3ds2Result: post: tags: - - General + - Payments summary: Get the 3DS2 authentication result description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-addedInVersion: '40' operationId: post-retrieve3ds2Result - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: retrieve3ds2Result security: @@ -1586,7 +1586,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1766,7 +1766,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1826,14 +1826,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1953,7 +1945,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -2273,7 +2265,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2308,7 +2300,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -4946,7 +4938,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -4967,6 +4962,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received diff --git a/yaml/PaymentService-v50.yaml b/yaml/PaymentService-v50.yaml index 7c53828a..debf2e1a 100644 --- a/yaml/PaymentService-v50.yaml +++ b/yaml/PaymentService-v50.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -213,7 +213,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -225,7 +225,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -288,7 +288,7 @@ paths: /authorise3ds2: post: tags: - - General + - Payments summary: Complete a 3DS2 authorisation description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -301,7 +301,7 @@ paths: endpoint under Checkout API instead.' x-addedInVersion: '37' operationId: post-authorise3ds2 - x-groupName: General + x-groupName: Payments x-sortIndex: 3 x-methodName: authorise3ds2 security: @@ -781,13 +781,13 @@ paths: /retrieve3ds2Result: post: tags: - - General + - Payments summary: Get the 3DS2 authentication result description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-addedInVersion: '40' operationId: post-retrieve3ds2Result - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: retrieve3ds2Result security: @@ -1603,7 +1603,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1783,7 +1783,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1843,14 +1843,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -1970,7 +1962,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -2290,7 +2282,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2325,7 +2317,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -4981,7 +4973,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -5002,6 +4997,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received diff --git a/yaml/PaymentService-v51.yaml b/yaml/PaymentService-v51.yaml index 71e0b3b7..05d75cdd 100644 --- a/yaml/PaymentService-v51.yaml +++ b/yaml/PaymentService-v51.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -213,7 +213,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -225,7 +225,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -288,7 +288,7 @@ paths: /authorise3ds2: post: tags: - - General + - Payments summary: Complete a 3DS2 authorisation description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -301,7 +301,7 @@ paths: endpoint under Checkout API instead.' x-addedInVersion: '37' operationId: post-authorise3ds2 - x-groupName: General + x-groupName: Payments x-sortIndex: 3 x-methodName: authorise3ds2 security: @@ -691,13 +691,13 @@ paths: /getAuthenticationResult: post: tags: - - General + - Payments summary: Get the 3DS authentication result description: Return the authentication result after doing a 3D Secure authentication only. x-addedInVersion: '51' operationId: post-getAuthenticationResult - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: getAuthenticationResult security: @@ -850,13 +850,13 @@ paths: /retrieve3ds2Result: post: tags: - - General + - Payments summary: Get the 3DS2 authentication result description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-addedInVersion: '40' operationId: post-retrieve3ds2Result - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: retrieve3ds2Result security: @@ -1672,7 +1672,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1852,7 +1852,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1912,14 +1912,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2039,7 +2031,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -2359,7 +2351,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2394,7 +2386,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -5090,7 +5082,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -5111,6 +5106,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received diff --git a/yaml/PaymentService-v52.yaml b/yaml/PaymentService-v52.yaml index 0dae4cf2..38a2aeed 100644 --- a/yaml/PaymentService-v52.yaml +++ b/yaml/PaymentService-v52.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -213,7 +213,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -225,7 +225,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -288,7 +288,7 @@ paths: /authorise3ds2: post: tags: - - General + - Payments summary: Complete a 3DS2 authorisation description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -301,7 +301,7 @@ paths: endpoint under Checkout API instead.' x-addedInVersion: '37' operationId: post-authorise3ds2 - x-groupName: General + x-groupName: Payments x-sortIndex: 3 x-methodName: authorise3ds2 security: @@ -691,13 +691,13 @@ paths: /getAuthenticationResult: post: tags: - - General + - Payments summary: Get the 3DS authentication result description: Return the authentication result after doing a 3D Secure authentication only. x-addedInVersion: '51' operationId: post-getAuthenticationResult - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: getAuthenticationResult security: @@ -850,13 +850,13 @@ paths: /retrieve3ds2Result: post: tags: - - General + - Payments summary: Get the 3DS2 authentication result description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-addedInVersion: '40' operationId: post-retrieve3ds2Result - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: retrieve3ds2Result security: @@ -1672,7 +1672,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1852,7 +1852,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1912,14 +1912,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2039,7 +2031,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -2359,7 +2351,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2394,7 +2386,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -5098,7 +5090,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -5119,6 +5114,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received diff --git a/yaml/PaymentService-v64.yaml b/yaml/PaymentService-v64.yaml index f446e9c3..cfcaac3d 100644 --- a/yaml/PaymentService-v64.yaml +++ b/yaml/PaymentService-v64.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -213,7 +213,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -225,7 +225,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -288,7 +288,7 @@ paths: /authorise3ds2: post: tags: - - General + - Payments summary: Complete a 3DS2 authorisation description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -301,7 +301,7 @@ paths: endpoint under Checkout API instead.' x-addedInVersion: '37' operationId: post-authorise3ds2 - x-groupName: General + x-groupName: Payments x-sortIndex: 3 x-methodName: authorise3ds2 security: @@ -691,13 +691,13 @@ paths: /getAuthenticationResult: post: tags: - - General + - Payments summary: Get the 3DS authentication result description: Return the authentication result after doing a 3D Secure authentication only. x-addedInVersion: '51' operationId: post-getAuthenticationResult - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: getAuthenticationResult security: @@ -850,13 +850,13 @@ paths: /retrieve3ds2Result: post: tags: - - General + - Payments summary: Get the 3DS2 authentication result description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-addedInVersion: '40' operationId: post-retrieve3ds2Result - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: retrieve3ds2Result security: @@ -1672,7 +1672,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1852,7 +1852,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1912,14 +1912,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2039,7 +2031,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -2359,7 +2351,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2394,7 +2386,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -5194,7 +5186,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -5215,6 +5210,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received diff --git a/yaml/PaymentService-v67.yaml b/yaml/PaymentService-v67.yaml index 693140ee..9d7c1341 100644 --- a/yaml/PaymentService-v67.yaml +++ b/yaml/PaymentService-v67.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -213,7 +213,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -225,7 +225,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -288,7 +288,7 @@ paths: /authorise3ds2: post: tags: - - General + - Payments summary: Complete a 3DS2 authorisation description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -301,7 +301,7 @@ paths: endpoint under Checkout API instead.' x-addedInVersion: '37' operationId: post-authorise3ds2 - x-groupName: General + x-groupName: Payments x-sortIndex: 3 x-methodName: authorise3ds2 security: @@ -691,13 +691,13 @@ paths: /getAuthenticationResult: post: tags: - - General + - Payments summary: Get the 3DS authentication result description: Return the authentication result after doing a 3D Secure authentication only. x-addedInVersion: '51' operationId: post-getAuthenticationResult - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: getAuthenticationResult security: @@ -850,13 +850,13 @@ paths: /retrieve3ds2Result: post: tags: - - General + - Payments summary: Get the 3DS2 authentication result description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-addedInVersion: '40' operationId: post-retrieve3ds2Result - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: retrieve3ds2Result security: @@ -1672,7 +1672,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -1852,7 +1852,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -1912,14 +1912,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2039,7 +2031,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -2359,7 +2351,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2394,7 +2386,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -5176,7 +5168,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -5197,6 +5192,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received @@ -6427,28 +6423,6 @@ components: - '06' - '07' type: string - challengeIndicator: - x-addedInVersion: '67' - description: 'Specifies a preference for receiving a challenge from the - issuer. - - Allowed values: - - * `noPreference` - - * `requestNoChallenge` - - * `requestChallenge` - - * `requestChallengeAsMandate` - - ' - enum: - - noPreference - - requestNoChallenge - - requestChallenge - - requestChallengeAsMandate - type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. type: string diff --git a/yaml/PaymentService-v68.yaml b/yaml/PaymentService-v68.yaml index 99e4cfec..e8201cd8 100644 --- a/yaml/PaymentService-v68.yaml +++ b/yaml/PaymentService-v68.yaml @@ -30,11 +30,11 @@ info: name: Adyen Developer Experience team url: https://github.com/Adyen/adyen-openapi x-groups: -- General +- Payments - Modifications tags: - name: Modifications -- name: General +- name: Payments paths: /adjustAuthorisation: post: @@ -126,7 +126,7 @@ paths: /authorise: post: tags: - - General + - Payments summary: Create an authorisation description: 'Creates a payment with a unique reference (`pspReference`) and attempts to obtain an authorisation hold. For cards, this amount can be captured @@ -138,7 +138,7 @@ paths: the [`/payments`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments) endpoint under Checkout API instead.' operationId: post-authorise - x-groupName: General + x-groupName: Payments x-sortIndex: 1 x-methodName: authorise security: @@ -213,7 +213,7 @@ paths: /authorise3d: post: tags: - - General + - Payments summary: Complete a 3DS authorisation description: 'For an authenticated 3D Secure session, completes the payment authorisation. This endpoint must receive the `md` and `paResponse` parameters @@ -225,7 +225,7 @@ paths: the [`/payments/details`](https://docs.adyen.com/api-explorer/#/CheckoutService/payments/details) endpoint under Checkout API instead.' operationId: post-authorise3d - x-groupName: General + x-groupName: Payments x-sortIndex: 2 x-methodName: authorise3d security: @@ -288,7 +288,7 @@ paths: /authorise3ds2: post: tags: - - General + - Payments summary: Complete a 3DS2 authorisation description: 'For an authenticated 3D Secure 2 session, completes the payment authorisation. This endpoint must receive the `threeDS2Token` and `threeDS2Result` @@ -301,7 +301,7 @@ paths: endpoint under Checkout API instead.' x-addedInVersion: '37' operationId: post-authorise3ds2 - x-groupName: General + x-groupName: Payments x-sortIndex: 3 x-methodName: authorise3ds2 security: @@ -691,13 +691,13 @@ paths: /getAuthenticationResult: post: tags: - - General + - Payments summary: Get the 3DS authentication result description: Return the authentication result after doing a 3D Secure authentication only. x-addedInVersion: '51' operationId: post-getAuthenticationResult - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: getAuthenticationResult security: @@ -850,13 +850,13 @@ paths: /retrieve3ds2Result: post: tags: - - General + - Payments summary: Get the 3DS2 authentication result description: Retrieves the `threeDS2Result` after doing a 3D Secure 2 authentication only. x-addedInVersion: '40' operationId: post-retrieve3ds2Result - x-groupName: General + x-groupName: Payments x-sortIndex: 4 x-methodName: retrieve3ds2Result security: @@ -1820,7 +1820,7 @@ components: * Format: Numeric - * maxLength: 2 + * maxLength: 4 * Must not be all spaces' type: string @@ -2000,7 +2000,7 @@ components: * Format: Numeric - * maxLength: 2' + * maxLength: 4' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted or @@ -2060,14 +2060,6 @@ components: To enable this functionality, contact [Support](https://www.adyen.help/hc/en-us/requests/new).' type: string industryUsage: - x-enum: - - description: An incremental charge is carried out because of a no-show - for a guaranteed reservation. - value: NoShow - - description: An incremental charge is carried out to process an additional - payment after the original services have been rendered and the respective - payment has been processed. - value: DelayedCharge description: "In case of [asynchronous authorisation adjustment](https://docs.adyen.com/online-payments/adjust-authorisation#adjust-authorisation),\ \ this field denotes why the additional payment is made.\n\nPossible values:\n\ \n * **NoShow**: An incremental charge is carried out because of a no-show\ @@ -2187,7 +2179,7 @@ components: AdditionalDataLevel23: properties: enhancedSchemeData.customerReference: - description: 'The customer code, if supplied by a customer. + description: 'The customer code. Encoding: ASCII @@ -2507,7 +2499,7 @@ components: * Must be a number between 0 and 99 - * Max length: 2 characters' + * Max length: 4 characters' type: string lodging.room1.rate: description: 'The rate for the room, in [minor units](https://docs.adyen.com/development-resources/currency-codes). @@ -2542,7 +2534,7 @@ components: * Format: numeric - * Max length: 2 characters' + * Max length: 4 characters' type: string travelEntertainmentAuthData.market: description: 'Indicates what market-specific dataset will be submitted. @@ -5443,7 +5435,10 @@ components: \ reason is given in the `refusalReason` field. This is a final state.\n\ * **IdentifyShopper** \u2013 The issuer requires the shopper's device\ \ fingerprint before the payment can be authenticated. Returned for 3D\ - \ Secure 2 transactions.\n* **Pending** \u2013 Indicates that it is not\ + \ Secure 2 transactions.\n* **PartiallyAuthorised** \u2013 The payment\ + \ has been authorised for a partial amount.\nThis happens for card payments\ + \ when the merchant supports Partial Authorisations and the cardholder\ + \ has insufficient funds.\n* **Pending** \u2013 Indicates that it is not\ \ possible to obtain the final status of the payment. This can happen\ \ if the systems providing final status information for the payment are\ \ unavailable, or if the shopper needs to take further action to complete\ @@ -5464,6 +5459,7 @@ components: - ChallengeShopper - Error - IdentifyShopper + - PartiallyAuthorised - Pending - PresentToShopper - Received @@ -6765,19 +6761,6 @@ components: $ref: '#/components/schemas/ThreeDSRequestorAuthenticationInfo' threeDSRequestorChallengeInd: x-addedInVersion: '68' - x-enum: - - description: No preference - value: '01' - - description: No challenge requested - value: '02' - - description: Challenge requested (3DS Requestor preference) - value: '03' - - description: Challenge requested (Mandate) - value: '04' - - description: No challenge (transactional risk analysis is already performed) - value: '05' - - description: Data only - value: '06' description: "Indicates whether a challenge is requested for this transaction.\ \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\ \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\ @@ -6874,28 +6857,6 @@ components: - '06' - '07' type: string - challengeIndicator: - x-addedInVersion: '67' - description: 'Specifies a preference for receiving a challenge from the - issuer. - - Allowed values: - - * `noPreference` - - * `requestNoChallenge` - - * `requestChallenge` - - * `requestChallengeAsMandate` - - ' - enum: - - noPreference - - requestNoChallenge - - requestChallenge - - requestChallengeAsMandate - type: string dsTransID: description: The `dsTransID` value as defined in the 3D Secure 2 specification. type: string @@ -6933,6 +6894,22 @@ components: description: Risk score calculated by Cartes Bancaires Directory Server (DS). type: string + threeDSRequestorChallengeInd: + x-addedInVersion: '68' + description: "Indicates whether a challenge is requested for this transaction.\ + \ Possible values:\n* **01** \u2014 No preference\n* **02** \u2014 No\ + \ challenge requested\n* **03** \u2014 Challenge requested (3DS Requestor\ + \ preference)\n* **04** \u2014 Challenge requested (Mandate)\n* **05**\ + \ \u2014 No challenge (transactional risk analysis is already performed)\n\ + * **06** \u2014 Data Only" + enum: + - '01' + - '02' + - '03' + - '04' + - '05' + - '06' + type: string threeDSServerTransID: description: The `threeDSServerTransID` value as defined in the 3D Secure 2 specification.