pcp-server-ruby-sdk 1.12.0 → 1.14.0

data/api-definition.yaml

@@ -1,7 +1,7 @@
 openapi: "3.0.3"
 
 info:
-  version: 1.57.0
+  version: 1.65.0
   title: "Commerce Platform API"
   description: |
     RESTful API for the creation of Commerce Cases with Checkouts and the execution of Payments.
@@ -23,8 +23,52 @@ tags:
     description: Resource for operations on Payment Executions. Requires PAYMENT_EXECUTION as allowedPaymentActions.
   - name: PaymentInformation
     description: Resource for operations on Payment Information.
+  - name: PaymentIntent
+    description: Resource for operations on Payment Intent.
 
 paths:
+  /v1/{merchantId}/authentication-tokens:
+    post:
+      summary: Generate a authentication JWT token
+      operationId: generateAuthToken
+      tags:
+        - Authentication
+      parameters:
+        - name: merchantId
+          in: path
+          description: The Merchant Id
+          required: true
+          schema:
+            type: string
+        - in: header
+          name: X-Request-ID
+          required: false
+          description: Identifier for this request as provided by the client. Will be used
+            in all log statements
+          schema:
+            type: string
+            format: uuid
+      responses:
+        '201':
+          description: Successfully generated authentication token
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AuthenticationToken'
+        '400':
+          x-nullable: true
+          description: Exception when creating DirectAPIKey with unknown or invalid parameters.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          x-nullable: true
+          description: Server error when creating authentication token.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
   '/v1/{merchantId}/commerce-cases':
     post:
       summary: Create a Commerce Case
@@ -176,7 +220,7 @@ paths:
                 $ref: '#/components/schemas/ErrorResponse'
   '/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/order':
     post:
-      summary: Creates an Order that will automatially execute a Payment
+      summary: Creates an Order that will automatically execute a Payment
       description: |
         This endpoint can be used to create an Order that automatically executes a payment for the respective Checkout. 
         The Order request requires items within the ShoppingCart and can be made for a partial or the entire
@@ -620,6 +664,9 @@ paths:
         - $ref: '#/components/parameters/companyInformation'
         - $ref: '#/components/parameters/terminalId'
         - $ref: '#/components/parameters/reportingToken'
+        - $ref: '#/components/parameters/cardAuthorizationId'
+        - $ref: '#/components/parameters/receiptNumber'
+        - $ref: '#/components/parameters/traceNumber'
       responses:
         '200':
           x-nullable: true
@@ -636,6 +683,57 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+  '/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}/pay-by-link':
+    post:
+      summary: "Create a pay-link"
+      description: |-
+        This endpoint can be used to create a pay-link using which customer can make payment for the check out.
+      tags:
+        - PaybyLink
+      operationId: createPayByLink
+      parameters:
+        - $ref: '#/components/parameters/merchantIdPath'
+        - $ref: '#/components/parameters/commerceCaseIdPath'
+        - $ref: '#/components/parameters/checkoutIdPath'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreatePayByLinkRequest'
+      responses:
+        '201':
+          description: |-
+            The response contains the details of the created pay-link.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CreatePayByLinkResponse'
+        '404':
+          description: |-
+            No matching data found for the given input parameters.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          description: Internal server exception
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '503':
+          description: Service unavailable.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '400':
+          description: "Data validation errors"
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
   '/v1/{merchantId}/commerce-cases/{commerceCaseId}/checkouts/{checkoutId}':
     get:
       summary: Get Checkout Details
@@ -1473,8 +1571,96 @@ paths:
               schema:
                 $ref: '#/components/schemas/RefundErrorResponse'
 
