Skip to content

Commit

Permalink
spec release
Browse files Browse the repository at this point in the history
  • Loading branch information
Adyen Automation committed Aug 16, 2023
1 parent 04ba95e commit 2a24618
Show file tree
Hide file tree
Showing 22 changed files with 440 additions and 659 deletions.
35 changes: 13 additions & 22 deletions json/PaymentService-v25.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,27 +17,27 @@
}
},
"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 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" : [
Expand Down Expand Up @@ -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" : [
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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",
Expand Down Expand Up @@ -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" : {
Expand Down Expand Up @@ -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" : {
Expand All @@ -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" : {
Expand Down Expand Up @@ -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",
Expand All @@ -3025,6 +3015,7 @@
"ChallengeShopper",
"Error",
"IdentifyShopper",
"PartiallyAuthorised",
"Pending",
"PresentToShopper",
"Received",
Expand Down
Loading

0 comments on commit 2a24618

Please sign in to comment.