spec release

Adyen · May 24, 2024 · cf8bc42 · cf8bc42
1 parent 87c58f7
commit cf8bc42
Show file tree

Hide file tree

Showing 34 changed files with 8,493 additions and 205 deletions.
diff --git a/json/CheckoutService-v37.json b/json/CheckoutService-v37.json
diff --git a/json/CheckoutService-v40.json b/json/CheckoutService-v40.json
diff --git a/json/CheckoutService-v41.json b/json/CheckoutService-v41.json
diff --git a/json/CheckoutService-v46.json b/json/CheckoutService-v46.json
diff --git a/json/CheckoutService-v49.json b/json/CheckoutService-v49.json
diff --git a/json/CheckoutService-v50.json b/json/CheckoutService-v50.json
diff --git a/json/CheckoutService-v51.json b/json/CheckoutService-v51.json
diff --git a/json/CheckoutService-v52.json b/json/CheckoutService-v52.json
diff --git a/json/CheckoutService-v53.json b/json/CheckoutService-v53.json
diff --git a/json/CheckoutService-v64.json b/json/CheckoutService-v64.json
diff --git a/json/CheckoutService-v65.json b/json/CheckoutService-v65.json
diff --git a/json/CheckoutService-v66.json b/json/CheckoutService-v66.json
diff --git a/json/CheckoutService-v67.json b/json/CheckoutService-v67.json
diff --git a/json/CheckoutService-v68.json b/json/CheckoutService-v68.json
diff --git a/json/CheckoutService-v69.json b/json/CheckoutService-v69.json
diff --git a/json/CheckoutService-v70.json b/json/CheckoutService-v70.json
diff --git a/json/CheckoutService-v71.json b/json/CheckoutService-v71.json
diff --git a/yaml/CheckoutService-v37.yaml b/yaml/CheckoutService-v37.yaml
@@ -320,6 +320,8 @@ paths:
               examples:
                 donations:
                   $ref: '#/components/examples/post-donations-donations-200'
+                donations-with-token:
+                  $ref: '#/components/examples/post-donations-donations-with-token-200'
               schema:
                 $ref: '#/components/schemas/DonationPaymentResponse'
           description: OK - the request has succeeded.
@@ -357,6 +359,8 @@ paths:
           content:
             application/json:
               examples:
+                donations-with-token:
+                  $ref: '#/components/examples/post-donations-donations-with-token-422'
                 generic:
                   $ref: '#/components/examples/generic-422'
               schema:
@@ -1563,7 +1567,7 @@ paths:
       tags:
       - Modifications
       summary: Cancel an authorised payment