+  '/v1/{merchantId}/payment-intents':
+    post:
+      summary: Create a Payment Intent
+      description: |-
+        This endpoint can be used to create a payment intent for PayPal payment method.
+      tags:
+        - PaymentIntent
+      operationId: createPaymentIntent
+      parameters:
+        - $ref: '#/components/parameters/merchantIdPath'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CreatePaymentIntentRequest'
+      responses:
+        '201':
+          x-nullable: true
+          description: The response contains the reference of the created Payment Intent.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/CreatePaymentIntentResponse'
+        '400':
+          x-nullable: true
+          description: Incorrect input data
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '404':
+          x-nullable: true
+          description: Payment not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '409':
+          x-nullable: true
+          description: Creation of Payment Information is not allowed
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+        '500':
+          x-nullable: true
+          description: Internal server exception
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+  '/v1/{merchantId}/payment-intents/{paymentIntentId}':
+    get:
+      summary: Get a Payment Intent
+      description: |-
+        This endpoint can be used to get a paymentIntent.
+      tags:
+        - PaymentIntent
+      operationId: getPaymentIntent
+      parameters:
+        - $ref: '#/components/parameters/merchantIdPath'
+        - $ref: '#/components/parameters/paymentIntentId'
+      responses:
+        '200':
+          x-nullable: true
+          description: The response contains the reference of the created Payment Intent.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PaymentIntentResponse'
+        '404':
+          x-nullable: true
+          description: Payment not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+
 components:
   parameters:
+    cardAuthorizationId:
+      in: query
+      name: cardAuthorizationId
+      description: |-
+        Filter your results by the authorization ID assigned to the card payment.
+      schema:
+        type: string
+        maxLength: 8
+      example: 260042
     checkoutIdPath:
       in: path
       name: checkoutId
@@ -1749,6 +1935,14 @@ components:
       schema:
         type: string
         format: UUID
+    paymentIntentId:
+      in: path
+      name: paymentIntentId
+      description: Unique identifier of a paymentIntent
+      required: true
+      schema:
+        type: string
+        format: UUID
     paymentReference:
       in: query
       name: paymentReference
@@ -1764,6 +1958,15 @@ components:
         type: string
         x-trim-at: 20
       example: '+1234567890'
+    receiptNumber:
+      in: query
+      name: receiptNumber
+      description: |-
+        Filter your results by the receipt number set by the terminal.
+      schema:
+        type: string
+        maxLength: 40
+      example: 0321
     reportingToken:
       in: query
       name: reportingToken
@@ -1895,6 +2098,15 @@ components:
         maximum: 999999999999
         minimum: 0
       example: 1000
+    traceNumber:
+      in: query
+      name: traceNumber
+      description: |-
+        Filter your results by the trace number set by the terminal.
+      schema:
+        type: string
+        maxLength: 40
+      example: 012345
   schemas:
     Address:
       type: object
@@ -1986,6 +2198,15 @@ components:
           maxLength: 10
         name:
           $ref: '#/components/schemas/PersonalName'
+    AddressSelectionAtPayPal:
+      type: boolean
+      description: |-
+        Indicates whether to use PayPal Express Checkout Shortcut.
+         * true = When shortcut is enabled, the consumer can select a shipping address during PayPal checkout.
+         * false = When shortcut is disabled, the consumer cannot change the shipping address.
+        Default value is false.
+        Please note that this field is ignored when order.additionalInput.typeInformation.purchaseType is set to
+        "digital"
     AllowedPaymentActions:
       type: string
       enum:
@@ -2123,6 +2344,7 @@ components:
           * SALE - The payment creation results in an authorization that is already captured at the moment of approval. 
         
         If the parameter is not provided in the request, the default value will be PRE_AUTHORIZATION
+      default: PRE_AUTHORIZATION
     BankAccountInformation:
       type: object
       description: Object containing information about the end customer's bank account.
@@ -2254,6 +2476,8 @@ components:
           type: array
           items:
             $ref: '#/components/schemas/CancelItem'
+        fundSplit:
+          $ref: '#/components/schemas/FundSplit'
     CancelResponse:
       type: object
       properties:
@@ -2563,7 +2787,7 @@ components:
           enum:
             - first
             - recurring
-    CartItemInput:
+    CartItemData:
       type: object
       description: This object contains information of all items in the cart.
         If a cart item is provided, the productPrice and quantity is required.
