HiPay Order API

openapi: 3.2.0
info:
  title: Hipay Order API
  version: '1.0'
  description: 'Operations tagged Order across 2 of this provider''s published API definitions: api-gateway.yml, pos-api.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://stage-api-gateway.hipay.com
  description: Stage
- url: https://api-gateway.hipay.com
  description: Production
- url: https://cloudrun-api-yugcnet4yq-ew.a.run.app/
  description: Stage
tags:
- name: Order
paths:
  /v3/order/{orderid}:
    get:
      tags:
      - Order
      operationId: get_api_order_consultation_public
      parameters:
      - name: orderid
        in: path
        description: Unique merchant orderid.
        required: true
        schema:
          type: string
        example: ORD_202501_0001
      responses:
        '200':
          description: Order retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Order'
        '401':
          description: An authentication error occurred/invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: This order is not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - ApiKeyAuth: []
      - BasicAuth: []
    servers:
    - url: https://stage-api-gateway.hipay.com
      description: Stage
    - url: https://api-gateway.hipay.com
      description: Production
  /v1/connector/order:
    post:
      security:
      - BasicAuth: []
      requestBody:
        required: true
        content:
          application/*:
            schema:
              $ref: '#/components/schemas/RootOrder'
      responses:
        200:
          description: OK - The request has succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderResponse'
        400:
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        401:
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        403:
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        500:
          description: KO - The request has failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      operationId: postOrder
      summary: Wake a POS payment terminal to process an order payment.
      tags:
      - Order
    servers:
    - url: https://cloudrun-api-yugcnet4yq-ew.a.run.app/
      description: Stage
components:
  schemas:
    Preference2:
      type: integer
      enum:
      - 1
      - 2
      - 3
      - 4
      - 5
      - 7
    OperationType2:
      type: string
      enum:
      - CAPTURE
      - CREDIT
      - REFUND
      - CHGBCK
      - CHGBCK_REFUND
      - RDR
    Authentication2:
      required:
      - eci
      properties:
        enrollment_status:
          description: ''
          type:
          - string
          - 'null'
          example: N
        enrollment_message:
          description: ''
          type:
          - string
          - 'null'
          example: Cardholder Not Enrolled
        authentication_status:
          oneOf:
          - $ref: '#/components/schemas/Authentication5'
        authentication_message:
          type:
          - string
          - 'null'
        eci:
          description: 'Electronic Commerce Indicator (ECI).


            The Electronic Commerce Indicator (ECI) is used by acquirers/issuers


            to determine the type of transaction being processed. The ECI value


            should represent the source of the transaction request. That is, the


            environment that the cardholder used to provide the payment card details


            to the merchant. It is important that merchants set the correct ECI


            value during transaction processing to ensure that appropriate merchant


            service rates are received.'
          type: integer
          example: 5
        sca_preference:
          description: "To indicate the preference for a frictionless flow during the authentication request, the merchant may send the sca_preference parameter.\n\nDepending on the merchant's assessment of the risk of fraud, specific values may be sent.\n\nThis parameter can only be used by merchants who have a fraud risk assessment mechanism of their own and who have subscribed to the SCA Preference merchant option.\n\nPlease contact your account manager to request it.\n\n`1` : No Preference.\n\n    If you are not sure about the transaction's risk of fraud, use this value. Using this value for all your transactions may result in a high strong customer authentication rate.\n\n`2` : No Challenge\n\n    If you think this transaction is safe. This will tell the acquirer a frictionless flow is preferred.\n\n`3` : Challenge Requested\n\n    If you think this transaction may be at risk, use this value. This will tell the acquirer that a strong customer authentication may be required, depending on the PSD2 specific information you sent along with the transaction."
          example: 1
          oneOf:
          - $ref: '#/components/schemas/Preference2'
        method:
          description: "To indicate the authentication method used :\n\n - 3DSecure\n\n - ApplePay"
          type:
          - string
          - 'null'
          example: 3DSecure
        three_ds_version:
          description: 3D Secure Version
          type:
          - string
          - 'null'
          example: '2'
        three_ds_authentication_method:
          description: "3D Secure Authentication Method:\n\n - challenge\n\n - frictionless\n\n - <i>empty</i>"
          example: frictionless
          oneOf:
          - $ref: '#/components/schemas/ThreeDSAuthenticationMethod2'
        three_ds_liability:
          description: "3D Secure payment liability shift:\n\n - issuer\n\n - merchant\n\n - not applicable"
          example: issuer
          oneOf:
          - $ref: '#/components/schemas/ThreeDSAuthenticationLiability2'
      type: object
    OperationStatus2:
      type: string
      enum:
      - CANCELLED
      - COMPLETED
      - CREATED
      - FAILURE
      - NOT_PROCESSED
      - PENDING
      - RECONCILED
      - REMITTED
      - REQUESTED
      - RETRIED
      - SPLIT
      - CHGBCK
      - CHGBCK_REFUND
    Authentication5:
      type: string
      enum:
      - Authentication Successful
      - Authentication Attempt Performed
      - Authentication Failed
      - Authentication Could Not Be Performed
      - Error
      - Not applicable
      - Cardholder challenge required
      - Not authenticated because the issuer is rejecting authentication
      - Challenge required; decoupled authentication confirmed
      - Informational only; 3DS Requestor challenge preference acknowledged
      - Mastercard Delegated Authentication
    PaymentProduct2:
      required:
      - name
      - description
      properties:
        payment_method:
          oneOf:
          - $ref: '#/components/schemas/PaymentMethod2'
        name:
          type: string
        description:
          type: string
      type: object
    Address:
      properties:
        house_number:
          description: House number.
          type:
          - string
          - 'null'
          example: '101'
        house_extension:
          description: House extension.
          type:
          - string
          - 'null'
          example: B
        street:
          description: Street address.
          type:
          - string
          - 'null'
          example: Rue de Rivoli
        street_additional:
          description: Additional address information of the customer (e.g., building, floor, flat, etc.).
          type:
          - string
          - 'null'
          example: Immeuble B
        locality:
          description: City.
          type:
          - string
          - 'null'
          example: Paris
        locality_additional:
          description: The USA state or the Canada state of the customer making the purchase. Send this information only if the address country of the customer is US (USA) or CA (Canada)
          type:
          - string
          - 'null'
          example: ''
        postal_code:
          description: The zip or postal code of the customer.
          type:
          - string
          - 'null'
          example: '75001'
        country:
          description: Country code to which the order is being shipped. This two-letter country code complies with ISO 3166-1 (alpha 2).
          type:
          - string
          - 'null'
          example: FR
      type: object
    ComputedAuthenticationStatus2:
      type: string
      enum:
      - No authentication
      - Abandoned strong authentication
      - Unsuccessful authentication attempted
      - Challenge authentication
      - Frictionless authentication
      - Successful authentication
      - Failed authentication
      - Unknown authentication
    Cvc2:
      type: string
      enum:
      - Match
      - No Match
      - Not Processed
      - Missing
      - Not Supported
    Currency:
      type: string
      enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BRL
      - BSD
      - BTN
      - BWP
      - BYR
      - BZD
      - CAD
      - CDF
      - CHF
      - CLP
      - CNY
      - COP
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EEK
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - FRF
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LTL
      - LVL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MUR
      - MVR
      - MWK
      - MXN
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SKK
      - SLL
      - SOS
      - SRD
      - STD
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMM
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XCD
      - XOF
      - XPF
      - YER
      - ZAR
      - ZMK
      - ZWL
    Card2:
      properties:
        pan:
          type:
          - string
          - 'null'
        last_digits:
          type:
          - string
          - 'null'
        scheme:
          type:
          - string
          - 'null'
        category:
          type:
          - string
          - 'null'
        type:
          type:
          - string
          - 'null'
        bin:
          type:
          - integer
          - 'null'
        token:
          type:
          - string
          - 'null'
      type: object
    Order:
      required:
      - id
      - merchant_order_id
      - attempts
      - amount
      - shipping
      - tax
      - customer
      - shipping_to
      - date_created
      - transactions
      - currency
      - decimals
      properties:
        id:
          description: Unique order ID.
          type: integer
          example: '1537532589263'
        merchant_order_id:
          type: string
        attempts:
          description: Attempt identifier
          type: integer
          example: 1
        amount:
          description: Total order amount, calculated as the sum of purchased items, plus shipping fees (if present), plus tax fees (if present).
          type: string
          example: '8.99'
        shipping:
          description: The order shipping fee. It can be omitted if the shipping fee value is zero.
          type: string
          example: '1.30'
        tax:
          description: The order tax fee. It can be omitted if the order tax value is zero...
          type: string
          example: '1.10'
        customer:
          $ref: '#/components/schemas/Customer'
        shipping_to:
          $ref: '#/components/schemas/ShippingAddress'
        terminal_information:
          description: The customer terminal informations used for the order.
          oneOf:
          - $ref: '#/components/schemas/TerminalInformation'
        date_created:
          type: string
          format: date-time
        transactions:
          type: array
          items:
            $ref: '#/components/schemas/Transaction2'
        currency:
          $ref: '#/components/schemas/Currency'
        decimals:
          type: integer
          example: '2'
        billing_to:
          oneOf:
          - $ref: '#/components/schemas/Address'
        custom_data:
          type:
          - string
          - 'null'
      type: object
    ReasonCode2:
      properties:
        code:
          type:
          - integer
          - 'null'
        reason:
          type:
          - string
          - 'null'
      type: object
    Device2:
      required:
      - ip_address
      properties:
        id:
          type:
          - string
          - 'null'
        ip_address:
          description: The IP address of the Device
          type: string
          example: 127.0.0.1
      type: object
    TransactionState2:
      type: string
      enum:
      - completed
      - waiting
      - pending
      - declined
      - forwarding
      - error
    Issuer2:
      properties:
        fullname:
          type:
          - string
          - 'null'
        institution:
          type:
          - string
          - 'null'
        country:
          type:
          - string
          - 'null'
      type: object
    Status5:
      type: string
      enum:
      - available
      - created
      - error
      - incomplete
      - pending
      - suspended
      - terminated
    Status2:
      type: integer
      enum:
      - 1
      - 2
      - 3
      - 4
      - 52
      - 5
      - 6
      - 7
      - 8
      - 9
      - 10
      - 11
      - 12
      - 13
      - 14
      - 15
      - 42
      - 43
      - 75
      - 16
      - 55
      - 17
      - 18
      - 54
      - 19
      - 20
      - 21
      - 22
      - 23
      - 24
      - 65
      - 25
      - 26
      - 27
      - 28
      - 29
      - 34
      - 30
      - 31
      - 32
      - 40
      - 41
      - 80
      - 81
      - 82
      - 83
      - 50
      - 51
      - 53
      - 57
      - 69
      - 66
      - 72
      - 74
      - 77
      - 78
    Error:
      required:
      - message
      - code
      properties:
        message:
          type: string
        code:
          type: integer
        details:
          type:
          - array
          - 'null'
          items: {}
          default: null
        description:
          type:
          - string
          - 'null'
      type: object
    PaymentMethod2:
      required:
      - name
      - description
      properties:
        name:
          type: string
        description:
          type: string
      type: object
    Transaction2:
      required:
      - id
      - attemptid
      - state
      - status
      - eci
      - amount
      - captured_amount
      - refunded_amount
      - credited_amount
      - chargebacked_amount
      - acquirer
      - issuer
      - device
      - forward_url
      - customer_country
      - date_created
      - date_updated
      - mid
      - operations
      - authorized_amount
      - currency
      - decimals
      properties:
        id:
          description: Unique transaction ID.
          type: integer
          example: '2456731565945'
        attemptid:
          type: integer
        state:
          $ref: '#/components/schemas/TransactionState2'
        status:
          $ref: '#/components/schemas/Status2'
        computed_authentication_status:
          description: Transaction computed authentication status.
          example: Successful authentication
          oneOf:
          - $ref: '#/components/schemas/ComputedAuthenticationStatus2'
        reason:
          oneOf:
          - $ref: '#/components/schemas/ReasonCode2'
        eci:
          description: 'Electronic Commerce Indicator (ECI).


            The Electronic Commerce Indicator (ECI) is used by acquirers/issuers


            to determine the type of transaction being processed. The ECI value


            should represent the source of the transaction request. That is, the


            environment that the cardholder used to provide the payment card details


            to the merchant. It is important that merchants set the correct ECI


            value during transaction processing to ensure that appropriate merchant


            service rates are received.'
          type: integer
          example: 7
        amount:
          description: Transaction amount.
          type: string
          example: '125.75'
        captured_amount:
          description: Captured amount.
          type: string
          example: '125.75'
        refunded_amount:
          description: Refunded amount.
          type: string
          example: '0.00'
        credited_amount:
          description: Total credited.
          type: string
          example: '125.75'
        chargebacked_amount:
          description: Chargebacked amount.
          type: string
          example: '125.75'
        payment_product:
          description: The payment product used for processing current transaction.
          example: visa
          oneOf:
          - $ref: '#/components/schemas/PaymentProduct2'
        acquirer:
          $ref: '#/components/schemas/Acquirer2'
        acquirer_tra:
          oneOf:
          - $ref: '#/components/schemas/AcquirerTraContext2'
        issuer:
          $ref: '#/components/schemas/Issuer2'
        card:
          oneOf:
          - $ref: '#/components/schemas/Card2'
        debit_agreement:
          oneOf:
          - $ref: '#/components/schemas/DebitAgreement2'
        device:
          $ref: '#/components/schemas/Device2'
        authentication:
          oneOf:
          - $ref: '#/components/schemas/Authentication2'
        authorization_code:
          type:
          - string
          - 'null'
        forward_url:
          description: URL of the page on which to redirect the customer.
          type: string
          example: ''
        fraud_screening:
          oneOf:
          - $ref: '#/components/schemas/FraudResult2'
        cvc_result:
          oneOf:
          - $ref: '#/components/schemas/Cvc2'
        customer_country:
          type: string
          example: FR
        date_created:
          type: string
          format: date-time
        date_updated:
          description: 'Date of last status change.


            This date must comply with ISO 8601.'
          type: string
          format: date-time
        date_authorized:
          type:
          - string
          - 'null'
          format: date-time
        mid:
          description: 'Merchant id (MID).


            Unique identifier assigned to the merchant.'
          type: integer
        operations:
          type: array
          items:
            $ref: '#/components/schemas/Operation2'
        authorized_amount:
          description: Authorized amount.
          type: string
          example: '125.75'
        currency:
          $ref: '#/components/schemas/Currency'
        decimals:
          type: integer
          example: '2'
      type: object
    ThreeDSAuthenticationLiability2:
      type: string
      enum:
      - issuer
      - merchant
      - not applicable
    Review2:
      type: string
      enum:
      - ALLOWED
      - PENDING
      - DENIED
    ShippingAddress:
      properties:
        house_number:
          description: House number.
          type:
          - string
          - 'null'
          example: '101'
        house_extension:
          description: House extension.
          type:
          - string
          - 'null'
          example: B
        street:
          description: Street address.
          type:
          - string
          - 'null'
          example: Rue de Rivoli
        street_additional:
          description: Additional address information of the customer (e.g., building, floor, flat, etc.).
          type:
          - string
          - 'null'
          example: Immeuble B
        locality:
          description: City.
          type:
          - string
          - 'null'
          example: Paris
        locality_additional:
          description: The USA state or the Canada state of the customer making the purchase. Send this information only if the address country of the customer is US (USA) or CA (Canada)
          type:
          - string
          - 'null'
          example: ''
        postal_code:
          description: The zip or postal code of the customer.
          type:
          - string
          - 'null'
          example: '75001'
        country:
          description: Country code to which the order is being shipped. This two-letter country code complies with ISO 3166-1 (alpha 2).
          type:
          - string
          - 'null'
          example: FR
      type: object
    ThreeDSAuthenticationMethod2:
      type: string
      enum:
      - challenge
      - frictionless
      - ''
    AcquirerTraContext2:
      type: object
    Operation2:
      required:
      - type
      - status
      - amount
      - arn
      - date_created
      - id
      - currency
      - decimals
      properties:
        type:
          $ref: '#/components/schemas/OperationType2'
        status:
          $ref: '#/components/schemas/OperationStatus2'
        amount:
          description: Operation Amount.
          type: string
          example: '10.00'
        arn:
          description: Acquirer Reference Number.
          type: string
          example: '75064953264000221624949'
        merchant_reference:
          type:
          - string
          - 'null'
        date_created:
          type: string
          format: date-time
        date_updated:
          type:
          - string
          - 'null'
          format: date-time
        date_remitted:
          type:
          - string
          - 'null'
          format: date-time
        date_processed:
          type:
          - string
          - 'null'
          format: date-time
        date_reconciled:
          type:
          - string
          - 'null'
          format: date-time
        id:
          type: integer
        currency:
          $ref: '#/components/schemas/Currency'
        decimals:
          type: integer
          example: '2'
        caseid:
          type:
          - string
          - 'null'
      type: object
    CardEntryMode:
      type: string
      enum:
      - Not specified
      - Magstripe
      - Contactless chip transaction using EMV chip data
      - Contactless chip transaction using magstripe data
      - ICC
      - Manual entry
      - Magstripe, after attempt to read chip
      - Provided by a server
      - Card-on-File
    TerminalInformation:
      properties:
        payment_context:
          description: Payment context
          type:
          - string
          - 'null'
          example: online
        input_mode:
          description: Input mode
          type:
          - string
          - 'null'
          example: contact
        aid:
          description: Aid
          type:
          - string
          - 'null'
          example: A0000000422010
        payment_gateway:
          description: Payment gateway
          type:
          - string
          - 'null'
          example: nepting
        authorization_code:
          description: Authorization code
          type:
          - string
          - 'null'
          example: '00'
        authorization_number:
          description: Authorization number
          type:
          - string
          - 'null'
          example: '963379'
        customer_receipt:
          description: Customer receipt
          type:
          - string
          - 'null'
        payment_source:
          description: Payment source
          type:
          - string
          - 'null'
          example: IPN Nepting
        payment_terminal_serial_number:
          description: Payment terminal serial number
          type:
          - string
          - 'null'
        idsa:
          description: Acceptance system identifier assigned by an acquirer
          type:
          - string
          - 'null'
        rts:
          description: Transaction ID generated by the issuer auth system
          type:
          - string
          - 'null'
        card_entry_mode:
          description: Card entry mode
          example: magstripe
          oneOf:
          - $ref: '#/components/schemas/CardEntryMode'
        file_number:
          description: File number
          type:
          - string
          - 'null'
      type: object
    Customer:
      required:
      - email
      - phone
      properties:
        id:
          type:
          - string
          - 'null'
          example: '283749291'
        firstname:
          description: The customer’s first name. This value will be use to pre-fill cardholder name on credit card payment form.
          type:
          - string
          - 'null'
          example: Rose
        lastname:
          description: The customer’s last name. This value will be use to pre-fill cardholder name on credit card payment form.
          type:
          - string
          - 'null'
          example: Dévent
        email:
          description: The customer’s e-mail address.
          type: string
          example: otto.graph@foobar.email
        phone:
          description: The customer’s phone.
          type: string
          example: 01234567890
        language:
          type:
          - string
          - 'null'
          example: en_GB
      type: object
    Acquirer2:
      properties:
        transaction_reference:
          description: Unique Transaction Identifier.
          type:
          - string
          - 'null'
          example: '800000790677'
      type: object
    Result2:
      type: string
      enum:
      - NOT_LAUNCHED
      - PENDING
      - ACCEPTED
      - REQUEST EXEMPTION
      - BLOCKED
      - CHALLENGED
      - AUTHENTICATE
      - FORCE_AUTHENTICATE
      - OVERRIDE
      - ACCEPT WITH NO PREFERENCE
      - DENIED
      - ALLOWED
    FraudResult2:
      required:
      - result
      - review
      - score
      properties:
        result:
          $ref: '#/components/schemas/Result2'
        review:
          $ref: '#/components/schemas/Review2'
        score:
          type: integer
          example: 200
      type: object
    DebitAgreement2:
      required:
      - id
      - status
      properties:
        id:
          type: integer
        scheme_reference_data:
          type:
          - string
          - 'null'
        status:
          $ref: '#/components/schemas/Status5'
        recurring_payment_end_date:
          type:
          - string
          - 'null'
      type: object
    TechnicalInformation:
      title: Technical Information
      description: Object that contains technical parameters that are required to process the order.
      type: object
      required:
      - terminal_transaction_display
      properties:
        notify_url:
          description: "This parameter allows you to define the URL address of your notification handler (the endpoint you want to use to process these order-related notifications that will be sent by the HiPay platform).  \nIt overrides the default notification URL set in the configuration section of the HiPay back office.\n"
          type: string
          example: https://hipay.com/notify
        device_information:
          description: 'Information about the targeted POS payment terminal.

            Its attributes (`serial_number` and `manufacturer`) are **mandatory** if the protocol used is **`AppNepting`**, because they are used to join the POS payment terminal.

            '
          type: object
          properties:
            serial_number:
              description: 'Unique serial number of the POS terminal device.

                It is **mandatory** if the protocol used is **`AppNepting`**, because it is used to join the POS payment terminal.

                '
              type: string
              example: '1850320198'
            manufacturer:
              description: 'Manufacturer name of the POS payment terminal.

                It is **mandatory** if the protocol used is **`AppNepting`**, because it is used to join the POS payment terminal.

                '
              type: string
              example: PAX
        host_information:
          description: 'Network address of the POS payment terminal.

            Its attributes (`host` and `port`) are **mandatory** if the protocol used is **`ConcertV3.1` or `ConcertV3.2`**, because they are used to join the POS payment terminal.

            '
          type: object
          properties:
            host:
              type: string
              description: 'Host name or public IP address of the POS payment terminal (IP address that can be accessed directly over the internet and is assigned to your network router by your Internet Service Provider).

                It is **mandatory** if the protocol used is **`ConcertV3.1` or `ConcertV3.2`**, because they are used to join the POS payment terminal.

                '
              example: 193.251.48.153
            port:
              type: integer
              description: 'Port configured in your **network router** to forward the API call to your terminal, using its internal address (internal IP address + port)

                It is **mandatory** if the protocol used is **`ConcertV3.1` or `ConcertV3.2`**, because they are used to join the POS payment terminal.

                '
              default: 8888
              example: 8888
        terminal_transaction_display:
          description: 'Information used in case of "passive mode" (when the order must be sent to a POS payment terminal to handle the payment operation).

            The `contract_array` information is **mandatory** if the protocol used is **`ConcertV3.1` or `ConcertV3.2`**.

            '
          properties:
            contract_array:
              type: array
              description: 'Information related to the configuration of the POS payment terminal.

                The following information are **mandatory** if the protocol used is **`ConcertV3.1` or `ConcertV3.2`**.

                '
              items:
                type: object
                properties:
                  merchant_contract:
                    type: string
                    description: "Merchant contract number (or MID).  \nThis contract number may have a different value depending on payment application used and payment mode (with contact or contactless).  \nThe contract number must be provided, or the other information required to retrieve it (shop or device and payment application).\n"
                    minimum: 7
                    maximum: 7
                    example: 1234567
                  rank:
                    type: string
                    description: Terminal rank used by paymentApplication to reconcile the transaction.
                    minLength: 

# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hipay/refs/heads/main/openapi/hipay-order-api-openapi.yml