openapi: 3.0.3
info:
  title: ACI Payments API
  version: 1.0.0
  description: |-
    API for processing payments, fraud checks, transaction queries and reporting.

    All request bodies are JSON. Amounts use a dot as decimal separator and are sent as strings.
servers:
  - url: https://test.docs.aciworldwide.com
    description: Test environment
tags:
  - name: Payments
    description: Payment processing operations.
  - name: Fraud
    description: Fraud and risk analysis.
  - name: Reporting
    description: Query and reconciliation reporting.
paths:
  /v1/payments:
    post:
      summary: Create Payment
      description: Initiates a payment transaction (PA, DB, CD, CP, RV or RF).
      operationId: createPayment
      tags:
        - Payments
      security:
        - bearerAuth: []
      parameters:
        - name: entityId
          in: query
          required: true
          schema:
            type: string
            maxLength: 32
          description: The channel (or merchant, if channel dispatching is active) entity identifier authorising the request.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentRequest'
      responses:
        '200':
          description: Payment processed (or pending for asynchronous flows).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
      callbacks:
        paymentNotification:
          '{$request.body#/notificationUrl}':
            post:
              summary: Webhook notification
              requestBody:
                required: true
                content:
                  application/json:
                    schema:
                      $ref: '#/components/schemas/WebhookNotification'
              responses:
                '200':
                  description: Notification acknowledged.
  /fraud-check/v1:
    post:
      summary: Fraud Check
      description: Sends transaction data for stand-alone fraud / risk analysis.
      operationId: fraudCheck
      tags:
        - Fraud
      security:
        - bearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FraudRequest'
      responses:
        '200':
          description: Fraud analysis result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FraudResponse'
  /v1/query:
    get:
      summary: Query Transactions
      description: Query previously processed transactions (OPP query requests).
      operationId: queryTransactions
      tags:
        - Reporting
      security:
        - bearerAuth: []
      parameters:
        - name: entityId
          in: query
          required: true
          schema:
            type: string
            maxLength: 32
        - name: merchantTransactionId
          in: query
          schema:
            type: string
            maxLength: 255
            description: |-
              The merchant reference sent in the request. Normally used to identify an order in the order management system and used as end-to-end identifier for reconciliation. It cannot be used when query for a time frame using `date.from`/`date.to` parameters
              Format: AN255
        - name: limit
          in: query
          schema:
            type: integer
            description: |-
              The maximum number of transactions to be returned in query response.
              Numeric values between 100 and 500. If the value is not set explicitly, the system will use 100 as default value.
        - name: date.from
          in: query
          schema:
            type: string
            format: date
            description: |-
              The start timestamp from which transactions should be queried.
              Should be used together with the end of interval `date.to`.
              yyyy-MM-dd HH:mm:ss
        - name: date.to
          in: query
          schema:
            type: string
            format: date
            description: |-
              The end timestamp before which transactions should be queried.
              Should be used together with the start of interval `date.from`.
              yyyy-MM-dd HH:mm:ss
        - name: paymentTypes
          in: query
          schema:
            type: string
            description: |-
              Indicates payment types by which transactions should be filtered. Possible values are: CB,CD,CR,DB,CP,IV,PA,RB,RC,RF,RL,RV,AD,IN,FI,CL,CF,DR,RG,RR,TE,CT,DS,
              RS,SD,AC,MD,EA,RI,3D,SA,EN,ID,IC,DP,CG,TG,SF,IS,VD,DV,AF,GK,RD,TM,FT,
              KT,AR,AL,PL,FN,FZ,RE,RX,FO,CS,EX,SE,AU,TK,TF,ER
              Comma separated list of payment types
              paymentTypes=PA,DB
        - name: paymentMethods
          in: query
          schema:
            type: string
            description: |-
              Indicates payment methods by which transactions should be filtered. Possibile values are: DD,CT,CC,WA,VA,UA,OT,DC,ET,NT,IV,PP,OD,RM
              Comma separated list of payment methods
              paymentMethods=CC,RM
        - name: includeLinkedTransactions
          in: query
          schema:
            type: boolean
            description: Indicates whether all transactions linked with one provided in query request should be returned in a response.
        - name: shortId
          in: query
          schema:
            type: string
            maxLength: 14
            description: |-
              Indicates the shortId by which the transactions should be filtered
              Format: AN14
      responses:
        '200':
          description: Query result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaymentResponse'
  /v1/reporting:
    get:
      summary: Reporting
      description: Retrieve reconciliation / reporting data.
      operationId: getReport
      tags:
        - Reporting
      security:
        - bearerAuth: []
      parameters:
        - name: entityId
          in: query
          required: true
          schema:
            type: string
            maxLength: 32
        - name: date.from
          in: query
          required: true
          schema:
            type: string
            format: date
            description: |-
              The date from which the report data should start
              AN10
              {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
        - name: date.to
          in: query
          required: true
          schema:
            type: string
            format: date
            description: |-
              The date on which the report data should end
              AN10
              {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
        - name: sortValue
          in: query
          schema:
            type: string
            description: |-
              The value based on which Detail Level settlement report is sorted
              SettlementTxDate
        - name: sortOrder
          in: query
          schema:
            type: string
            enum:
              - ASC
              - DESC
              - asc
              - desc
            description: The order in which Detail Level settlement report output is sorted
      responses:
        '200':
          description: Reconciliation records.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ReconciliationRecord'
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer access token from Administration > Account data > Merchant / Channel Info.
  schemas:
    Forex:
      type: object
      properties:
        amount:
          type: string
          description: |-
            The amount of the request which could be used when there is a process of changing one currency into another during the transaction.
            Format: N10.N2
        currency:
          type: string
          maxLength: 3
          description: |-
            ISO 4217 alphabetic currency code which could be used when there is a process of changing one currency into another during the transaction. ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).
            Format: A3
    Card:
      type: object
      required:
        - number
        - expiryMonth
        - expiryYear
      properties:
        holder:
          type: string
          maxLength: 128
          description: |-
            Holder of the credit card account
            Format: A128
        number:
          type: string
          maxLength: 32
          description: |-
            The PAN or account number of the card.
            Format: N32
        expiryMonth:
          type: string
          maxLength: 2
          description: |-
            The expiry month of the card.
            Format: N2
        expiryYear:
          type: string
          maxLength: 4
          description: |-
            The expiry year of the card.
            Format: N4
        cvv:
          type: string
          maxLength: 4
          description: |-
            The card security code or CVV
            Format: N4
        numberType:
          type: string
          enum:
            - PAN
            - DPAN
          description: Indicates the type of card number
    ApplePay:
      type: object
      required:
        - paymentToken
        - source
      properties:
        paymentToken:
          type: string
          description: The encrypted payment token created by Apple
        cardNetwork:
          type: string
          description: |-
            The card network received from Apple Pay in [token](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment/1916095-token).paymentMethod.network.
            See [supportedNetworks](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentrequest/1916122-supportednetworks)
        cardType:
          type: string
          description: |-
            The card type received from Apple Pay in [token](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypayment/1916095-token).paymentMethod.type.
            See [ApplePayPaymentMethodType](https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentmethodtype)
        source:
          type: string
          enum:
            - web
            - app
          description: Indicates the source of Apple Pay
    GooglePay:
      type: object
      required:
        - paymentToken
        - source
      properties:
        paymentToken:
          type: string
          description: The encrypted payment token created by Google
        source:
          type: string
          enum:
            - web
            - app
          description: Indicates the source of Google Pay
    SamsungPay:
      type: object
      required:
        - paymentToken
        - source
      properties:
        paymentToken:
          type: string
          description: The encrypted payment token created by Samsung
        source:
          type: string
          enum:
            - web
            - app
          description: Indicates the source of Samsung Pay
    VirtualAccount:
      type: object
      required:
        - accountId
      properties:
        accountId:
          type: string
          maxLength: 100
          description: |-
            The identifier of the shopper's virtual account.
            Format: AN100
    BankAccount:
      type: object
      required:
        - holder
      properties:
        holder:
          type: string
          maxLength: 128
          description: |-
            Holder of the bank account
            Format: AN128
        bankName:
          type: string
          maxLength: 255
          description: |-
            The name of the bank which holds the account.
            Format: AN255
        number:
          type: string
          maxLength: 64
          description: |-
            The account number of the bank account. Either the number or the iban are required.
            Format: AN64
        iban:
          type: string
          maxLength: 31
          description: |-
            The IBAN (International Bank Account Number) associated with the bank account. Either the number or the iban are required.
            Format: AN31
        bankCode:
          type: string
          maxLength: 12
          description: |-
            The code associated with the bank account. Either the bankCode or the bic are required.
            Format: AN12
        bic:
          type: string
          maxLength: 11
          description: |-
            The BIC (Bank Identifier Code (SWIFT)) number of the bank account. Either the bankCode or the bic are required.
            Format: AN11
        country:
          type: string
          maxLength: 2
          description: |-
            The country code of the bank account ([ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)).
            Format: AN2
        mandate:
          type: object
          properties:
            id:
              type: string
              maxLength: 256
              description: |-
                The id of the mandate for direct debit.
                Format: AN256
            dateOfSignature:
              type: string
              format: date
              description: |-
                The date the direct debit mandate was signed.
                AN10
                {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
    TokenAccount:
      type: object
      required:
        - number
        - type
      properties:
        number:
          type: string
          maxLength: 19
          description: |-
            The encrypted payment token created by external provider
            Format: N19
        type:
          type: string
          description: |-
            The type of the token account. Possible values:
            -   EXTERNAL – acquirer or external provider token
            -   NETWORK – Scheme provider token
            EXTERNAL|
            NETWORK
        expiryMonth:
          type: string
          maxLength: 2
          description: |-
            The expiry month of the token
            Format: N2
        expiryYear:
          type: string
          maxLength: 4
          description: |-
            The expiry year of the token
            Format: N4
        cryptogram:
          type: string
          maxLength: 32
          description: |-
            Dynamic data generated using EMV-based cryptography to secure the transaction. Must be base64 encoded.
            Format: AN32
        dtvc:
          type: string
          maxLength: 4
          description: |-
            Dynamic token verification code (dynamic one time CVC2 generated for a token)
            Format: N4
    Customer:
      type: object
      properties:
        merchantCustomerId:
          type: string
          maxLength: 255
          description: |-
            An identifier for this customer. Typically this is the ID that identifies the shopper in the shop's system.
            Format: AN255
        givenName:
          type: string
          maxLength: 50
          description: |-
            The first name or given name of the customer. Required if you send in any other customer parameters, also required for some risk checks and payment providers. Max 50 characters
            Format: AN50
        middleName:
          type: string
          maxLength: 50
          description: |-
            The middle name of the customer. Max 50 characters
            Format: AN50
        surname:
          type: string
          maxLength: 50
          description: |-
            The last name or surname of the customer. Required if you send in any other customer parameters, also required for some risk checks and payment providers. Max 50 characters
            Format: AN50
        sex:
          type: string
          enum:
            - M
            - F
          maxLength: 1
          description: |-
            Sex of the shopper, 'M' for male or 'F' for female
            Format: A1
        birthDate:
          type: string
          format: date
          description: |-
            The birth day of the customer in the format yyyy-MM-dd, e.g. 1970-02-17
            AN10
            {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
        phone:
          type: string
          maxLength: 25
          description: |-
            The customer's phone number. Required for some risk checks.
            Format: AN25
        mobile:
          type: string
          maxLength: 25
          description: |-
            The customer's mobile number. Required for some risk checks.
            Format: AN25
        workPhone:
          type: string
          maxLength: 25
          description: |-
            The customer's phone number. Required for some risk checks.
            Format: AN25
        email:
          type: string
          format: email
          maxLength: 128
          description: |-
            The customer's email address. Required for some risk checks and transmission of direct debit mandates.
            Format: AN128
        companyName:
          type: string
          maxLength: 60
          description: |-
            The customer's company name.
            Format: AN60
        identificationDocType:
          type: string
          maxLength: 12
          description: |-
            The type of identification document for the customer. Can be one of these three values: IDCARD, PASSPORT, TAXSTATEMENT.
            If this parameter is sent then customer.identificationDocId must be also sent.
            It is also mandatory for certain payment types (e.g. Boleto).
            Format: A12
        identificationDocId:
          type: string
          maxLength: 64
          description: |-
            The identifier of the identification document for the customer.
            If this parameter is sent then customer.identificationDocType must also be sent. It is also mandatory for certain payment types (e.g. Boleto).
            Format: AN64
        ip:
          type: string
          maxLength: 255
          description: |-
            The customer's IP address.
            Format: AN255
        merchantReference:
          type: string
          maxLength: 255
          description: |-
            Defines the payer account ID or some other form of reference information which will be provided to the payee
            Format: AN255
        salutation:
          type: string
          maxLength: 3
          description: |-
            Valid options are: MR, MRS, MS, MX
            Format: A3
        language:
          type: string
          description: Defines the language of the customer. For example - NO, DE, etc.
        category:
          type: string
          maxLength: 10
          description: |-
            Defines whether payer is an individual customer or a company.
            Valid options are: INDIVIDUAL, COMPANY
            Format: A10
        browserFingerprint:
          type: object
          properties:
            id:
              type: string
              description: The reference to the fingerprint of the shopper's browser, in most cases provided by some JavaScript library.
            value:
              type: string
              description: The actual fingerprint value of the shopper's browser
        browser:
          type: object
          properties:
            acceptHeader:
              type: string
              description: |-
                Exact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder’s browser.
                Mandatory for 3D Secure v2.
            language:
              type: string
              description: |-
                Value representing the browser language as defined in IETF BCP47. Returned from navigator.language property.
                Mandatory for 3D Secure v2.
            screenHeight:
              type: string
              description: |-
                Total height of the Cardholder’s screen in pixels. Value is returned from the screen.height property.
                Mandatory for 3D Secure v2.
            screenWidth:
              type: string
              description: |-
                Total width of the cardholder’s screen in pixels. Value is returned from the screen.width property.
                Mandatory for 3D Secure v2.
            timezone:
              type: string
              description: |-
                Time-zone offset in minutes between UTC and the Cardholder browser local time. Note that the offset is positive if the local time zone is behind UTC and negative if it is ahead
                Mandatory for 3D Secure v2.
            userAgent:
              type: string
              description: |-
                Exact content of the HTTP user-agent header.
                Mandatory for 3D Secure v2.
            javaEnabled:
              type: string
              description: |-
                Boolean that represents the ability of the cardholder browser to execute Java. Value is returned from the navigator.javaEnabled property.
                Mandatory for 3D Secure v2.
                true/false
            screenColorDepth:
              type: string
              description: Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property.
            challengeWindow:
              type: string
              maxLength: 1
              description: |-
                Dimensions of the challenge window that has been displayed to the Cardholder. The ACS shall reply with content that is formatted to appropriately render in this window to provide the best possible user experience. Preconfigured sizes are width x height in pixels of the window displayed in the Cardholder browser window.
                Format: N1
            deviceId:
              type: string
              maxLength: 32
              description: |-
                Value representing the customer browser device id.
                Format: AN32
        app:
          type: object
          properties:
            deviceId:
              type: string
              maxLength: 40
              description: |-
                Value representing the customer mobile device id.
                Format: AN40
        status:
          type: string
          maxLength: 9
          description: |-
            A status of the customer. Currently two options- NEW, EXISTING.
            Format: A9
    BillingAddress:
      type: object
      properties:
        street1:
          type: string
          maxLength: 100
          description: |-
            The door number, floor, building number, building name, and/or street name of the billing address
            Mandatory for 3D Secure v2.
            Format: AN100
        street2:
          type: string
          maxLength: 100
          description: |-
            The adjoining road or locality (if required) of the billing address
            The combination of billing.street1 and billing.street2 can't contain numbers only, it should also include characters.
            Format: AN100
        houseNumber1:
          type: string
          maxLength: 100
          description: |-
            Primary house number (door number or building number) of the billing address. If present, then billing.street1 is assumed to contain only the name of the street. Also, billing.street2 will be ignored.
            Format: AN100
        houseNumber2:
          type: string
          maxLength: 100
          description: |-
            Secondary house number (floor, building name) of the billing address. Used when more addresses are bundled to a same primary house number. If present, billing.houseNumber1 is also mandatory.
            Format: AN100
        city:
          type: string
          maxLength: 80
          description: |-
            The town, district or city of the billing address
            Mandatory for 3D Secure v2.
            Format: AN80
        state:
          type: string
          maxLength: 50
          description: |-
            The county, state or region of the billing address
            Format: AN50
        postcode:
          type: string
          maxLength: 16
          description: |-
            The postal code or zip code of the billing address
            Mandatory for 3D Secure v2.
            Format: AN16
        country:
          type: string
          maxLength: 2
          description: |-
            The country of the billing address ([ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1))
            Mandatory for 3D Secure v2.
            Format: A2
        normalized:
          type: string
          maxLength: 255
          description: |-
            The normalized shipping address.
            Format: AN255
        validationStatus:
          type: string
          maxLength: 255
          description: |-
            Indicates whether a address got validated and normalized address got confirmed by the consumer
            Format: AN255
    Corporate:
      type: object
      properties:
        name:
          type: string
          maxLength: 30
          description: |-
            The name of the company
            Format: AN30
        description:
          type: string
          maxLength: 160
          description: |-
            The brief description of the company
            Format: AN160
        street:
          type: string
          maxLength: 100
          description: |-
            The company's address - street
            Format: AN100
        address:
          type: string
          maxLength: 100
          description: |-
            The company's address - line 2
            Format: AN100
        city:
          type: string
          maxLength: 80
          description: |-
            The company's address - city
            Format: AN80
        state:
          type: string
          maxLength: 50
          description: |-
            The company's address - state
            Format: AN50
        postCode:
          type: string
          maxLength: 16
          description: |-
            The company's address - postal code
            Format: AN16
        suite:
          type: string
          maxLength: 30
          description: |-
            The company's suite number
            Format: AN30
        postboxNumber:
          type: string
          maxLength: 15
          description: |-
            The company's post box number
            Format: AN15
        purchase:
          type: string
          enum:
            - Y
            - N
          maxLength: 1
          description: |-
            The company's purchase indicator
            Format: A1
        phone:
          type: string
          maxLength: 25
          description: |-
            The company's phone number
            Format: N25
        fax:
          type: string
          maxLength: 25
          description: |-
            The company's fax number
            Format: N25
        vatId:
          type: string
          maxLength: 255
          description: |-
            The company's vat id
            Format: AN255
    Sender:
      type: object
      properties:
        name:
          type: string
          maxLength: 100
          description: |-
            The name of the sender.
            Format: AN100
        givenName:
          type: string
          maxLength: 50
          description: |-
            The first name or given name of the sender.
            Format: AN50
        middleName:
          type: string
          maxLength: 50
          description: |-
            The middle name of the sender.
            Format: AN50
        surname:
          type: string
          maxLength: 50
          description: |-
            The last name or surname of the sender.
            Format: AN50
        birthDate:
          type: string
          format: date
          description: |-
            The birth day of the sender in the format yyyy-MM-dd, e.g. 1970-02-17
            AN10
            ([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1])
        accountNumber:
          type: string
          maxLength: 32
          description: |-
            The account number of the sender.
            Format: AN32
        street:
          type: string
          maxLength: 100
          description: |-
            The door number, floor, building number, building name, and street name of the sender.
            Format: AN100
        city:
          type: string
          maxLength: 50
          description: |-
            The town, district or city of the sender.
            Format: AN50
        state:
          type: string
          maxLength: 50
          description: |-
            The county, state or region of the sender.
            Format: AN50
        country:
          type: string
          description: |-
            The country of the sender.
            AN3 (ISO 3166-1 Alpha 3)
        accountNumberType:
          type: string
          description: |-
            Indicates type of sender account number.
            OTHER
            RTN_AND_BANK_ACCOUNT
            IBAN
        sourceOfFunds:
          type: string
          description: |-
            The source of funds of the sender.
            N2
            01 - Visa Credit
            02 - Visa Debit
            03 - Visa Prepaid
            04 - Cash
            05 - Debit/deposit access accounts other than those linked to a Visa card
            06 - Credit accounts other than those linked to a Visa card
        entityType:
          type: string
          maxLength: 50
          description: |-
            Entity type of the sender (e.g., Individual, Business).
            Format: AN50
        nationality:
          type: string
          maxLength: 50
          description: |-
            Nationality of the sender.
            Format: A50
        occupation:
          type: string
          maxLength: 50
          description: |-
            Occupation or profession of the sender.
            Format: AN50
        birthCountry:
          type: string
          maxLength: 3
          description: |-
            Country of birth of the sender (ISO 3166-1 Alpha-3 format if applicable).
            Format: A3
    Recipient:
      type: object
      properties:
        givenName:
          type: string
          maxLength: 48
          description: |-
            The first name or given name of the recipient.
            Format: AN48
        middleName:
          type: string
          maxLength: 48
          description: |-
            The middle name of the recipient.
            Format: AN48
        surname:
          type: string
          maxLength: 48
          description: |-
            The last name or surname of the recipient.
            Format: AN48
        birthDate:
          type: string
          format: date
          description: |-
            The birth day of the recipient in the format yyyy-MM-dd, e.g. 1970-02-17
            AN10
            ([0-9]{4})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1])
        phone:
          type: string
          maxLength: 25
          description: |-
            The phone number of the recipient.
            Format: AN25
        accountNumber:
          type: string
          maxLength: 32
          description: |-
            The account number of the recipient.
            Format: AN32
        street:
          type: string
          maxLength: 100
          description: |-
            The door number, floor, building number, building name, and street name of the recipient.
            Format: AN100
        city:
          type: string
          maxLength: 50
          description: |-
            The town, district or city of the recipient.
            Format: AN50
        state:
          type: string
          maxLength: 50
          description: |-
            The county, state or region of the recipient.
            Format: AN50
        country:
          type: string
          description: |-
            The country of the recipient.
            AN3 (ISO 3166-1 Alpha 3)
        postcode:
          type: string
          maxLength: 30
          description: |-
            The postal code or zip code of the recipient.
            Format: AN30
        accountNumberType:
          type: string
          description: |-
            Indicates type of recipient's account number.
            OTHER
            RTN_AND_BANK_ACCOUNT
            IBAN
            EMAIL
        nationality:
          type: string
          maxLength: 50
          description: |-
            Nationality of the recipient.
            Format: A50
        identificationType:
          type: string
          maxLength: 50
          description: |-
            Type of identification document for the recipient.
            Format: AN50
        identificationValue:
          type: string
          maxLength: 50
          description: |-
            Identification number or value of the recipient.
            Format: AN50
        entityType:
          type: string
          maxLength: 50
          description: |-
            Entity type of the recipient (e.g., Individual, Business).
            Format: AN50
        relationship:
          type: string
          maxLength: 50
          description: |-
            Relationship of the recipient to the sender.
            Format: AN50
        occupation:
          type: string
          maxLength: 50
          description: |-
            Occupation or profession of the recipient.
            Format: AN50
        birthCountry:
          type: string
          maxLength: 3
          description: |-
            Country of birth of the recipient (ISO 3166-1 Alpha-3 format if applicable).
            Format: A3
    Airline:
      type: object
      properties:
        totalTaxAmount:
          type: string
          description: |-
            The total amount of tax
            Format: N10.N2
        totalFeesAmount:
          type: string
          description: |-
            The total fees
            Format: N10.N2
        totalFareAmount:
          type: string
          description: |-
            The total fare
            Format: N10.N2
        ticketIssueDate:
          type: string
          format: date
          description: |-
            The date the booking/ticket was made
            AN10
            {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
        ticketIssueAddress:
          type: string
          maxLength: 255
          description: |-
            The address that issued the ticket
            Format: AN255
        thirdPartyBooking:
          type: string
          maxLength: 255
          description: |-
            Indicates if the ticket was booked via a third party
            Format: AN255
        bookingtype:
          type: string
          maxLength: 255
          description: |-
            The type of booking
            Format: AN255
        ticketDeliveryMethod:
          type: string
          maxLength: 255
          description: |-
            The delivery method of the ticket
            Format: AN255
        bookingRefNum:
          type: string
          maxLength: 255
          description: |-
            The booking reference number
            Format: AN255
        agentName:
          type: string
          maxLength: 255
          description: |-
            The agent name
            Format: AN255
        agentCode:
          type: string
          maxLength: 255
          description: |-
            The agent code
            Format: AN255
        passengers:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                maxLength: 255
                description: |-
                  The passenger type
                  Format: AN255
              name:
                type: string
                maxLength: 255
                description: |-
                  The name of the passenger
                  Format: AN255
              ticketRestricted:
                type: string
                maxLength: 255
                description: |-
                  Indicates if the passenger has a restricted ticket
                  Format: AN255
              ticketNumber:
                type: string
                maxLength: 255
                description: |-
                  The passenger's ticket number
                  Format: AN255
              status:
                type: string
                maxLength: 255
                description: |-
                  The passenger status
                  Format: AN255
              phone:
                type: string
                maxLength: 255
                description: |-
                  The passenger's phone
                  Format: AN255
              frequentFlyerNumber:
                type: string
                maxLength: 255
                description: |-
                  The passenger's frequent flyer number
                  Format: AN255
              email:
                type: string
                format: email
                maxLength: 255
                description: |-
                  The passenger's email
                  Format: AN255
              dob:
                type: string
                format: date
                description: |-
                  The passenger's date of birth
                  Format: AN255
              checkDigit:
                type: string
                maxLength: 255
                description: |-
                  The check digit for the passenger
                  Format: AN255
              residenceCountry:
                type: string
                description: |-
                  The residence country code of the passenger ([ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)).
                  A2 ISO country code
              legs:
                type: array
                items:
                  type: object
                  properties:
                    ticketNumber:
                      type: string
                      maxLength: 255
                      description: |-
                        The ticket number for the leg
                        Format: AN255
                    taxAmount:
                      type: string
                      description: |-
                        The tax amount for the leg
                        Format: N10.N2
                    stopOverAllowed:
                      type: string
                      maxLength: 255
                      description: |-
                        Indicates if a stop over is allowed
                        Format: AN255
                    restrictions:
                      type: string
                      maxLength: 255
                      description: |-
                        Indicates if there is restrictions for the leg
                        Format: AN255
                    flightNumber:
                      type: string
                      maxLength: 255
                      description: |-
                        The flight number for the leg
                        Format: AN255
                    feesAmount:
                      type: string
                      description: |-
                        The fees for the leg
                        Format: N10.N2
                    fareBasis:
                      type: string
                      maxLength: 255
                      description: |-
                        The fare basis for the leg
                        Format: AN255
                    fareAmount:
                      type: string
                      description: |-
                        The fare amount for the leg
                        Format: N10.N2
                    exchangeTicketNum:
                      type: string
                      maxLength: 255
                      description: |-
                        The exchange ticket number for the leg
                        Format: AN255
                    departureTaxAmount:
                      type: string
                      description: |-
                        The departure tax amount for the leg
                        Format: N10.N2
                    departureCountry:
                      type: string
                      maxLength: 255
                      description: |-
                        The departure country for the passenger
                        Format: AN255
                    departureAirport:
                      type: string
                      maxLength: 255
                      description: |-
                        The departure airport for the passenger
                        Format: AN255
                    airlineName:
                      type: string
                      maxLength: 255
                      description: |-
                        The name of the airline for the leg
                        Format: AN255
                    airlineCode:
                      type: string
                      maxLength: 255
                      description: |-
                        The code of the airline for the leg
                        Format: AN255
                    departureTime:
                      type: string
                      maxLength: 255
                      description: |-
                        The departure time for the leg
                        Format: AN255
                    departureDate:
                      type: string
                      format: date
                      description: |-
                        The departure date for the leg
                        AN10
                        {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
                    arrivalCountry:
                      type: string
                      maxLength: 255
                      description: |-
                        The destination country for the leg
                        Format: AN255
                    arrivalAirport:
                      type: string
                      maxLength: 255
                      description: |-
                        The destination airport for the leg
                        Format: AN255
                    arrivalTime:
                      type: string
                      maxLength: 255
                      description: |-
                        The arrival time for the leg
                        Format: AN255
                    arrivalDate:
                      type: string
                      format: date
                      description: |-
                        The arrival date for the leg
                        AN10
                        {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
                    couponNumber:
                      type: string
                      maxLength: 255
                      description: |-
                        The coupon number for the leg
                        Format: AN255
                    classOfService:
                      type: string
                      maxLength: 255
                      description: |-
                        The class of service for the leg
                        Format: AN255
                    carrierCode:
                      type: string
                      maxLength: 255
                      description: |-
                        The carrier code for the leg
                        Format: AN255
                    timeToDeparture:
                      type: string
                      maxLength: 10
                      description: |-
                        The airline time to departure, in days, for the leg
                        Format: AN10
    RecurringMigration:
      type: object
      required:
        - paymentType
      properties:
        paymentType:
          type: string
          maxLength: 2
          description: |-
            Indicates the payment type of the INITIAL request(DB|CD|PA).
            Format: A2
        amount:
          type: string
          description: |-
            Indicates the INITIAL payment amount.
            Format: N8.N2
        requestTimestamp:
          type: string
          format: date-time
          description: |-
            Indicates the timestamp of the INITIAL payment request (e.g. 2018-11-27 10:42:39+0000).
            AN19
            (19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1] 0[0-2]1[0-9]:0[0-5]1[0-9]:0[0-5]1[0-9]
        connectorTxId1:
          type: string
          maxLength: 128
          description: |-
            Indicates INITIAL payment response details as received from the acquirer.
            Format: AN128
        connectorTxId2:
          type: string
          maxLength: 128
          description: |-
            Indicates INITIAL payment response details as received from the acquirer.
            Format: AN128
        connectorTxId3:
          type: string
          maxLength: 128
          description: |-
            Indicates INITIAL payment response details as received from the acquirer.
            Format: AN128
    GiftCard:
      type: object
      properties:
        number:
          type: string
          maxLength: 255
          description: |-
            The gift card number.
            Format: AN255
        pin:
          type: string
          maxLength: 255
          description: |-
            The gift card pin number.
            Format: AN255
        holder:
          type: string
          maxLength: 255
          description: |-
            The holder of the gift card.
            Format: AN255
        message:
          type: string
          maxLength: 160
          description: |-
            Message that should be written on the gift card.
            Format: AN160
        type:
          type: string
          maxLength: 16
          description: |-
            Type of the Gift Card. One of the options: ANNIVERSARY, BIRTHDAY, CONGRATULATIONS, APRIL_FOOLS_DAY, EASTER, FATHERS_DAY, GRADUATION, HOLIDAY, SEASONS_GREETINGS, PASSOVER, KWANZAA, HALLOWEEN, MOTHERS_DAY, NEW_YEARS_DAY, BOSSES_DAY, ST_PATRICKS_DAY, SWEETEST_DAY, CHRISTMAS, BABY_SHOWER, THANKSGIVING, OTHER, VALENTINES_DAY, WEDDING, SECRETARYS_DAY, CHINESE_NEW_YEAR, HANUKKAH, CELEBRATE_FALL, GRANDPARENTS_DAY, INDEPENDENCE_DAY
            Format: AN16
    POS:
      type: object
      required:
        - entryMode
        - terminalId
      properties:
        deviceId:
          type: string
          maxLength: 32
          description: |-
            Serial number of the terminal.
            Format: N32
        deviceType:
          type: string
          maxLength: 32
          description: |-
            Terminal type.
            Possible values: MIURA_SHUTTLE, MIURA_M007, MIURA_M010, VERIFONE_E105, VERIFONE_E315, VERIFONE_E335
            Format: AN32
        encryptedPin:
          type: object
          properties:
            data:
              type: string
              maxLength: 2048
              description: |-
                Encrypted online PIN data.
                Format: AN2048
            ksn:
              type: string
              maxLength: 2048
              description: |-
                Key serial number to decrypt online PIN.
                Format: AN2048
        encryptedSred:
          type: object
          properties:
            data:
              type: string
              maxLength: 2048
              description: |-
                Encrypted account data (PAN/TRACK2/EXPIRY).
                SRED stands for "Secure Reading and Exchange of Data".
                Format: AN2048
            ksn:
              type: string
              maxLength: 2048
              description: |-
                Key serial number to decrypt account data.
                Format: AN2048
        entryMode:
          type: string
          maxLength: 32
          description: |-
            What interface was used by the terminal for the transaction.
            Possible values: MANUAL, MAGSTRIPE, MAGSTRIPE_AS_FALLBACK, ICC, NFC_ICC, NFC_MAGSTRIPE.
            Format: AN32
        iccDataRequest:
          type: string
          maxLength: 2048
          description: |-
            Additional data returned by the card, including ARQC.
            Format: AN2048
        location:
          type: object
          properties:
            accuracy:
              type: string
              maxLength: 32
              description: |-
                GPS accuracy.
                Format: N32
            latitude:
              type: string
              maxLength: 12
              description: |-
                Latitude by GPS.
                Format: N12
            longitude:
              type: string
              maxLength: 13
              description: |-
                Longitude by GPS.
                Format: N13
        panSequenceNumber:
          type: string
          maxLength: 32
          description: |-
            Sequence number of the card, in case multiple were issued with the same PAN.
            Format: N32
        pinEntryCapability:
          type: string
          maxLength: 32
          description: |-
            Indicates if the terminal is currently able to handle PIN.
            Possible values: PIN_ENTRY_AVAILABLE, PIN_ENTRY_UNAVAILABLE.
            Format: AN32
        terminalId:
          type: string
          maxLength: 32
          description: |-
            Id assigned by the acquirer.
            Format: N32
        transactionSequenceNumber:
          type: string
          maxLength: 32
          description: |-
            Sequence number of the transaction, incremented after each transaction by the terminal.
            Format: N32
        transactionSource:
          type: string
          description: |-
            Indicator that this is a POS transaction.
            Currently should be always POS.
            A3
            POS
        clearing:
          type: object
          properties:
            authorizationAcquirerCode:
              type: string
              maxLength: 2048
              description: |-
                Code assigned by the acquirer. Used to print receipts.
                Format: AN2048
            authorizationIssuerCode:
              type: string
              maxLength: 2048
              description: |-
                Code assigned by the issuer. Used to print receipts.
                Format: AN2048
            identifier:
              type: string
              maxLength: 2048
              description: |-
                Transaction identifier assigned by the acquirer.
                Format: AN2048
        merchantId:
          type: string
          maxLength: 2048
          description: |-
            Merchant identifier assigned by the acquirer.
            Format: AN2048
        iccDataResponse:
          type: string
          maxLength: 2048
          description: |-
            Data returned by the issuer that has to be returned to the card, including ARPC.
            Format: AN2048
        statusText:
          type: string
          maxLength: 2048
          description: |-
            Text that has to be additionally printed on the receipt (instead of approved/declined).
            Format: AN2048
        timestamp:
          type: string
          format: date-time
          description: |-
            Timestamp of the transaction with the acquirer.
            date
            yyyy-MM-dd hh:mm:ss
    Scheduling:
      type: object
      properties:
        name:
          type: string
          maxLength: 64
          description: |-
            The name of the job to be scheduled. Used for identification purposes only.
            Format: AN64
        year:
          type: string
          description: |-
            The specific year to execute
            AN64
            empty, 1970-2099
            , - * /
            The default value is *
        month:
          type: string
          description: |-
            The specific month to execute (Jan - Dec)
            AN64
            1-12
            , - * /
            The default value is 1
        dayOfMonth:
          type: string
          description: |-
            The specific day in the month to execute
            AN64
            1-31
            , - * ? / L W
            The default value is 1
        dayOfWeek:
          type: string
          description: |-
            The specific day in the week to execute
            AN64
            1-7
            SUN-SAT
            , - * ? / L #
            The default value is 1
        hour:
          type: string
          description: |-
            The specific hour to execute
            AN64
            0-23
            , - * /
            The default value is 0
        minute:
          type: string
          description: |-
            The specific minute to execute
            AN64
            0-59
            The default value is 0
        second:
          type: string
          description: |-
            The specific second to execute
            AN64
            0-59
            , - * /
            The default value is 0
        startDate:
          type: string
          format: date
          description: |-
            The date/time the job should be executed
            AN19
            yyyy-MM-dd HH:mm:ss
        endDate:
          type: string
          format: date
          description: |-
            The date/time the job should be ended
            AN19
            yyyy-MM-dd HH:mm:ss
        noticeUnit:
          type: string
          enum:
            - YEAR
            - MONTH
            - WEEK
            - DAY
            - HOUR
            - MINUTE
            - SECOND
          description: The unit of the cancellation notice period
        noticeNumber:
          type: integer
          description: |-
            The time in advance required by the cancellation notice to be given to avoid a prolongation of the job period
            Format: N16
        noticeCallable:
          type: string
          description: The reference point for the cancellation notice
        durationUnit:
          type: string
          enum:
            - YEAR
            - MONTH
            - WEEK
            - DAY
            - HOUR
            - MINUTE
            - SECOND
          description: The unit of the job period duration
        durationNumber:
          type: integer
          description: |-
            The duration of the job period
            Format: N16
        expression:
          type: string
          maxLength: 256
          description: |-
            The Cron-Expression representing how often the job will execute. A Cron-Expression is a string comprised of 7 fields, while the job.year can be left out. It will overwrite second, minute, hour, dayOfMonth, month, dayOfWeek and year in this order.
            Format: AN256
    StandingInstruction:
      type: object
      properties:
        type:
          type: string
          description: |-
            The category of the transaction.
            -   **RECURRING**: Recurring Transactions are transactions that are processed on a regular fixed interval for a pre-agreed or advised amount, where applicable. Recurring Transactions don't have a fixed duration and will continue to be processed until the cardholder cancels the agreement.
            -   **INSTALLMENT**: Installment Payments are transactions that are processed on a regular fixed interval for a pre-agreed amount for a single purchase of good or services. Unlike Recurring Transactions, Installment Payments do have a fixed duration and shouldn't continue to be processed after the end of the agreed installment period.
            -   **UNSCHEDULED**: An unscheduled credential-on-file transaction is like a recurring transaction but differs in that it does not happen at pre-agreed intervals. The classic example of such a transaction is when it is triggered by an event such as an amount threshold to ensure that a pay-as-you-go account always has a minimum available reserve.
            UNSCHEDULED|
            INSTALLMENT|
            RECURRING
        recurringType:
          type: string
          description: |-
            Indicates the type of a recurring MIT agreement.
            -   **STANDING_ORDER**: value has to be provided in case the consumer agrees to store the credential-on-file and initiates the first transaction in a series intended to be for a variable amount and a fixed frequency. Example: The initial transaction to store the credential-on-file for a monthly utility payment.
            -   **SUBSCRIPTION**: value has to be provided in case the consumer agrees to store the credential-on-file and initiates the first transaction in a series intended to be for a fixed amount and a fixed frequency. Example: The initial transaction to store the credential-on-file for a monthly newspaper subscription.
            Note - This value is conditional, it is required for:
            -   All Mastercard CIT and MIT
            -   Visa Recurring transactions executed with cards issued in India
            STANDING_ORDER|
            SUBSCRIPTION
        mode:
          type: string
          description: |-
            Indicating the mode of subsequent payment transaction.
            -   **INITIAL**: The payment is the first of a series of payments. This first payment must contain additional data like the CVV code or 3D parameters to enable an initial authentication of the request.
            -   **REPEATED**: The payment is a subsequent payment. It may not contain shopper authentication data like the CVV code or 3D parameters - the shopper is not present anymore.
            INITIAL|
            REPEATED
        source:
          type: string
          description: |-
            Indicating the type of subsequent payment transaction.
            -   **CIT**: Cardholder initiated transaction.
            -   **MIT**: Merchant initiated transaction.
            CIT|
            MIT
        initialTransactionId:
          type: string
          description: |-
            The field represents the reference ID generated by the scheme (in some integrations, the processor provides its own internal ID instead of the scheme value) for the transaction, and is returned by the processor/acquirer as part of the CIT transaction response.
            The ID is received in one of below OPP response fields, depending on the integration (refer to respective Connector Integration sheet):
            -   'standingInstruction.initialTransactionId'
            -   'resultDetails.CardholderInitiatedTransactionID'
            The field is required in the MIT transactions, when the card isn't tokenized by our platform.
            AN or N
            (No specific format-
            Depends on acquirer)
        industryPractice:
          type: string
          description: |-
            The MIT types defined under this category are performed to fulfill a business practice as a follow-up to an original cardholder-merchant interaction that could not be completed with one single transaction.
            -   **INCREMENTAL_AUTH**: Incremental authorizations can be used to increase the total amount authorized. Incremental authorizations do not replace the original authorization — they are additional to previously authorized amounts — the sum of all linked estimated and incremental authorizations represent the total amount on hold in the cardholder’s account for a given transaction.
            -   **RESUBMISSION**: When a merchant attempts to authorize a transaction after the service has been used but the issuer declines it for insufficient funds, they may attempt to re-authorize to recover the debt. These authorization requests are considered resubmission authorizations and must carry the new “re submission” indicator.
            -   **REAUTHORIZATION**: Re-authorization occurs when a merchant has a need to submit an authorization request after the cardholder has left the point of interaction and there is no possibility of re-authenticating the card or the cardholder. A merchant may need to do this if they intend to split the shipment into multiple deliveries and will only authorize as goods come into stock. If the need to re-authorize occurs, the subsequent authorization requests carry the new “re-authorization” marker and the scheme reference data from the initial interaction.
            -   **DELAYED_CHARGES and NO_SHOW**: Such transactions occur largely in the rental and hospitality sectors. These transactions also carry the scheme reference data provided in the initial authorization at the start of the rental or stay agreement as well as in the settlement record.
        expiry:
          type: string
          description: |-
            Date after which no further authorizations will be performed. Used for authentication request during EMV 3D.
            -   **For MasterCard -** : If the parameter is not sent by the customer, the platform adds a default value of 9999-12-31 within the authentication request.
            -   **For other brands -**: if the parameter is not sent by the customer, the platform sends an authentication request with indicator "payment" (not "recurring").
            Note: This parameter is conditional (mandatory when processing 3D Secure on recurring or installment transactions).
            yyyy-mm-dd
        frequency:
          type: string
          maxLength: 4
          description: |-
            Indicates the minimum number of days between authorizations.
            -   **For MasterCard -** : If the parameter is not sent by the customer, the platform adds a default value of 0001 within the authentication request.
            -   **For other brands -**: if the parameter is not sent by the customer, the platform sends an authentication request with indicator "payment" (not "recurring").
            Note: This parameter is conditional (mandatory when processing 3D Secure on recurring or installment transactions).
            Format: N4
        numberOfInstallments:
          type: integer
          description: |-
            Indicates the maximum number of authorizations permitted for installment payments. Required if the Merchant and Cardholder have agreed to installment payments, and EMV 3D authentication is configured i.e. if standingInstruction.type=INSTALLMENT. Omitted if not an instalment payment authentication. Note: This parameter is conditional (mandatory when processing 3D Secure on installment transactions).
            Format: N3
        agreementId:
          type: string
          maxLength: 35
          description: |-
            Used for Mastercard transactions to transmit the Economically Related Transaction ID (TLID), which identifies and links transactions associated with the same standing instruction agreement (for example, Merchant Initiated Transactions and refunds). During a transitional period, both standingInstruction.initialTransactionId and standingInstruction.agreementId will be returned by Mastercard and are expected to be provided in MIT requests. After the transition period, only standingInstruction.agreementId will be returned in responses and expected in requests.
            Format: AN35
    MarketPlace:
      type: object
      properties:
        sellers:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                maxLength: 255
                description: |-
                  The unique identifier of the seller.
                  Format: AN255
              amount:
                type: string
                maxLength: 13
                description: |-
                  The total amount of the items under the seller.
                  Format: N13
    ThreeDSecure:
      type: object
      properties:
        amount:
          type: string
          description: |-
            Amount for which the shopper will be authenticated for
            Format: N9.N2
        currency:
          type: string
          description: |-
            Currency for which the shopper will be authenticated for
            A3
            ISO 4217 currency code
        deviceInfo:
          type: string
          description: |-
            (Encrypted) device information. Required when initializing the 3D Secure version 2's app-based flow. The value is obtained from the mobile SDK `authRequestParams`. See [3DS SDK Standalone](/tutorials/mobile-sdk/emv-3ds/standalone) for more information.
            (as returned by `authRequestParams`)
        merchant:
          type: object
          properties:
            name:
              type: string
              maxLength: 100
              description: |-
                Merchant name as defined by the Scheme Directory Server.
                Format: AN100
            url:
              type: string
              maxLength: 2048
              description: |-
                Merchant URL
                Format: AN2048
            country:
              type: string
              maxLength: 3
              description: |-
                Merchant country
                Format: AN3
        v2:
          type: object
          properties:
            visa:
              type: object
              properties:
                requestorId:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor ID for 3D Secure v2, assigned by Visa.
                    Format: AN100
                requestorName:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor Name for 3D Secure v2, assigned by Visa.
                    Format: AN100
            mastercard:
              type: object
              properties:
                requestorId:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor ID for 3D Secure v2, assigned by Mastercard.
                    Format: AN100
                requestorName:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor Name for 3D Secure v2, assigned by Mastercard.
                    Format: AN100
            amex:
              type: object
              properties:
                requestorId:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor ID for 3D Secure v2, assigned by American Express.
                    Format: AN100
                requestorName:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor Name for 3D Secure v2, assigned by American Express.
                    Format: AN100
            diners:
              type: object
              properties:
                requestorId:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor ID for 3D Secure v2, assigned by Diners/Discover.
                    Format: AN100
                requestorName:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor Name for 3D Secure v2, assigned by Diners/Discover.
                    Format: AN100
            jcb:
              type: object
              properties:
                requestorId:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor ID for 3D Secure v2, assigned by JCB.
                    Format: AN100
                requestorName:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor Name for 3D Secure v2, assigned by JCB.
                    Format: AN100
            cartebancaire:
              type: object
              properties:
                requestorId:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor ID for 3D Secure v2, assigned by Carte Bancaire.
                    Format: AN100
                requestorName:
                  type: string
                  maxLength: 100
                  description: |-
                    Requestor Name for 3D Secure v2, assigned by Carte Bancaire.
                    Format: AN100
        channel:
          type: string
          maxLength: 2
          description: |-
            The authentication channel indicator. Only provide to indicate 3RI request(Merchant initiated authentication), which is available as a feature in 3DS 2.2 for MasterCard only.
            Format: N2
        npa:
          type: string
          description: |-
            Used to flag the 3DS transaction as non-payment authentication. To learn more about non-payment authentication, click [here](/tutorials/threeDSecure/NPA)
            true/false
        decoupled:
          type: string
          description: |-
            Used to flag the 3DS transaction as decoupled authentication. To learn more about decoupled authentication, click [here](/tutorials/threeDSecure)
            true/false
        threeRIInd:
          type: string
          description: Used to flag the 3DS transaction as 3RI authentication. This field flags the type of 3RI transaction to be used. To learn more about 3RI authentication, click [here](/tutorials/threeDSecure/threeRI)
        authenticationInd:
          type: string
          description: |-
            Provides additional information to the ACS to determine the best approach for handling an authentication request.
            PAYMENT, RECURRING, INSTALLMENT, ADD_CARD, MAINTAIN_CARD, EMV_ID, BILLING_AGREEMENT, SPLIT_SHIPMENT, _DELAYED_SHIPMENT, SPLIT_PAYMENT
        disable:
          type: string
          description: |-
            If sent as **true**, 3D Secure will be bypassed for the transaction, even if it's fully configured and activated. Important: sending **false** when 3D Secure is not configured and activated in the platform will **not** enable it for this transaction.
            true/false
        eci:
          type: string
          maxLength: 2
          description: |-
            The ECI for the 3D Secure request.
            Example: threeDSecure.eci=01
            Format: N2
        verificationId:
          type: string
          maxLength: 28
          description: |-
            The 3D Secure CAVV or AAV.
            Format: AN28
        authenticationStatus:
          type: string
          maxLength: 1
          description: |-
            The authentication status for the 3D Secure request.
            Format: AN1
        dsTransactionId:
          type: string
          maxLength: 100
          description: |-
            Transaction ID assigned by the directory server.
            Format: AN100
        acsTransactionId:
          type: string
          maxLength: 100
          description: |-
            This field contains a universally unique transaction identifier assigned by the ACS to identify a single transaction.
            Format: AN100
        challengeMandatedIndicator:
          type: string
          description: |-
            Indication of whether a challenge is required for the transaction to be authorized due to local/regional mandates or other variable.
            AN1
            (Y|N)
        version:
          type: string
          description: 'Version of the 3D Secure that was used. For example: 2.1.0 or 2.2.0'
        authType:
          type: string
          maxLength: 2
          description: |-
            The type of authentication that was requested by the ACS.
            Format: AN2
        transactionStatusReason:
          type: string
          maxLength: 2
          description: |-
            Provides information on why the Transaction Status field has the specified value.
            Format: N2
        challengeIndicator:
          type: string
          description: Indicates whether a challenge is requested for this transaction. Can be sent when 3D Secure version 2.2 or higher is used.
        exemptionFlag:
          type: string
          maxLength: 2
          description: |-
            Flags the transaction as exemption during authorization. Can be sent when 3D Secure version 2.2 or higher is used.
            Format: N2
        schemeData:
          type: object
          properties:
            CB-ITEMSNB:
              type: string
              maxLength: 2
              description: |-
                This field represents the number of items or services purchased.
                This field is required to process 3DS transactions for Carte Bancaire scheme and can be used for 3D Secure v2.
                Format: N2
            CB-SCORE_MERCHANT:
              type: string
              description: |-
                This is the merchant score, it is calculated by the 3DS requestor and provided to card scheme scoring service only.
                This field is required to process 3DS transactions for Carte Bancaire scheme and can be used for 3D Secure v2.
            CB-USECASE:
              type: string
              maxLength: 2
              description: |-
                This is payment authentication use case. It indicates the type of payment for which an authentication is requested.
                This field is required to process 3DS transactions for Carte Bancaire scheme and can be used for 3D Secure v2.
                Format: N2
    ShippingAddress:
      type: object
      properties:
        street1:
          type: string
          maxLength: 100
          description: |-
            The door number, floor, building number, building name, and/or street name of the shipping address
            Format: AN100
        street2:
          type: string
          maxLength: 100
          description: |-
            The adjoining road or locality (if required) of the shipping address
            Format: AN100
        houseNumber1:
          type: string
          maxLength: 100
          description: |-
            Primary house number (door number or building number) of the shipping address. If present, then shipping.street1 is assumed to contain only the name of the street. Also, shipping.street2 will be ignored.
            Format: AN100
        houseNumber2:
          type: string
          maxLength: 100
          description: |-
            Secondary house number of the shipping address (floor, building name). Used when more addresses are bundled to a same primary house number. If present, shipping.houseNumber1 is also mandatory.
            Format: AN100
        city:
          type: string
          maxLength: 80
          description: |-
            The town, district or city of the shipping address
            Format: AN80
        state:
          type: string
          maxLength: 50
          description: |-
            The county, state or region of the shipping address
            Format: AN50
        postcode:
          type: string
          maxLength: 16
          description: |-
            The postal code or zip code of the shipping address
            Format: AN16
        country:
          type: string
          maxLength: 2
          description: |-
            The country of the shipping address ([ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1))
            Format: A2
        method:
          type: string
          maxLength: 30
          description: |-
            Method of the shipping. One of the options: CARRIER_DESIGNATED_BY_CUSTOMER, ELECTRONIC_DELIVERY, EXPEDITED, GROUND, INTERNATIONAL, LOWEST_COST, MILITARY, NEXT_DAY_OVERNIGHT, OTHER, POINT_PICKUP, PUDO, SAME_DAY_SERVICE, STORE_PICKUP, THREE_DAY_SERVICE, TWO_DAY_SERVICE
            Format: AN30
        cost:
          type: string
          maxLength: 13
          description: |-
            The total amount of the shipping costs.
            Format: N13
        comment:
          type: string
          maxLength: 160
          description: |-
            A comment for the shipping
            Format: AN160
        expectedDate:
          type: string
          format: date
          description: |-
            The expected delivery date
            AN10
            {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
        logisticsProvider:
          type: string
          maxLength: 255
          description: |-
            The logistics provider of the shipping
            Format: AN255
        trackingNumber:
          type: string
          maxLength: 255
          description: |-
            The tracking number of the shipping
            Format: AN255
        returnTrackingNumber:
          type: string
          maxLength: 255
          description: |-
            The tracking number issued for returns
            Format: AN255
        normalized:
          type: string
          maxLength: 255
          description: |-
            The normalized shipping address.
            Format: AN255
        validationStatus:
          type: string
          maxLength: 255
          description: |-
            Indicates whether a address got validated and normalized address got confirmed by the consumer
            Format: AN255
        warehouse:
          type: string
          maxLength: 100
          description: |-
            The warehouse that fulfilled the order
            Format: AN100
        preference:
          type: string
          description: |-
            Indicates the shipping preference. Possible values:
            -   **GET_FROM_FILE** - use the shipping address provided by customer at acquirer hosted pages.
            -   **NO_SHIPPING** - no shipping is expected for the purchase. Preferred option for digital goods.
            -   **SET_PROVIDED_ADDRESS** - use the merchant-provided address. The customer can't change this address on the acquirer hosted pages.
            Default value: **GET_FROM_FILE**
            AN21
            GET_FROM_FILE|NO_SHIPPING|SET_PROVIDED_ADDRESS
        middleName:
          type: string
          description: The middle name for the shipping address
        companyName:
          type: string
          maxLength: 60
          description: |-
            The company name for the shipping address
            Format: AN60
        phone:
          type: string
          maxLength: 25
          description: |-
            The phone number for shipping address
            Format: AN25
        workPhone:
          type: string
          maxLength: 25
          description: |-
            The work phone number for shipping address
            Format: AN25
        mobile:
          type: string
          maxLength: 25
          description: |-
            The mobile number for shipping address
            Format: AN25
        email:
          type: string
          format: email
          maxLength: 128
          description: |-
            The email address for shipping address
            Format: AN128
        type:
          type: string
          maxLength: 8
          description: |-
            Defines type of shipping if return or shipment.
            Valid options are: RETURN, SHIPMENT
            Format: AN8
        customer:
          $ref: '#/components/schemas/Customer'
    Cart:
      type: object
      properties:
        items:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                maxLength: 255
                description: |-
                  The name of the item in the shopping cart.
                  Example: cart.items[0].name=First Cart Item
                  Format: AN255
              merchantItemId:
                type: string
                maxLength: 255
                description: |-
                  The unique identifier of the item in the shopping cart.
                  Format: AN255
              quantity:
                type: string
                maxLength: 5
                description: |-
                  The number of items in the shopping cart.
                  Format: N5
              type:
                type: string
                maxLength: 255
                description: |-
                  The type of the purchased item in the shopping cart. Values can be: PHYSICAL, DIGITAL, MIXED, ANONYMOUS_DONATION, AUTHORITIES_PAYMENT
                  Format: AN255
              sku:
                type: string
                maxLength: 255
                description: |-
                  The sku cart item.
                  Format: AN255
              currency:
                type: string
                description: |-
                  The currency of the price of the shopping cart.
                  A3
                  [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code
              description:
                type: string
                maxLength: 2048
                description: |-
                  The description of the item in the shopping cart.
                  Format: AN2048
              commodityCode:
                type: string
                description: |-
                  L3 Card data, product commodity code.
                  N8
                  See list https://www.unspsc.org/
              commodityDescription:
                type: string
                description: |-
                  L3 Card data, product commodity description.
                  AN50
                  See list https://www.unspsc.org/
              originalPrice:
                type: string
                maxLength: 255
                description: |-
                  The price of the item in the shopping cart. (excluding tax and discount). The item's price is independent of the quantity..
                  Format: AN255
              price:
                type: string
                maxLength: 13
                description: |-
                  The price of the item in the shopping cart. (including tax and discount). The item's price is independent of the quantity.
                  Format: N13
              totalAmount:
                type: string
                maxLength: 13
                description: |-
                  The total amount of the cart item including quantity.
                  Format: N13
              taxAmount:
                type: string
                maxLength: 13
                description: |-
                  The tax amount of the cart item. The item's tax amount is independent of the quantity.
                  Format: N13
              totalTaxAmount:
                type: string
                maxLength: 13
                description: |-
                  The total tax amount of the cart item.
                  Format: N13
              tax:
                type: string
                maxLength: 6
                description: |-
                  The tax percentage applied to the price of the item in the shopping cart.
                  Format: AN6
              taxCategory:
                type: string
                description: |-
                  Mandatory L3 Card data tax category.
                  AN2
                  Values: AA, S, E or Z
              shipping:
                type: string
                description: |-
                  The shipping amount applied to the item in the shopping cart.
                  Format: N10.N2
              discount:
                type: string
                maxLength: 13
                description: |-
                  The discount percentage applied to the price of the item in the shopping cart.
                  Format: N13
              giftMessage:
                type: string
                maxLength: 255
                description: |-
                  Gift Message for the specific cart item
                  Format: AN255
              shippingMethod:
                type: string
                maxLength: 255
                description: |-
                  Shipping method for the cart item.
                  Format: AN255
              shippingInstructions:
                type: string
                maxLength: 255
                description: |-
                  Shipping instructions for the cart item.
                  Format: AN255
              shippingTrackingNumber:
                type: string
                maxLength: 255
                description: |-
                  Shipping tracking number for the cart item
                  Format: AN255
              quantityUnit:
                type: string
                description: |-
                  The cart item's unit of quanity.
                  M, CM, KG, G, COUNT (default)
              productUrl:
                type: string
                description: |-
                  The cart item's URL.
                  Valid URL
              imageUrl:
                type: string
                description: |-
                  The cart item's image URL.
                  Valid URL
              totalDiscountAmount:
                type: string
                description: The cart item's total discount amount. The total discount amount is related to the discount percentage
              productCode:
                type: string
                maxLength: 30
                description: |-
                  The cart item's product code given by merchant for identification
                  Format: AN30
              partNumber:
                type: string
                maxLength: 30
                description: |-
                  The cart item's manufacturer provided part number.
                  Format: AN30
              itemNumber:
                type: string
                maxLength: 3
                description: |-
                  The cart item's line number of this item on the invoice
                  Format: N3
              vatReferenceNumber:
                type: string
                maxLength: 30
                description: |-
                  The cart item's reference number used to identify the VAT invoice or tax receipt
                  Format: AN30
              sellerId:
                type: string
                maxLength: 255
                description: |-
                  The unique identifier of the marketplace seller to which this cart item belongs
                  Format: AN255
              recipient:
                type: object
                properties:
                  salutation:
                    type: string
                    maxLength: 5
                    description: |-
                      The cart item's recipient title
                      Format: AN5
                  firstName:
                    type: string
                    maxLength: 48
                    description: |-
                      The cart item's recipient first name
                      Format: AN48
                  middleName:
                    type: string
                    maxLength: 50
                    description: |-
                      The cart item's recipient middle name
                      Format: AN50
                  lastName:
                    type: string
                    maxLength: 48
                    description: |-
                      The cart item's recipient last name
                      Format: AN48
                  apartment:
                    type: string
                    maxLength: 100
                    description: |-
                      The cart item's recipient apartment number
                      Format: AN100
                  street:
                    type: string
                    maxLength: 100
                    description: |-
                      The cart item's recipient address line 1
                      Format: AN100
                  address:
                    type: string
                    maxLength: 100
                    description: |-
                      The cart item's recipient address line 2
                      Format: AN100
                  city:
                    type: string
                    maxLength: 80
                    description: |-
                      The cart item's recipient city
                      Format: AN80
                  state:
                    type: string
                    maxLength: 50
                    description: |-
                      The cart item's recipient state
                      Format: AN50
                  postcode:
                    type: string
                    maxLength: 16
                    description: |-
                      The cart item's recipient postal code
                      Format: AN16
                  country:
                    type: string
                    description: The cart item's recipient country code
                  phone:
                    type: string
                    maxLength: 25
                    description: |-
                      The cart item's recipient phone number
                      Format: N25
                  email:
                    type: string
                    format: email
                    maxLength: 128
                    description: |-
                      The cart item's recipient email address
                      Format: AN128
              deliveryDate:
                type: string
                format: date
                description: |-
                  The cart item's delivery date
                  AN10
                  {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
        payments:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                maxLength: 255
                description: |-
                  The name of the payment methtod.
                  Example: cart.payments[0].name=promotion giftcard 50
                  Format: AN255
              type:
                type: string
                maxLength: 255
                description: |-
                  The type of the used payment. One of the options: GIFTCARD, PROMOTION
                  Example: cart.payments[0].type=GIFTCARD
                  Format: AN255
              amount:
                type: string
                description: |-
                  The amount of the associated and already used payment method.
                  Example: cart.payments[0].amount=10.90
                  Format: N10.N2
              currency:
                type: string
                maxLength: 3
                description: |-
                  The currency of the already used payment amount.
                  Example: cart.payments[0].currency=EUR
                  Format: A3
              status:
                type: string
                maxLength: 255
                description: |-
                  The status of the already used payment method. One of the options: pending, authorized, captured
                  Example: cart.payments[0].status=captured
                  Format: AN255
              brand:
                type: string
                maxLength: 255
                description: |-
                  The brand of the already used payment method, eg. SVS
                  Example: cart.payments[0].name=SVS
                  Format: AN255
              primary:
                type: boolean
                description: |-
                  Identifies this payment method being the primary payment method used for that cart. One of the options: true, false
                  Example: cart.payments[0].primary=false
    Risk:
      type: object
      properties:
        channelId:
          type: string
          maxLength: 255
          description: |-
            Id of the channel in the risk system. This field is usually set up as a configuration, but in some situations you might want to use the dynamic request based option described here.
            For the ReD Shield this will cause a different set of rules to be executed. There the length is limited to AN12.
            Format: AN255
        serviceId:
          type: string
          maxLength: 255
          description: |-
            Id of the service in the risk system. This field is usually set up as a configuration, but in some situations you might want to use the dynamic request based option described here.
            For the ReD Shield this defines which fraud screening service to use. There the length is limited to AN1.
            Format: AN255
        amount:
          type: string
          description: |-
            Amount for the risk request. The dot is used as decimal separator.
            Currently this parameter is used for both ReD Shield and 3D Secure. When performing the 3D Secure, if this parameter is present, its value will be used as the amount for the 3D Secure.
            Format: N10.N2
        orderTimestamp:
          type: string
          format: date-time
          description: |-
            Timestamp of the order for the risk request. Format: yyyy-MM-dd hh:mm:ss (24h clock), e.g. 2015-12-17 22:00:04
            By default our payment system sets a timestamp automatically. Use this field when the (payment) transaction was executed at a different time than sending the risk request at hand.
            AN19
            {(19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1] 0[0-2]1[0-9]:0[0-5]1[0-9]:0[0-5]1[0-9] }
        brand:
          type: string
          maxLength: 255
          description: |-
            Brand of the payment that is being checked. By default you can use the field paymentBrand instead of this one. However, if the payment isn't executed through the OPP you might have a different brand-format you can specify here.
            Format: AN255
        parameters:
          type: object
          description: |-
            A name value pair used for sending custom information related to the risk request.
            name: AN64
            [a-zA-Z0-9\._]{3,64}
            value: AN2048
          additionalProperties:
            type: string
        merchantWebsite:
          type: string
          maxLength: 60
          description: |-
            Merchant's website URL
            Format: AN60
        accountToken:
          type: string
          maxLength: 64
          description: |-
            A merchant-set token for the account
            Format: AN64
    MerchantBillingAddress:
      allOf:
        - $ref: '#/components/schemas/BillingAddress'
        - type: object
          properties:
            givenName:
              type: string
              description: The first name or given name of the merchant/acceptor
            surname:
              type: string
              description: The last name or surname of the merchant/acceptor
            middleName:
              type: string
              description: The middle name of the merchant/acceptor
            companyName:
              type: string
              maxLength: 60
              description: |-
                The merchant's company name
                Format: AN60
            phone:
              type: string
              maxLength: 25
              description: |-
                The merchant's phone number
                Format: AN25
            workPhone:
              type: string
              maxLength: 25
              description: |-
                The merchant's work phone number
                Format: AN25
            mobile:
              type: string
              maxLength: 25
              description: |-
                The merchant's mobile number
                Format: AN25
            email:
              type: string
              format: email
              maxLength: 128
              description: |-
                The merchant's email address
                Format: AN128
    Merchant:
      type: object
      properties:
        name:
          type: string
          maxLength: 100
          description: |-
            The name of the merchant/acceptor. When used this field will override the value sent as Merchant Name and will normally make up the first line of the card holder statement.
            Typical usage would be of format `{Merchant DBA Name}*{Description of product or service}`.
            Affirm - In the Affirm No VCN flow, when the merchant passes the OPP parameter "merchant.name", the same is populated in the Affirm Checkout JSON object. This informs Affirm to display the passed in merchant name in the Welcome message on the Affirm Modal. This parameter is not applicable for the Affirm VCN flow.
            Format: AN100
        mcc:
          type: string
          maxLength: 4
          description: |-
            The merchants's category code.
            Format: AN4
        street:
          type: string
          maxLength: 100
          description: |-
            The door number, floor, building number, building name, and/or street name of the merchant
            Format: AN100
        city:
          type: string
          maxLength: 100
          description: |-
            The merchant's city, phone number or email, This normally makes up the second line of the card holder statement.
            It is typical for card present transactions to send the city of the location of transaction and for card not present transactions to send the phone, email or url that the shopper would be recognise.
            Format: AN100
        state:
          type: string
          maxLength: 50
          description: |-
            The county, state or region of the merchant
            Format: AN50
        countryCode:
          type: string
          description: The merchant's three-digit country code as defined in ISO 3166-1
        country:
          type: string
          maxLength: 2
          description: |-
            The merchant's two-letter country code as defined in ISO 3166-1
            Format: A2
        postcode:
          type: string
          maxLength: 16
          description: |-
            The postal code or zip code of the merchant
            Format: AN16
        geographicCoordinates:
          type: string
          description: |-
            Merchant Geographic Coordinates contains the latitude and longitude of the merchant's location.
            ex: 61.21630,-149.89500
            NS20
        serviceLocationCity:
          type: string
          maxLength: 100
          description: |-
            The merchant's service location city, where the cardholder received the services is different than the location identified by the merchant city name.
            Format: AN100
        serviceLocationState:
          type: string
          maxLength: 50
          description: |-
            The merchant's service location state, where the cardholder received the services is different than the location identified by the merchant country subdivision code.
            Format: AN50
        serviceLocationCountryCode:
          type: string
          maxLength: 3
          description: |-
            The merchant's service location country code, where the cardholder received the services is different than the location identified by the merchant country code.
            Format: AN3
        serviceLocationPostCode:
          type: string
          maxLength: 16
          description: |-
            The merchant's service location postal code, where the cardholder received the services is different than the location identified by the merchant postal code.
            Format: AN16
        serviceLocationGeographicCoordinates:
          type: string
          description: |-
            Service Location Geographic Coordinates contains the latitude and longitude where the cardholder received the service, if it is different from the merchant's location.
            ex: 61.21630,-149.89500
            NS20
        additionalContact:
          type: string
          maxLength: 255
          description: |-
            The merchant's additional contact information
            Format: AN255
        phone:
          type: string
          maxLength: 25
          description: |-
            The merchants's phone number.
            Format: AN25
        customerContactPhone:
          type: string
          maxLength: 25
          description: |-
            The merchant's customer service phone number, that can be given to consumers for customer service purposes.
            Format: AN25
        websiteId:
          type: string
          maxLength: 255
          description: |-
            The website id of merchant, represents random session id unique for current transaction.
            Format: AN255
        url:
          type: string
          maxLength: 255
          description: |-
            The merchant's URL address.
            Format: AN255
        partnerIdCode:
          type: string
          maxLength: 60
          description: |-
            The merchant's partner ID code, that represents a partnership agreement, generally between specific merchant and issuers.
            Format: AN60
        isoId:
          type: string
          maxLength: 255
          description: |-
            The merchant's independent sales organisation ID
            Format: AN255
        payFacId:
          type: string
          maxLength: 255
          description: |-
            The merchant's payment facilitator ID
            Format: AN255
        payFacName:
          type: string
          maxLength: 255
          description: |-
            The merchant's payment facilitator name
            Format: AN255
        submerchantId:
          type: string
          maxLength: 100
          description: |-
            Used only for MasterCard Payment Facilitators. The id of the sub-merchant.
            Format: AN100
        marketplaceId:
          type: string
          maxLength: 255
          description: |-
            The merchant's marketplace ID
            Format: AN255
        taxId:
          type: string
          maxLength: 60
          description: |-
            The merchant's tax id information
            Format: AN60
        data:
          type: object
          description: |-
            The additional data received from merchant alongside with transaction data.
            key: AN64
            [a-zA-Z0-9\._]{3,64}
            value: AN2048
          additionalProperties:
            type: string
        foreignRetailIndicator:
          type: string
          maxLength: 25
          description: |-
            The merchant's Foreign Retail Indicator
            Format: AN25
        legalName:
          type: string
          maxLength: 100
          description: |-
            The merchant's Legal name
            Format: AN100
        app:
          type: object
          properties:
            schemeUrl:
              type: string
              maxLength: 255
              description: |-
                A merchant's app scheme URL refers to a custom URL scheme that allows external sources (like websites, emails, or other apps) to open a specific merchant app and perform predefined actions
                Format: AN255
        billing:
          $ref: '#/components/schemas/MerchantBillingAddress'
        shipping:
          $ref: '#/components/schemas/ShippingAddress'
    Tokenization:
      type: object
      properties:
        createRegistration:
          type: boolean
          description: |-
            If true, the payment details will be stored with the request. As part of the response, you will receive the parameter registration.id which you can use to reference the registration for later payments.
            Format: A5
        overrideHolder:
          type: boolean
          description: |-
            If true, it allows to send in the card.holder or bankAccount.holder to override the empty holder from the registration/tokenization transaction. It applies only to that particular payment and does not change the holder value of the registration transaction. For one-click payment, the edit box appears as the replacement over the empty label to allow the user to input the new value for the holder. This parameter is available on prepare (and update) checkout step of as well as when sending the payment over registration one-click payment Server-to-Server.
            Format: A5
    PaymentRequest:
      type: object
      required:
        - amount
        - currency
        - paymentType
      properties:
        amount:
          type: string
          description: |-
            Indicates the amount of the payment request. The dot is used as decimal separator. The amount is the only amount value which is processing relevant. All other amount declarations like taxAmount or shipping.cost are already included.
            Format: N10.N2
        taxAmount:
          type: string
          description: |-
            Indicates the tax amount of the payment request. The dot is used as decimal separator.
            Format: N10.N2
        discountAmount:
          type: string
          description: |-
            L3 Card data invoice level discount amount
            Format: N10.N2
        currency:
          type: string
          maxLength: 3
          description: |-
            The currency code of the payment request's amount ([ISO 4217](https://en.wikipedia.org/wiki/ISO_4217)).
            Format: A3
        paymentBrand:
          type: string
          maxLength: 32
          description: |-
            The brand specifies the method of payment for the request. This is optional if you want to use brand detection for credit cards, if not then it is mandatory.
            Format: AN32
        paymentType:
          type: string
          maxLength: 2
          description: |-
            The payment type for the request. You can send payment requests with one of the following types:
            -   **PA**, Preauthorization: A stand-alone authorisation that will also trigger optional risk management and validation. A Capture (CP) with reference to the Preauthorisation (PA) will confirm the payment..
            -   **DB**, Debit: Debits the account of the end customer and credits the merchant account.
            -   **CD**, Credit: Credits the account of the end customer and debits the merchant account.
            -   **CP**, Capture: Captures a preauthorized (PA) amount.
            -   **RV**, Reversal: Reverses an already processed Preauthorization (PA), Debit (DB) or Credit (CD) transaction. As a consequence, the end customer will never see any booking on his statement. A Reversal is only possible until a connector specific cut-off time. Some connectors don't support Reversals.
            -   **RF**, Refund: Credits the account of the end customer with a reference to a prior Debit (DB) or Credit (CD) transaction. The end customer will always see two bookings on his statement. Some connectors do not support Refunds.
            Format: A2
        integrity:
          type: boolean
          description: |-
            If true, the SRI hash of the payment script will be calculated and returned in the response. This is needed to allow the browser to check the integrity of the script in accordance with PCI requirements. For more information refer to [Scripts compliance](/tutorials/pci#widgetCompliance) page
            Format: A5
        overridePaymentType:
          type: object
          description: Override the payment type for specific brands, e.g. overridePaymentType[KLARNA_INVOICE]=PA. Only accepted during checkout creation.
          additionalProperties:
            type: string
        descriptor:
          type: string
          maxLength: 127
          description: |-
            Can be used to populate all or part of the Merchant Name descriptor, which often appears on the first line of the shopper's statement. The full use of this field depends on the Merchant Account configuration. NOTE: `merchant.name` can override any data sent in this field.
            Format: AN127
        merchantTransactionId:
          type: string
          maxLength: 255
          description: |-
            Merchant-provided reference number, should be unique for your transactions. Some receivers require this ID. This identifier is often used for reconciliation.
            Format: AN255
        merchantInvoiceId:
          type: string
          maxLength: 255
          description: |-
            Merchant-provided invoice number, should be unique for your transactions. This identifier is not sent onwards.
            Format: AN255
        merchantMemo:
          type: string
          maxLength: 255
          description: |-
            Merchant-provided additional information. The information provided is not transaction processing relevant. It will appear in reporting only.
            Format: AN255
        transactionCategory:
          type: string
          maxLength: 32
          description: |-
            The category of the transaction, possible values are:
            -   EC - eCommerce
            -   MO - Mail order
            -   TO - Telephone order
            -   PO - pos
            -   PM - mpos
            -   MOTO - Mail order Telephone order
            Format: AN32
        sequence:
          type: string
          description: |-
            Additional field sent by Merchant to indicate last transaction for CP, RV, RF etc.
            **sequence=FINAL** indicates this is the last transaction.
        numberOfCaptures:
          type: integer
          description: |-
            Sets the maximum number of possible partial Captures.
            The `numberOfCaptures` parameter is supported only when the Preauthorization (PA) request creates a new registration.
            If a PA request references an existing registration, the `numberOfCaptures` parameter is not supported and the request will be rejected.
            Format: N2
        promotionCode:
          type: string
          maxLength: 15
          description: |-
            Discount code applied at the Order level. There will be 1 Promotion Code per order.
            Format: AN15
        locale:
          type: string
          maxLength: 10
          description: |-
            Sets the language/country.
            Examples : "de-AT", "en-US". etc
            **Note:** Check the requirements of the connector you are integrating in your shop to understand which language/country that connector supports.
            Format: AN10
        transactionPurposeCode:
          type: string
          maxLength: 12
          description: |-
            Visa AFT and Visa OCT transactions destined for recipients in the countries Argentina, Bangladesh, Chile, Colombia, Egypt, and India, must include this field.
            Purpose of payment codes can be entered according to the regulatory or country requirements of the recipient issuer.
            Format: AN12
        integrationType:
          type: string
          maxLength: 10
          description: |-
            Integration Type
            Format: AN10
        transactionBai:
          type: string
          maxLength: 2
          description: |-
            Used for Visa Direct (AFT and OCT) Business Application ID
            Format: AN2
        transactionTti:
          type: string
          maxLength: 3
          description: |-
            Used for Mastercard Send (Funding and Payment) Transaction Type Identifier
            Format: AN3
        transactionProcessingCode:
          type: string
          description: |-
            Used to flag the type of transaction.
            PURCHASE - default value, used for regular purchase transactions.
            FUNDING - used for Visa AFT or Mastercard funding transactions.
            PAYMENT - used for Visa OCT or Mastercard payment transactions.
            PURCHASE|
            FUNDING|
            PAYMENT
        lifecycleId:
          type: string
          maxLength: 35
          description: |-
            Lifecycle Id
            Used by Mastercard to enable consistent linking of the original authorization with subsequent lifecycle related transactions through the Transaction Link Identifier (TLID) (for example, incremental authorizations, reversals, and captures).
            Format: AN35
        referenceUuid:
          type: string
          maxLength: 32
          description: |-
            The referenceUuid parameter provides a parameterized alternative for referencing an existing transaction by its UUID within a payment request on /v1/payments, instead of using the endpoint‑based reference /v1/payments/{UUID}. When provided, the platform validates the UUID and links the new request to the original payment authorization; if no matching transaction is found, the request fails with a validation error. This parameter is used for REAUTHORIZATION and INCREMENTAL_AUTH.
            Format: AN32
        transactionDueDate:
          type: string
          format: date
          description: |-
            The due date of the transaction of the direct debit.
            AN10
            {19|20)([0-9]{2})-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1]}
        createRegistration:
          type: boolean
          description: |-
            If true, the payment details will be stored with the request. As part of the response, you will receive the parameter registration.id which you can use to reference the registration for later payments.
            Format: A5
        overrideHolder:
          type: boolean
          description: |-
            If true, it allows to send in the card.holder or bankAccount.holder to override the empty holder from the registration/tokenization transaction. It applies only to that particular payment and does not change the holder value of the registration transaction. For one-click payment, the edit box appears as the replacement over the empty label to allow the user to input the new value for the holder. This parameter is available on prepare (and update) checkout step of as well as when sending the payment over registration one-click payment Server-to-Server.
            Format: A5
        shopperResultUrl:
          type: string
          maxLength: 2048
          description: |-
            This URL will receive the result of an asynchronous payment. It is used to redirect the shopper to the merchant’s website or application.
            Must be sent URL encoded and only absolute URLs are supported.
            Format: AN2048
        notificationUrl:
          type: string
          maxLength: 2048
          description: |-
            **Deprecated.** Please follow [webhooks configuration](/tutorials/webhooks) and don’t use the request parameter “notificationUrl”. Due to the huge variety of payment workflows and checkout options, the notificationUrl parameter is not fully compatible with all activities. Please use webhook notifications instead. This URL will receive the asynchronous notification where applicable. It is used to receive the transaction status update on asynchronous payments.
            Must be sent URL encoded. .
            Format: AN2048
        chargebackResultCode:
          type: string
          description: The chargeback reason code for the chargeback as received separately from the acquirer. See the [chargeback result codes](/reference/resultCodes#chargeback) for more detailed information.
        forex:
          $ref: '#/components/schemas/Forex'
        card:
          $ref: '#/components/schemas/Card'
        bankAccount:
          $ref: '#/components/schemas/BankAccount'
        virtualAccount:
          $ref: '#/components/schemas/VirtualAccount'
        tokenAccount:
          $ref: '#/components/schemas/TokenAccount'
        applePay:
          $ref: '#/components/schemas/ApplePay'
        googlePay:
          $ref: '#/components/schemas/GooglePay'
        samsungPay:
          $ref: '#/components/schemas/SamsungPay'
        customer:
          $ref: '#/components/schemas/Customer'
        billing:
          $ref: '#/components/schemas/BillingAddress'
        shipping:
          $ref: '#/components/schemas/ShippingAddress'
        merchant:
          $ref: '#/components/schemas/Merchant'
        corporate:
          $ref: '#/components/schemas/Corporate'
        sender:
          $ref: '#/components/schemas/Sender'
        recipient:
          $ref: '#/components/schemas/Recipient'
        cart:
          $ref: '#/components/schemas/Cart'
        marketPlace:
          $ref: '#/components/schemas/MarketPlace'
        airline:
          $ref: '#/components/schemas/Airline'
        threeDSecure:
          $ref: '#/components/schemas/ThreeDSecure'
        recurringMigration:
          $ref: '#/components/schemas/RecurringMigration'
        risk:
          $ref: '#/components/schemas/Risk'
        pos:
          $ref: '#/components/schemas/POS'
        giftCard:
          $ref: '#/components/schemas/GiftCard'
        job:
          $ref: '#/components/schemas/Scheduling'
        standingInstruction:
          $ref: '#/components/schemas/StandingInstruction'
        tokenization:
          $ref: '#/components/schemas/Tokenization'
        customParameters:
          type: object
          description: Custom unspecified key-value fields echoed back in the response.
          additionalProperties:
            type: string
      description: Request body for creating a payment transaction.
    PaymentResponse:
      type: object
      required:
        - buildNumber
        - timestamp
        - ndc
      properties:
        id:
          type: string
          description: Unique identifier of the resource (checkout, payment or registration).
        referencedId:
          type: string
          maxLength: 32
          description: |-
            In case of referenced payment (e.g., Capture or Refund), this fields included to see which payment was referenced.
            **Note:** This fields is only for webhook notification.
            Format: AN32
        paymentBrand:
          type: string
          maxLength: 32
          description: |-
            The payment brand of the request.
            Format: AN32
        amount:
          type: string
          description: |-
            The amount of the transaction approved by the acquirer, alternative payment method or other payment platform.
            Format: N10.N2
        currency:
          type: string
          maxLength: 3
          description: |-
            The currency of the request.
            Format: A3
        descriptor:
          type: string
          maxLength: 127
          description: |-
            The descriptor of the request.
            Format: AN127
        result:
          type: object
          required:
            - code
          properties:
            code:
              type: string
              maxLength: 11
              description: |-
                The unique code that indicates the result status of the request. See the [result codes](/reference/resultCodes) for more detailed information.
                Format: AN11
            description:
              type: string
              maxLength: 255
              description: |-
                A textual description explaining the result.code's meaning.
                Format: AN255
            avsResponse:
              type: string
              maxLength: 1
              description: |-
                Contains the AVS response returned by the acquirer. It may include one the following result:
                A = Address does match, zip code does not match
                Z = Address does not match, zip code does match
                N = Address and zip code do not match
                U = Technical or logical error. AVS cannot be applied on card or address (not UK or US issuer), issuer is not available, etc.
                F = Address and Postal Code Matches
                Format: A1
            cvvResponse:
              type: string
              maxLength: 1
              description: |-
                Contains the CVV response returned by the acquirer. It may include one the following result:
                -   **M - CVV2 Match**
                    Indicates that the issuer was able to verify the CVV2 value provided by the merchant.
                -   **N - CVV2, CVC2, Discover CID or AMEX CID do not match**
                    Indicates that the issuer was not able to verify the CVV2 value provided by the merchant.
                -   **P - Not Processed**
                    Indicates that the issuer was unable to verify the CVV2 value provided by the merchant because either their verification system was not functioning, or not all of the information needed to verify the CVV2 value (such as the expiration date) was included in the request.
                -   **S - CVV2, CVC2, Discover CID or AMEX CID data is not present on the card, but the issuer indicated it should be present**
                    Indicates that the issuer was unable to perform CVV2 verification, and notifies the merchant that the card should contain a CVV2 value.
                -   **U - Unsupported by issuer or issuer is unable to process request**
                    Indicates that the issuer is not participating in the CVV2 service, or that the issue has not provided the card Brand with the required encryption keys needed to perform verification, or that STIP has responded with unavailable response.
                Format: A1
        resultDetails:
          type: object
          description: |-
            A container for name value pair used for enriching the response with bank-specific response details. I.e. the actual parameters used within resultDetails are bank-specific.
            Example: resultDetails.AuthCode=123456
            name: AN64
            [a-zA-Z0-9\._]{3,64}
            value: AN2048
          properties:
            AcquirerResponse:
              type: string
              maxLength: 2048
              description: |-
                Represents the acquirer original response code retrieved from the acquirer directly.
                Format: AN2048
            MerchantAdviceCode:
              type: string
              maxLength: 2
              description: |-
                Represents information regarding reason of decline and next actions for a transaction.
                (Note: Check individual integration sheet to ensure if any specific integration supports this field)
                Format: N2
        card:
          type: object
          properties:
            bin:
              type: string
              maxLength: 6
              description: |-
                The first six digits of the card.number
                Format: N6
            holder:
              type: string
              maxLength: 6
              description: |-
                Holder of the credit card account
                Format: N6
            expiryMonth:
              type: string
              maxLength: 6
              description: |-
                The expiry month of the card
                Format: N6
            expiryYear:
              type: string
              maxLength: 4
              description: |-
                The expiry year of the card
                Format: N4
            issuer:
              type: object
              properties:
                bank:
                  type: string
                  maxLength: 2048
                  description: |-
                    The issuer name
                    Format: AN2048
                phone:
                  type: string
                  maxLength: 2048
                  description: |-
                    The phone number of the issuer
                    Format: AN2048
                website:
                  type: string
                  maxLength: 2048
                  description: |-
                    The website of the issuer
                    Format: AN2048
            type:
              type: string
              maxLength: 2048
              description: |-
                The type of the card, eg. CREDIT
                Format: AN2048
            level:
              type: string
              maxLength: 4
              description: |-
                The level of the card, eg. DEFERRED DEBIT
                Format: N4
            regulatedFlag:
              type: string
              maxLength: 2048
              description: |-
                Regulated or unregulated, eg. true|false
                Format: AN2048
        merchant:
          type: object
          properties:
            bankAccount:
              type: object
              required:
                - holder
              properties:
                holder:
                  type: string
                  maxLength: 128
                  description: |-
                    Holder of the merchant's bank account
                    Format: AN128
                number:
                  type: string
                  maxLength: 64
                  description: |-
                    The account number of the merchant's bank account. (IBAN for SEPA accounts)
                    Format: AN64
                bic:
                  type: string
                  maxLength: 11
                  description: |-
                    The BIC (Bank Identifier Code (SWIFT)) number of the merchant's bank account.
                    Format: AN11
                country:
                  type: string
                  maxLength: 2
                  description: |-
                    The country code of the merchant's bank account ([ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1)).
                    Format: AN2
        risk:
          type: object
          properties:
            score:
              type: string
              maxLength: 6
              description: |-
                Returns the score of the executed transaction risk checks. The value is a number from -99999 to +99999. Can be returned both for standalone risk requests and payment requests that include risk checks.
                Format: AN6
        Other:
          type: string
          description: |-
            The response can also contain each of the data structures listed above, such as `customer` and `billingAddress`.
            n/a
        buildNumber:
          type: string
          maxLength: 255
          description: |-
            Useful for support purposes.
            Format: AN255
        timestamp:
          type: string
          format: date-time
          description: |-
            The timestamp the response has generated.
            date
            yyyy-MM-dd hh:mm:ssZ
        ndc:
          type: string
          maxLength: 69
          description: |-
            An internal unique identifier for the request.
            Format: AN69
        brandResult:
          type: string
          maxLength: 16
          description: |-
            Detected brand
            Format: A16
        redirect:
          type: object
          properties:
            url:
              type: string
              maxLength: 2048
              description: |-
                URL the the shopper must be redirected to in order to proceed.
                Format: AN2048
            parameters:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                    maxLength: 255
                    description: |-
                      List of parameter names for the redirect.url. The corresponding parameter value is the same parameter number ending with .value like described in the line below.
                      Format: AN255
                  value:
                    type: string
                    maxLength: 255
                    description: |-
                      The parameter values corresponding to the names as described above.
                      Format: AN255
      description: Standard JSON response returned by payment, checkout and registration requests.
    FraudRequest:
      type: object
      required:
        - entityId
        - risk
        - transactionCategory
        - paymentType
        - currency
      properties:
        entityId:
          type: string
          maxLength: 32
          description: |-
            The unique identifier for the entity making the request. This is an API-level field used for authentication.
            Format: AN32
        merchantTransactionId:
          type: string
          maxLength: 40
          description: |-
            The transaction ID assigned by the merchant for this transaction.
            Format: AN40
        schemeTransactionId:
          type: string
          maxLength: 60
          description: |-
            The transaction ID assigned by the scheme for this transaction.
            Format: AN60
        risk:
          $ref: '#/components/schemas/Risk'
        card:
          $ref: '#/components/schemas/Card'
        binData:
          type: object
          description: |-
            Extended issuer information derived from BIN data (e.g., issuer name and country).
            Object
        bankAccount:
          $ref: '#/components/schemas/BankAccount'
        virtualAccount:
          $ref: '#/components/schemas/VirtualAccount'
        threeDSecure:
          $ref: '#/components/schemas/ThreeDSecure'
        merchant:
          $ref: '#/components/schemas/Merchant'
        customer:
          $ref: '#/components/schemas/Customer'
        shipping:
          $ref: '#/components/schemas/ShippingAddress'
        billing:
          $ref: '#/components/schemas/BillingAddress'
        corporate:
          $ref: '#/components/schemas/Corporate'
        payment:
          type: object
          description: |-
            Additional payment details for bank-to-bank transactions (e.g., payment reference, destination account).
            Object
        transactionCategory:
          type: string
          description: |-
            The transaction category.
            Allowed values: ACH, BPY, EC, IN, MO, RP, TO, PO, PM, MOTO, VN
            String (enum)
        category:
          type: string
          maxLength: 32
          description: |-
            A more descriptive, human‑readable category (e.g., akin to an MCC).
            Format: AN32
        paymentType:
          type: string
          description: |-
            The payment type for the request.
            Allowed values: AV, CD, CP, DB, PA, PY, RF, RV, TR
            String (enum)
        amount:
          type: string
          description: |-
            The transaction amount as a string.
            amountString
        currency:
          type: string
          description: |-
            ISO 4217 alphabetic currency code.
            currencyCodeAlpha
        authorizationDateTime:
          type: string
          format: date-time
          description: |-
            The date and time the transaction was authorized (RFC 3339), expected UTC.
            date-time (RFC 3339)
        authorizationResponseCode:
          type: string
          maxLength: 2
          description: |-
            Response code from the card authorizer (typically 2 characters).
            Format: AN2
        paymentBrand:
          type: string
          maxLength: 32
          description: |-
            Brand of the payment card (e.g., Visa, Mastercard, Amex).
            Format: AN32
        giftCard:
          $ref: '#/components/schemas/GiftCard'
        cart:
          $ref: '#/components/schemas/Cart'
        airline:
          $ref: '#/components/schemas/Airline'
      description: Request body for a stand-alone fraud / risk analysis.
    FraudResponse:
      type: object
      properties:
        result:
          type: object
          properties:
            code:
              type: string
            description:
              type: string
        risk:
          type: object
          properties:
            score:
              type: string
    WebhookNotification:
      type: object
      required:
        - type
        - payload
      properties:
        type:
          type: string
          description: |-
            Type of notification
            -   **PAYMENT** This type of notification is sent when payment is created or updated in the system.
            -   **REGISTRATION** This type of notification is sent when we get new registration request, or the existing registration has been deleted.
            PAYMENT|
            REGISTRATION
        action:
          type: string
          description: |-
            Indicator of status change
            -   **CREATED** e.g., When registration has been created.
            -   **UPDATED** e.g., When registration has been updated.
            -   **DELETED** e.g., When registration has been deleted.
            CREATED|
            UPDATED|
            DELETED
        payload:
          type: string
          description: |-
            Content of notification. If the notification type is payment or registration, payload will be identical to payment response you received.
            JSON
        presentationAmount:
          type: string
          description: |-
            The presentation amount of the request.
            Format: N10.N2
        presentationCurrency:
          type: string
          maxLength: 3
          description: |-
            The presentation currency of the request.
            Format: A3
    ReconciliationRecord:
      type: object
      required:
        - Cashflow
        - SettlementAmount
        - SettlementCurrency
        - SettlementFxRate
        - SettlementDate
        - SettlementStatus
        - SettlementFileFormat
        - ClearingInsitituteName
        - ClearingInstituteMerchantId
        - MerchantAccountId
        - ReconciliationType
        - PaymentType
        - PspId
        - MerchantId
        - TransactionId
        - Amount
        - Currency
      properties:
        ReasonCode:
          type: string
          maxLength: 11
          description: |-
            result.code
            Failure Status Code (available only for Chargebacks)
            Format: AN11
        ReasonDesc:
          type: string
          maxLength: 128
          description: |-
            result.description
            Failure Status Description (available only for Chargebacks)
            Format: AN128
        SettlementTxId:
          type: string
          maxLength: 64
          description: |-
            settlement.id
            Transaction ID at Settlement Provider
            Format: AN64
        Cashflow:
          type: string
          description: |-
            settlement.cashflow
            Transaction Balance Direction
            POS, NEG
        SettlementAmount:
          type: string
          maxLength: 13
          description: |-
            settlement.amount
            Settled Amount
            Format: N13
        SettlementCurrency:
          type: string
          description: |-
            settlement.currency
            Settlement Currency
            A3 (according to ISO 4217)
        SettlementFee:
          type: string
          maxLength: 13
          description: |-
            settlement.fee
            Settlement Fee
            Format: N13
        SettlementFxRate:
          type: string
          maxLength: 13
          description: |-
            settlement.fxRate
            Settlement FX Rate
            Format: N13
        SettlementDate:
          type: string
          format: date
          description: |-
            settlement.date
            Date on which settlement is executed by the Clearing Institute in its time zone
        SettlementStatus:
          type: string
          description: |-
            settlement.status
            Settlement Status
            SUCCESS, FAILED
        SettlementFileFormat:
          type: string
          maxLength: 32
          description: |-
            settlement.format
            File format of Settlement File
            Format: AN32
        ClearingInsitituteName:
          type: string
          maxLength: 64
          description: |-
            clearingInstitute.name
            Name of Clearing Institute
            Format: AN64
        ClearingInstituteMerchantId:
          type: string
          maxLength: 64
          description: |-
            clearingInstitute.merchantId
            Merchant ID at Settlement Provider
            Format: AN64
        ConnectorTxId1:
          type: string
          maxLength: 64
          description: |-
            clearingInstitute.txId1
            Additional field for a transaction related reference (provided by the Clearing Institute)
            Format: AN64
        ConnectorTxId2:
          type: string
          maxLength: 64
          description: |-
            clearingInstitute.txId2
            Additional field for a transaction related reference (provided by the Clearing Institute)
            Format: AN64
        ConnectorTxId3:
          type: string
          maxLength: 64
          description: |-
            clearingInstitute.txId3
            Additional field for a transaction related reference (provided by the Clearing Institute)
            Format: AN64
        AccountNumberLast4:
          type: string
          maxLength: 4
          description: |-
            bankAccount.last4Digits
            Last 4 digits of the bank account
            Format: AN4
        AccountHolder:
          type: string
          maxLength: 128
          description: |-
            bankAccount.holder
            Account Holder of bank acount
            Format: AN128
        BankCode:
          type: string
          maxLength: 12
          description: |-
            bankAccount.bankCode
            Bank Code/BIC in case the transaction is bank related
            Format: AN12
        MerchantAccountId:
          type: string
          maxLength: 32
          description: |-
            merchantAccount.id
            Account ID of Merchant
            Format: AN32
        MerchantAccountName:
          type: string
          maxLength: 32
          description: |-
            merchantAccount.name
            Name of Merchant
            Format: AN32
        UniqueID:
          type: string
          maxLength: 32
          description: |-
            payment.id
            Unique ID of payment transaction in gateway
            Format: AN32
        ReconciliationType:
          type: string
          description: |-
            recordType
            Type of the record
            SETTLED, CHARGEBACK, CHARGEBACK REVERSAL, FEE
        PaymentType:
          type: string
          description: |-
            transactionType
            Type of Transaction
            DEBIT, CREDIT, REFUND, BATCH, MONTHLY, SUBMERCHANT, PAYMENT_FACILITATOR, AUTH_FEE, CAPTURE_FEE, CANCEL_FEE, REFUND_FEE
        PspId:
          type: string
          maxLength: 32
          description: |-
            pspEntityId
            ID of PSP
            Format: AN32
        DivisionId:
          type: string
          maxLength: 32
          description: |-
            divisionEntityId
            ID of Division
            Format: AN32
        MerchantId:
          type: string
          maxLength: 32
          description: |-
            merchantEntityId
            ID of Merchant
            Format: AN32
        ShortId:
          type: string
          maxLength: 14
          description: |-
            -
            Short Id of payment transaction in gateway
            Format: AN14
        TransactionId:
          type: string
          maxLength: 255
          description: |-
            merchantTransactionId
            Unique reference number provided by merchant or generated by the gateway
            Format: AN255
        InvoiceId:
          type: string
          maxLength: 255
          description: |-
            merchantInvoiceId
            Invoice ID provided by merchant
            Format: AN255
        Amount:
          type: string
          maxLength: 13
          description: |-
            amount
            Transaction amount
            Format: N13
        Currency:
          type: string
          description: |-
            currency
            Transaction Currency
            A3 (according to ISO 4217)
        Brand:
          type: string
          maxLength: 16
          description: |-
            paymentBrand
            Brand of the payment method
            Format: A16
        TxRequestTime:
          type: string
          format: date-time
          description: |-
            presentmentDate
            Time of ordering the transaction by the merchant in Clearing Institute’s time zone.
            The value can be either retrieved from a specific field in the received settlement file. Or in case no specific field is identified/mapped the default code is utilized which is the timestamp when the acquirer file is parsed on our system. (i.e. the timestamp of the recon job)
        Descriptor:
          type: string
          maxLength: 128
          description: |-
            descriptor
            Transaction Reference which appears on the end customer’s statement
            Format: AN128
        MatchingStatus:
          type: string
          description: |-
            matchedTransactions.status
            The matching status of the corresponding transaction within the gateway
        MatchedTransactions:
          type: string
          maxLength: 32
          description: |-
            matchedTransactions.payment[n].id
            Unique ID(s) of the matched transactions
            Format: AN32
        ChargebackId:
          type: string
          maxLength: 32
          description: |-
            chargebackTransaction.id
            The Unique ID of the Chargeback transaction generated by the gateway after matching a chargeback record.
            Format: AN32