@@ -2573,6 +2797,14 @@ components:
           $ref: '#/components/schemas/CartItemInvoiceData'
         orderLineDetails:
           $ref: '#/components/schemas/OrderLineDetailsInput'
+    CartItemInput:
+      type: object
+      description: This object contains information of all items in the cart.
+        If a cart item is provided, the productPrice and quantity is required.
+      allOf:
+        - $ref: '#/components/schemas/CartItemData'
+      additionalProperties: false
+      properties:
         supplierReferences:
           $ref: '#/components/schemas/CartItemSupplierReferences'
     CartItemInvoiceData:
@@ -2998,6 +3230,41 @@ components:
           type: string
           format: UUID
           example: "4f0c512e-f12c-11ec-8ea0-0242ac120002"
+    CreatePaymentIntent:
+      type: object
+      description: |
+        Object containing payment intent details.
+      additionalProperties: false
+      properties:
+        amountOfMoney:
+          $ref: '#/components/schemas/AmountOfMoney'
+        references:
+          $ref: '#/components/schemas/PaymentReferencesForPaymentIntent'
+        shoppingCart:
+          $ref: '#/components/schemas/ShoppingCartData'
+      required:
+        - references
+    CreatePaymentIntentRequest:
+      title: PaymentIntentRequest
+      type: object
+      description: |
+        Object containing details for creating a payment intent.
+      allOf:
+        - $ref: '#/components/schemas/CreatePaymentIntent'
+      additionalProperties: false
+      properties:
+        paymentMethodSpecificInput:
+          $ref: '#/components/schemas/PaymentMethodSpecificInputForIntent'
+    CreatePaymentIntentResponse:
+      title: PaymentIntentResponse
+      type: object
+      description: Object containing details on the created payment intent.
+      additionalProperties: false
+      properties:
+        shoppingCart:
+          $ref: '#/components/schemas/ShoppingCartData'
+        paymentIntentOutput:
+          $ref: '#/components/schemas/PaymentIntentOutput'
     CreationDateTime:
       type: string
       format: date-time
@@ -3288,6 +3555,14 @@ components:
           $ref: '#/components/schemas/PaymentProduct3391SpecificOutput'
         paymentInstructions:
           $ref: '#/components/schemas/PaymentInstructions'
+    FraudNetId:
+      type: string
+      format: UUID
+      description: |-
+        A unique ID determined by the merchant, to link a Paypal transaction to a FraudNet PayPal risk session. Only applicable to 
+        customer-initiated transactions, when the FraudNet SDK is used, and to be passed in the API request the same tracking ID value 
+        (FraudNet Session Identifier).
+      example: 686e5823-1ffd-42f7-9ba3-42b41b57d8dd
     FundDistribution:
       type: object
       description: Instructions for distributing funds to multiple sellers or partners in a marketplace context.
@@ -3459,6 +3734,15 @@ components:
         - nominalInterestRate
         - numberOfPayments
         - totalAmount
+    JavaScriptSdkFlow:
+      type: boolean
+      description: |-
+        Indicates whether the PayPal JavaScript SDK flow is used.
+        * true = The PayPal JavaScript SDK flow is used.
+        * false = The PayPal JavaScript SDK flow is not used.
+        Default value is false.
+      default: false
+      example: true
     LinkInformation:
       type: object
       description: URL and content type information for an web resource.
@@ -4017,6 +4301,10 @@ components:
           $ref: '#/components/schemas/FundSplit'
       required:
         - paymentReferences
+    PaymentId:
+      description: reference to the paymentProcess.
+      type: string
+      example: "PP2000A6CC1A9R00"
     PaymentInformationRefundRequest:
       type: object
       description: |
@@ -4123,6 +4411,18 @@ components:
             (e.g. card present payments, cash payments or payments processed by other payment providers).
           maxLength: 40
           example: 6a891660b8cf16edaeb26f87d86f0b2f