-      description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/paymentPspReference/captures),
+      description: 'Cancels the authorisation on a payment that has not yet been [captured](https://docs.adyen.com/api-explorer/#/CheckoutService/latest/post/payments/{paymentPspReference}/captures),
         and returns a unique reference for this request. You get the outcome of the
         request asynchronously, in a [**CANCELLATION** webhook](https://docs.adyen.com/online-payments/cancel#cancellation-webhook).
 
@@ -1988,6 +1992,15 @@ paths:
       requestBody:
         content:
           application/json:
+            examples:
+              advanced-with-delivery:
+                $ref: '#/components/examples/post-paypal-updateOrder-advanced-with-delivery'
+              advanced-without-delivery:
+                $ref: '#/components/examples/post-paypal-updateOrder-advanced-without-delivery'
+              sessions-with-delivery:
+                $ref: '#/components/examples/post-paypal-updateOrder-sessions-with-delivery'
+              sessions-without-delivery:
+                $ref: '#/components/examples/post-paypal-updateOrder-sessions-without-delivery'
             schema:
               $ref: '#/components/schemas/PaypalUpdateOrderRequest'
       parameters:
@@ -1996,6 +2009,15 @@ paths:
         '200':
           content:
             application/json:
+              examples:
+                advanced-with-delivery:
+                  $ref: '#/components/examples/post-paypal-updateOrder-advanced-with-delivery-200'
+                advanced-without-delivery:
+                  $ref: '#/components/examples/post-paypal-updateOrder-advanced-without-delivery-200'
+                sessions-with-delivery:
+                  $ref: '#/components/examples/post-paypal-updateOrder-sessions-with-delivery-200'
+                sessions-without-delivery:
+                  $ref: '#/components/examples/post-paypal-updateOrder-sessions-without-delivery-200'
               schema:
                 $ref: '#/components/schemas/PaypalUpdateOrderResponse'
           description: OK - the request has succeeded.
@@ -2308,6 +2330,15 @@ components:
 
             * maxLength: 16 characters'
           type: string
+        airline.issue_date:
+          description: 'The date that the ticket was issued to the passenger.
+
+            * minLength: 6 characters
+
+            * maxLength: 6 characters
+
+            * Date format: YYMMDD'
+          type: string
         airline.leg.carrier_code:
           description: 'The [IATA](https://www.iata.org/services/pages/codes.aspx)
             2-letter accounting code (PAX) that identifies the carrier.
@@ -3086,6 +3117,16 @@ components:
     AdditionalDataLodging:
       additionalProperties: false
       properties:
+        lodging.SpecialProgramCode:
+          description: 'A code that corresponds to the category of lodging charges
+            for the payment. Possible values:
+
+            * 1: Lodging
+
+            * 2: No show reservation
+
+            * 3: Advanced deposit'
+          type: string
         lodging.checkInDate:
           description: 'The arrival date.
 
@@ -5723,8 +5764,11 @@ components:
         type:
           description: '**econtextvoucher**'
           enum:
-          - econtext_seveneleven
+          - econtext_seven_eleven
+          - econtext_online
+          - econtext
           - econtext_stores
+          - econtext_atm
           type: string
       required:
       - type
@@ -6112,7 +6156,7 @@ components:
             it may not be possible to split a payment in more than 24 installments.
             The acquirer sets this upper limit, so its value may vary.
 
-            This value can be zero for Installments processed in Mexico'
+            This value can be zero for Installments processed in Mexico.'
           format: int32
           type: integer
       required:
@@ -6799,6 +6843,11 @@ components:
         resultCode:
           description: Value you received from the WeChat Pay SDK.
           type: string
+        returnUrlQueryString:
+          description: The query string as appended to the `returnURL` when using
+            direct issuer links .
+          maxLength: 20000
+          type: string
         threeDSResult:
           description: 'Base64-encoded string returned by the Component after the
             challenge flow. It contains the following parameters: `transStatus`, `authorisationToken`.'
@@ -6864,6 +6913,9 @@ components:
           - walley_b2b
           - alma
           - paypo
+          - scalapay
+          - scalapay_3x
+          - scalapay_4x
           - molpay_fpx
           - konbini
           - directEbanking
@@ -7480,6 +7532,11 @@ components:
     PaymentMethod:
       additionalProperties: false
       properties:
+        apps:
+          description: A list of apps for this payment method.
+          items:
+            $ref: '#/components/schemas/PaymentMethodUPIApps'
+          type: array
         configuration:
           additionalProperties:
             type: string
@@ -7567,6 +7624,23 @@ components:
           description: The card number. Only collect raw card data if you are [fully
             PCI compliant](https://docs.adyen.com/development-resources/pci-dss-compliance-guide).
           type: string
+        type:
+          description: Set to **scheme**.
+          type: string
+      type: object
+    PaymentMethodUPIApps:
+      additionalProperties: false
+      properties:
+        id:
+          description: The unique identifier of this app, to submit in requests to
+            /payments.
+          type: string
+        name:
+          description: A localized name of the app.
+          type: string
+      required:
+      - id
+      - name
       type: object
     PaymentMethodsGroup:
       additionalProperties: false
@@ -9035,6 +9109,9 @@ components:
         sessionId:
           description: The original `sessionId` from the `/sessions` response.
           type: string
+        taxTotal:
+          description: 'Total tax amount from the order. '
+          $ref: '#/components/schemas/TaxTotal'
       type: object
     PaypalUpdateOrderResponse:
       additionalProperties: false
@@ -9113,6 +9190,11 @@ components:
     RecurringDetail:
       additionalProperties: false
       properties:
+        apps:
+          description: A list of apps for this payment method.
+          items:
+            $ref: '#/components/schemas/PaymentMethodUPIApps'
+          type: array
         configuration:
           additionalProperties:
             type: string
@@ -10339,6 +10421,12 @@ components:
             * Fixed length: 11 digits for the CPF or 14 digits for the CNPJ'
           type: string
       type: object
+    TaxTotal:
+      additionalProperties: false
+      properties:
+        amount:
+          $ref: '#/components/schemas/Amount'
+      type: object
     ThreeDSecureData:
       additionalProperties: false
       properties:
@@ -10690,7 +10778,7 @@ components:
         pspReference: 993617894906488A
         status: received
     post-cardDetails-basic:
-      summary: Get a list of brands on a card
+      summary: Get a list of brands on a card with the unencrypted card number
       description: Example request for getting a list of brands on a card using the
         first 6 digits of the card number.
       value:
@@ -10773,6 +10861,27 @@ components:
         shopperInteraction: ContAuth
         shopperReference: YOUR_SHOPPER_REFERENCE
         recurringProcessingModel: CardOnFile
+    post-donations-donations-with-token-200:
+      summary: Successful donation transaction with a token
+      value:
+        amount:
+          currency: EUR
+          value: 500
+        donationAccount: CHARITY_ACCOUNT
+        id: UNIQUE_RESOURCE_ID
+        merchantAccount: YOUR_MERCHANT_ACCOUNT
+        payment:
+          pspReference: FJM726V375BV9D82
+          resultCode: Authorised
+        reference: '1412563167350061'
+        status: completed
+    post-donations-donations-with-token-422:
+      summary: Example error response when the donation account is not valid
+      value:
+        status: 422
+        errorCode: '187'
+        message: Field 'additionalData.donationAccount' is not valid.
+        errorType: validation
     post-orders-basic:
       summary: Create an order
       value:
@@ -13432,3 +13541,85 @@ components:
             value: 200
           type: Commission
           reference: '6124146'
+    post-paypal-updateOrder-advanced-with-delivery:
+      summary: Update a PayPal order with delivery methods in an Advanced flow integration
+      value:
+        pspReference: DZ4DPSHB4WD2WN82
+        paymentData: po7XZ...
+        amount:
+          currency: EUR
+          value: 12000
+        deliveryMethods:
+        - reference: '1'
+          description: Express Shipping
+          type: Shipping
+          amount:
+            currency: EUR
+            value: 1000
+          selected: true
+        - reference: '2'
+          description: Standard Ground
+          type: Shipping
+          amount:
+            currency: EUR
+            value: 500
+          selected: false
+    post-paypal-updateOrder-advanced-with-delivery-200:
+      summary: Order updated with delivery methods in an Advanced flow integration
+      value:
+        paymentData: po7XZ...
+        status: success
+    post-paypal-updateOrder-advanced-without-delivery:
+      summary: Update a PayPal order in an Advanced flow integration
+      value:
+        pspReference: HWL5D5BDLSGLNK82
+        paymentData: kly45P...
+        amount:
+          currency: EUR
+          value: 1200
+    post-paypal-updateOrder-advanced-without-delivery-200:
+      summary: Order updated with delivery methods in an Advanced flow integration
+      value:
+        paymentData: kly45P...
+        status: success
+    post-paypal-updateOrder-sessions-with-delivery:
+      summary: Update a PayPal order with delivery methods in a Sessions flow integration
+      value:
+        sessionId: CS12345679
+        paymentData: ey4YZ...
+        amount:
+          currency: EUR
+          value: 12000
+        deliveryMethods:
+        - reference: '1'
+          description: Express Shipping
+          type: Shipping
+          amount:
+            currency: EUR
+            value: 1000
+          selected: true
+        - reference: '2'
+          description: Standard Ground
+          type: Shipping
+          amount:
+            currency: EUR
+            value: 500
+          selected: false
+    post-paypal-updateOrder-sessions-with-delivery-200:
+      summary: Order updated with delivery methods in a Sessions flow integration
+      value:
+        paymentData: ey4YZ...
+        status: success
+    post-paypal-updateOrder-sessions-without-delivery:
+      summary: Update a PayPal order in a Sessions flow integration
+      value:
+        sessionId: CS12345679
+        paymentData: em9YZ...
+        amount:
+          currency: EUR
+          value: 8700
+    post-paypal-updateOrder-sessions-without-delivery-200:
+      summary: Order updated in a Sessions flow integration
+      value:
+        paymentData: em9YZ...
+        status: success