+        traceNumber:
+          type: string
+          description: Tracenumber that is incremented by the terminal by 1 for every transaction request.
+            It is printed on the customer receipt. Usually it has an upper limit and restarts by 0 or 1 if the upper limit is reached.
+          maxLength: 40
+          example: "012345"
+        receiptNumber:
+          type: string
+          description: Receiptnumber, that is incremented by 1 by the terminal for every successful financial transaction.
+            It is printed on the customer receipt. Usually it has an upper limit and restarts by 0 or 1 if the upper limit is reached.
+          maxLength: 40
+          example: "0321"
         creationDateTime:
           type: string
           format: date-time
@@ -4175,6 +4475,42 @@ components:
           type: string
           description: Status, usually describing the status of the invoice if paid, overdue, open...
       description: Object containing information on payment instructions details (e.g. on the invoice payments)
+    PaymentIntentId:
+      description: reference to the paymentIntent.
+      type: string
+      format: UUID
+      example: "a54749ff-df7c-4686-bf33-fe76d3cf4502"
+    PaymentIntentOutput:
+      type: object
+      description: Object containing details on the created payment intent.
+      allOf:
+        - $ref: '#/components/schemas/PaymentIntentResponseData'
+      additionalProperties: false
+      properties:
+        redirectPaymentMethodSpecificOutput:
+          $ref: '#/components/schemas/RedirectPaymentMethodSpecificOutputForCreateIntent'
+    PaymentIntentResponse:
+      type: object
+      description: Object containing details for payment intent.
+      allOf:
+        - $ref: '#/components/schemas/PaymentIntentResponseData'
+      additionalProperties: false
+      properties:
+        redirectPaymentMethodSpecificOutput:
+          $ref: '#/components/schemas/RedirectPaymentMethodSpecificOutputForIntent'
+    PaymentIntentResponseData:
+      type: object
+      description: Object containing details for payment intent.
+      additionalProperties: false
+      properties:
+        amountOfMoney:
+          $ref: '#/components/schemas/AmountOfMoney'
+        references:
+          $ref: '#/components/schemas/PaymentReferences'
+        paymentIntentId:
+          $ref: '#/components/schemas/PaymentIntentId'
+        paymentId:
+          $ref: '#/components/schemas/PaymentId'
     PaymentMethodSpecificInput:
       type: object
       description: |
@@ -4197,6 +4533,15 @@ components:
           $ref: '#/components/schemas/CustomerDevice'
         paymentChannel:
           $ref: '#/components/schemas/PaymentChannel'
+    PaymentMethodSpecificInputForIntent:
+      title: paymentMethodSpecificInput
+      type: object
+      description: |
+        Input for the payment for a payment intent method.
+      additionalProperties: false
+      properties:
+        redirectPaymentMethodSpecificInput:
+          $ref: '#/components/schemas/RedirectPaymentMethodSpecificInputForIntent'
     PaymentOutput:
       type: object
       description: |
@@ -4330,6 +4675,28 @@ components:
           type: string
           description: Surname of the PayPal account holder
           example: Doe
+    PaymentProduct840CustomerAccountForIntent:
+      type: object
+      description: |
+        Object containing the details of the PayPal account.
+      additionalProperties: false
+      properties:
+        companyName:
+          type: string
+          description: Name of the company in case the PayPal account is owned by a business
+          example: Customer Company Name
+        firstName:
+          type: string
+          description: First name of the PayPal account holder
+          example: John
+        surname:
+          type: string
+          description: Surname of the PayPal account holder
+          example: Doe
+        emailAddress:
+          type: string
+          description: Email address of the customer
+          maxLength: 70
     PaymentProduct840SpecificOutput:
       type: object
       description: |
@@ -4340,15 +4707,24 @@ components:
           $ref: '#/components/schemas/Address'
         customerAccount:
           $ref: '#/components/schemas/PaymentProduct840CustomerAccount'
+        payPalTransactionId:
+          $ref: '#/components/schemas/PayPalTransactionId'
         shippingAddress:
           $ref: '#/components/schemas/Address'
+    PaymentProduct840SpecificOutputForIntent:
+      type: object
+      description: |
+        PayPal (payment product 840) specific details.
+      additionalProperties: false
+      properties:
+        billingAddress:
+          $ref: '#/components/schemas/Address'
+        customerAccount:
+          $ref: '#/components/schemas/PaymentProduct840CustomerAccountForIntent'
         payPalTransactionId:
-          type: string
-          maxLength: 20
-          description: |-
-            A 17-character unique identifier of the PayPal transaction. This identifier is used to identify the transaction in the
-            PayPal system and needed for the PayPal Javascript SDK flow.
-          example: 9A1234567890123
+          $ref: '#/components/schemas/PayPalTransactionId'
+        shippingAddress:
+          $ref: '#/components/schemas/ShippingAddress'
     PaymentProductId:
       type: integer
       format: int32
@@ -4370,6 +4746,15 @@ components:
             If provided for captures or refunds, it must be unique per Checkout.
           maxLength: 20
           example: your-order-6372
+    PaymentReferencesForPaymentIntent:
+      description: |-
+        Object that holds all reference properties that are linked to this transaction.
+        Extends the standard PaymentReferences by making merchantReference mandatory when creating a payment intent.
+      allOf:
+        - $ref: '#/components/schemas/PaymentReferences'
+        - type: object
+          required:
+            - merchantReference
     PaymentReferencesForRefund:
       type: object
       description: |-
@@ -4468,6 +4853,13 @@ components:
           type: string
           description: Unique payment transaction identifier of the payment gateway.
           example: PP1AA7KKLSFB9MBG
+    PayPalTransactionId:
+      type: string
+      maxLength: 20
+      description: |-
+        A 17-character unique identifier of the PayPal transaction. This identifier is used to identify the transaction in the
+        PayPal system and needed for the PayPal Javascript SDK flow.
+      example: 9A1234567890123
     PersonalInformation:
       type: object
       description: Object containing personal information like name, date of birth and gender.
@@ -4622,14 +5014,7 @@ components:
       additionalProperties: false
       properties:
         requiresApproval:
-          type: boolean
-          description: |-
-            * true = the payment requires approval before the funds will be captured using the Approve payment or
-            Capture payment API
-            * false = the payment does not require approval, and the funds will be captured automatically
-            
-            If the parameter is not provided in the request, the default value will be true
-          default: true
+          $ref: '#/components/schemas/RequiresApproval'
         paymentProcessingToken:
           type: string
           description: ID of the token to use to create the payment.
@@ -4657,6 +5042,21 @@ components:
           $ref: '#/components/schemas/RedirectPaymentProduct900SpecificInput'
         redirectionData:
           $ref: '#/components/schemas/RedirectionData'
+    RedirectPaymentMethodSpecificInputForIntent:
+      title: redirectPaymentMethodSpecificInput
+      type: object
+      description: |-
+        Object containing the specific input details for payment intents that involve redirects to PayPay to complete
+      additionalProperties: false
+      properties:
+        requiresApproval:
+          $ref: '#/components/schemas/RequiresApproval'
+        paymentProductId:
+          $ref: '#/components/schemas/PaymentProductId'
+        paymentProduct840SpecificInput:
+          $ref: '#/components/schemas/RedirectPaymentProduct840SpecificInputData'
+        redirectionData:
+          $ref: '#/components/schemas/RedirectionData'
     RedirectPaymentMethodSpecificOutput:
       type: object
       description: |
@@ -4677,36 +5077,54 @@ components:
           description: Token to identify the card in the reporting.
           example: 12a037cc-833d-8b45-8f6f-11c34171f4e1
           maxLength: 40
+    RedirectPaymentMethodSpecificOutputForCreateIntent:
+      title: redirectPaymentMethodSpecificOutput
+      type: object
+      description: |
+        Object containing the redirect payment product details for a created payment intent.
+      additionalProperties: false
+      properties:
+        requiresApproval:
+          $ref: '#/components/schemas/RequiresApproval'
+        paymentProductId:
+          $ref: '#/components/schemas/PaymentProductId'
+        paymentProduct840SpecificOutput:
+          $ref: '#/components/schemas/RedirectPaymentProduct840SpecificInputData'
+        redirectionData:
+          $ref: '#/components/schemas/RedirectionData'
+    RedirectPaymentMethodSpecificOutputForIntent:
+      title: redirectPaymentMethodSpecificOutput
+      type: object
+      description: |
+        Object containing the redirect payment product details for payment intent.
+      additionalProperties: false
+      properties:
+        paymentProductId:
+          $ref: '#/components/schemas/PaymentProductId'
+        paymentProduct840SpecificOutput:
+          $ref: '#/components/schemas/PaymentProduct840SpecificOutputForIntent'
     RedirectPaymentProduct840SpecificInput:
       type: object
       description: Object containing specific input required for PayPal payments (Payment product ID 840)
+      allOf:
+        - $ref: '#/components/schemas/RedirectPaymentProduct840SpecificInputData'
       properties:
-        addressSelectionAtPayPal:
-          type: boolean
-          description: |-
-            Indicates whether to use PayPal Express Checkout Shortcut.
-             * true = When shortcut is enabled, the consumer can select a shipping address during PayPal checkout.
-             * false = When shortcut is disabled, the consumer cannot change the shipping address.
-            Default value is false.
-            Please note that this field is ignored when order.additionalInput.typeInformation.purchaseType is set to
-            "digital"
         fraudNetId:
+          $ref: '#/components/schemas/FraudNetId'
+        paymentId:
           type: string
-          format: UUID
-          description: |-
-            A unique ID determined by the merchant, to link a Paypal transaction to a FraudNet PayPal risk session. Only applicable to 
-            customer-initiated transactions, when the FraudNet SDK is used, and to be passed in the API request the same tracking ID value 
-            (FraudNet Session Identifier).
-          example: 686e5823-1ffd-42f7-9ba3-42b41b57d8dd
+          description: Unique payment transaction identifier of the payment gateway. Required for PayPal Express to associate the request with the original payment intent.
+          example: '3066019730_1'
+          writeOnly: true
+    RedirectPaymentProduct840SpecificInputData:
+      title: paymentProduct840SpecificInput
+      type: object
+      description: Object containing specific input required for PayPal payments (Payment product ID 840)
+      properties:
+        addressSelectionAtPayPal:
+          $ref: '#/components/schemas/AddressSelectionAtPayPal'
         javaScriptSdkFlow:
-          type: boolean
-          description: |-
-            Indicates whether the PayPal JavaScript SDK flow is used.
-            * true = The PayPal JavaScript SDK flow is used.
-            * false = The PayPal JavaScript SDK flow is not used.
-            Default value is false.
-          default: false
-          example: true
+          $ref: '#/components/schemas/JavaScriptSdkFlow'
     RedirectPaymentProduct900SpecificInput:
       type: object
       properties:
@@ -4880,6 +5298,14 @@ components:
           $ref: '#/components/schemas/ReturnInformation'
         fundSplit:
           $ref: '#/components/schemas/FundSplit'
+    RequiresApproval:
+      type: boolean
+      description: |-
+        * true = the payment requires approval before the funds will be captured using the Approve payment or Capture payment API
+        * false = the payment does not require approval, and the funds will be captured automatically
+
+        If the parameter is not provided in the request, the default value will be true
+      default: true
     ReturnInformation:
       type: object
       description: |-
@@ -5008,6 +5434,27 @@ components:
       properties:
         address:
           $ref: '#/components/schemas/AddressPersonal'
+    ShippingAddress:
+      type: object
+      description: |
+        Object containing information regarding shipping / delivery
+      allOf:
+        - $ref: '#/components/schemas/AddressPersonal'
+      additionalProperties: false
+      properties:
+        companyName:
+          type: string
+          description: |
+            Company name if needed
+    ShoppingCartData:
+      type: object
+      description: |
+        Shopping cart data, including items and specific amounts.
+      properties:
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/CartItemData'
     ShoppingCartInput:
       type: object
       description: |
@@ -5208,3 +5655,209 @@ components:
         - first
         - subsequent
       x-enum-to-string: false
+    CreatePayByLinkRequest:
+      type: object
+      description: Request object for pay-link generation.
+      properties:
+        paymentLinkSpecificInput:
+          $ref: '#/components/schemas/PaymentLinkSpecificInput'
+        orderType:
+          $ref: '#/components/schemas/OrderType'
+        items:
+          type: array
+          items:
+            $ref: '#/components/schemas/OrderItem'
+        orderReferences:
+          $ref: '#/components/schemas/References'
+      required:
+        - paymentLinkSpecificInput
+        - orderType
+        - orderReferences
+    PaymentLinkSpecificInput:
+      type: object
+      description: Object containing the specific input details for generating Pay-link
+      properties:
+        expirationDate:
+          type: string
+          format: date-time
+          description: |-
+            If provided it overwrites 24 h default validity.
+            Date and time in RFC3339 format after which Items (Checkouts or Commerce-Cases, depending on the context) should be included in the request. Accepted formats are:
+              YYYY-MM-DD'T'HH:mm:ss'Z'
+              YYYY-MM-DD'T'HH:mm:ss+XX:XX
+              YYYY-MM-DD'T'HH:mm:ss-XX:XX
+              YYYY-MM-DD'T'HH:mm'Z'
+              YYYY-MM-DD'T'HH:mm+XX:XX
+              YYYY-MM-DD'T'HH:mm-XX:XX
+            All other formats may be ignored by the system.
+            some examples:
+              YYYY-MM-DDThh:mm:ssZ:
+                value: 2022-11-10T13:34:23Z
+              YYYY-MM-DDThh:mm:ss+XX:XX:
+                value: 2022-11-10T14:34:23+01:00
+        authorizationMode:
+          $ref: '#/components/schemas/AuthorizationMode'
+        paymentMethods:
+          type: array
+          items:
+            $ref: '#/components/schemas/PaymentMethodId'
+          description: List of supported Payment product identifiers
+          example: [ 1,2,3,390 ]
+        bnplId:
+          type: string
+          description: Dedicated ID to be known when the page is generated to display the BNPL payment methods in order to create a dedicated identification token.
+          example: 18323
+        returnUrl:
+          type: string
+          format: uri
+          pattern: '^(https?|ftp)://[^\s/$.?#].[^\s]*$'
+          description: |-
+            The URL that the customer is redirect to after the payment flow has finished. You can add any number of key
+            value pairs in the query string that, for instance help you to identify the customer when they return to
+            your site. Please note that we will also append some additional key value pairs that will also help you with
+            this identification process.
+            Note: The provided URL should be absolute and contain the protocol to use, e.g. http:// or https://. For use
+            on mobile devices a custom protocol can be used in the form of protocol://. This protocol must be registered
+            on the device first.
+            URLs without a protocol will be rejected.
+          maxLength: 2048
+          example: "https://shop.url/orderfinishedetc"
+        logoUrl:
+          type: string
+          format: uri
+          pattern: '^(https?|ftp)://[^\s/$.?#].[^\s]*$'
+          description: To be used If the Merchant wants the customer to see his Logo ( special size need to be defined )
+          maxLength: 2048
+          example: "https://shop.url/orderfinishedetc"
+        autoRedirection:
+          type: boolean
+          example: true
+          description: |-
+            with the cases:
+            If is false and ReturnURl is not present, then no Button is displayed for shopper to come back
+            If is false but ReturnUrl is present then, a button will be displayed with a custom message if user wants to go back to merchant
+            If is True, no button will be displayed, and when payment is completed, user is returned back to a landing page on the merchant side using the returnUrl|
+        termsUrl:
+          type: string
+          format: uri
+          pattern: '^(https?|ftp)://[^\s/$.?#].[^\s]*$'
+          description: |-
+            Url to show the customer terms & conditions content
+          maxLength: 2048
+          example: "https://shop.url/tersmandconditions"
+        retryNumber:
+          type: integer
+          format: int64
+          description: Number of times to retry the back end apis, if not specified by default 3 retries
+          example: 4
+          minimum: 1
+          maximum: 20
+        merchantName:
+          $ref: '#/components/schemas/MerchantName'
+        merchantOrigin:
+          $ref: '#/components/schemas/MerchantOrigin'
+      required:
+        - authorizationMode
+        - paymentMethods
+    PaymentMethodId:
+      type: string
+      description: Payment method identifier used by the payment engine.
+    CreatePayByLinkResponse:
+      type: object
+      description: Object containing details about created Pay-link.
+      additionalProperties: false
+      properties:
+        expirationDate:
+          type: string
+          format: date-time
+          description: |-
+            If provided it overwrites 24 h default validity.
+            Date and time in RFC3339 format after which Items (Checkouts or Commerce-Cases, depending on the context) should be included in the request. Accepted formats are:
+              YYYY-MM-DD'T'HH:mm:ss'Z'
+              YYYY-MM-DD'T'HH:mm:ss+XX:XX
+              YYYY-MM-DD'T'HH:mm:ss-XX:XX
+              YYYY-MM-DD'T'HH:mm'Z'
+              YYYY-MM-DD'T'HH:mm+XX:XX
+              YYYY-MM-DD'T'HH:mm-XX:XX
+            All other formats may be ignored by the system.
+            some examples:
+              YYYY-MM-DDThh:mm:ssZ:
+                value: 2022-11-10T13:34:23Z
+              YYYY-MM-DDThh:mm:ss+XX:XX:
+                value: 2022-11-10T14:34:23+01:00
+        paymentLinkOrder:
+          $ref: "#/components/schemas/PaymentLinkOrder"
+        status:
+          $ref: '#/components/schemas/PayLinkStatusValue'
+        redirectionUrl:
+          type: string
+          example: "https://commerceplatformURL/25296588-4ddc-4632-9818-532840d49780"
+        paymentLinkId:
+          type: string
+          format: UUID
+          description: Unique identifier for the pay-link
+    PaymentLinkOrder:
+      type: object
+      properties:
+        merchantReference:
+          type: string
+          example: "Order-20250119112400"
+        amount:
+          type: object
+          properties:
+            amount:
+              type: integer
+              format: int64
+              example: 30200
+              description: Total amount of money to be paid
+            currencyCode:
+              type: string
+              description: Currency code (e.g., EUR)
+    PayLinkStatusValue:
+      type: string
+      description: enum for pay-link status
+      enum:
+        - ACTIVE
+        - PAID
+        - EXPIRED
+        - REDIRECTED
+    MerchantName:
+      type: string
+      description: >-
+        The canonical name of the merchant that initiates the checkout,
+        per your records. This name needs to be suitable for display.
+        Don't localize the name.
+      example: "TestMerchant"
+    MerchantOrigin:
+      type: string
+      description: >-
+        The fully qualified domain of the merchant who made the request.
+        Make this string the hostname of the merchant's website where the
+        checkout initiation occurs. For international (non-ASCII) domains,
+        use Punycode. For example, if the merchant domain is google.rf,
+        provide an origin value of xn-c1aay4a.xn-p1ai. The string can
+        include an optional port number if it doesn't use a standard HTTP
+        or HTTPS port value.
+      example: "merchant.example.com"
+    AuthenticationToken:
+      type: object
+      properties:
+        token:
+          type: string
+          description: The JWT authentication token
+          example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
+        id:
+          type: string
+          format: uuid
+          description: The unique identifier of the JWT authentication token
+          example: "b311ea35-57c9-4118-8712-9a5bd253eb37"
+        creationDate:
+          type: string
+          format: date-time
+          description: The creation date of the JWT authentication token. Format YYYY-MM-DD'T'HH:mm:ss'Z'
+          example: "2023-10-01T00:00:00.000Z"
+        expirationDate:
+          type: string
+          format: date-time
+          description: The expiration date of the JWT authentication token. Format YYYY-MM-DD'T'HH:mm:ss'Z'
+          example: "2024-01-01T00:00:00.000Z"