@checkdigit/eslint-plugin 7.17.1 → 7.18.0-PR.143-8290

package/src/services/message/v2/swagger.yml

@@ -0,0 +1,3009 @@
+openapi: 3.0.0
+info:
+  title: Message
+  description: |
+
+    Creates and retrieves message resources.
+
+    © Check Digit LLC. 2019-2024
+  version: 2.0.0
+  contact:
+    name: Check Digit
+
+servers:
+  - url: /message/v2
+tags:
+  - name: Service Health
+  - name: API
+
+x-firehose-logged: false
+
+paths:
+  /ping:
+    get:
+      tags:
+        - Service Health
+      operationId: 'ping-get'
+      description: |
+        Returns the current server time. This operation is useful for testing if this service is available.
+      responses:
+        '200':
+          $ref: '#/components/responses/Ping'
+        default:
+          $ref: '#/components/responses/ServerError'
+
+  /request:
+    get:
+      tags:
+        - API
+      operationId: 'request-query-get'
+      description: Returns an object with a list of Request resources.
+      parameters:
+        - $ref: '#/components/parameters/cardIds'
+        - $ref: '#/components/parameters/toDate'
+        - $ref: '#/components/parameters/fromDate'
+      responses:
+        '200':
+          description: Operation successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Requests'
+        default:
+          $ref: '#/components/responses/ServerError'
+
+  /picked-request:
+    get:
+      tags:
+        - API
+      operationId: 'picked-request-get'
+      description: |
+        Returns an object with a list of PickedRequest objects.
+
+        A PickedRequest object may be preferred to minimize the amount of data retrieved and the time taken to
+        transmit and process the response.
+      parameters:
+        - $ref: '#/components/parameters/cardIds'
+        - $ref: '#/components/parameters/toDate'
+        - $ref: '#/components/parameters/fromDate'
+        - $ref: '#/components/parameters/requestFields'
+      responses:
+        '200':
+          description: Operation successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PickedRequests'
+        default:
+          $ref: '#/components/responses/ServerError'
+
+  /request/{messageId}:
+    put:
+      tags:
+        - API
+      x-firehose-logged: true
+      operationId: 'request-put'
+      description: Creates a Request resource.
+      parameters:
+        - $ref: '#/components/parameters/messageId'
+        - $ref: '#/components/parameters/createdOn'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NewRequest'
+      responses:
+        '204':
+          description: Operation successful.
+          content:
+            application/json:
+              schema: {}
+          headers:
+            Created-On:
+              $ref: '#/components/headers/Created-On'
+            Updated-On:
+              $ref: '#/components/headers/Updated-On'
+        '409':
+          description: Operation unsuccessful. A Request resource with the same messageId exists with different data.
+          content:
+            application/json:
+              schema: {}
+        default:
+          $ref: '#/components/responses/ServerError'
+
+    get:
+      tags:
+        - API
+      operationId: 'request-get'
+      description: Returns a Request resource.
+      parameters:
+        - $ref: '#/components/parameters/messageId'
+        - $ref: '#/components/parameters/at'
+      responses:
+        '200':
+          description: Operation successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Request'
+          headers:
+            Created-On:
+              $ref: '#/components/headers/Created-On'
+            Updated-On:
+              $ref: '#/components/headers/Updated-On'
+        '404':
+          description: Operation unsuccessful. A Request object with the same messageId was not found.
+          content:
+            application/json:
+              schema: {}
+        default:
+          $ref: '#/components/responses/ServerError'
+
+  /response:
+    get:
+      tags:
+        - API
+      operationId: 'response-query-get'
+      description: Returns an object with a list of Response resources.
+      parameters:
+        - $ref: '#/components/parameters/cardIds'
+        - $ref: '#/components/parameters/toDate'
+        - $ref: '#/components/parameters/fromDate'
+      responses:
+        '200':
+          description: Operation successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Responses'
+        default:
+          $ref: '#/components/responses/ServerError'
+
+  /picked-response:
+    get:
+      tags:
+        - API
+      operationId: 'picked-response-get'
+      description: Returns an object with a list of PickedResponse objects.
+      parameters:
+        - $ref: '#/components/parameters/cardIds'
+        - $ref: '#/components/parameters/toDate'
+        - $ref: '#/components/parameters/fromDate'
+        - $ref: '#/components/parameters/responseFields'
+      responses:
+        '200':
+          description: Operation successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/PickedResponses'
+        default:
+          $ref: '#/components/responses/ServerError'
+
+  /response/{messageId}:
+    put:
+      tags:
+        - API
+      x-firehose-logged: true
+      operationId: 'response-put'
+      description: Creates a Response resource.
+      parameters:
+        - $ref: '#/components/parameters/messageId'
+        - $ref: '#/components/parameters/createdOn'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/NewResponse'
+      responses:
+        '204':
+          description: Operation successful.
+          content:
+            application/json:
+              schema: {}
+          headers:
+            Created-On:
+              $ref: '#/components/headers/Created-On'
+            Updated-On:
+              $ref: '#/components/headers/Updated-On'
+        '409':
+          description: Operation unsuccessful. A Response resource with the same messageId exists with different data.
+          content:
+            application/json:
+              schema: {}
+        default:
+          $ref: '#/components/responses/ServerError'
+
+    get:
+      tags:
+        - API
+      operationId: 'response-get'
+      description: Returns a Response resource.
+      parameters:
+        - $ref: '#/components/parameters/messageId'
+        - $ref: '#/components/parameters/at'
+      responses:
+        '200':
+          description: Operation successful.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Response'
+          headers:
+            Created-On:
+              $ref: '#/components/headers/Created-On'
+            Updated-On:
+              $ref: '#/components/headers/Updated-On'
+        '404':
+          description: Operation unsuccessful. A Response resource with the same messageId was not found.
+          content:
+            application/json:
+              schema: {}
+        default:
+          $ref: '#/components/responses/ServerError'
+
+components:
+  schemas:
+    Ping:
+      type: object
+      description: The current server time.
+      additionalProperties: false
+      required:
+        - serverTime
+      properties:
+        serverTime:
+          type: string
+          format: date-time
+
+    Responses:
+      type: object
+      additionalProperties: false
+      description: |
+        An object containing a list of Response objects.
+      required:
+        - messages
+      properties:
+        messages:
+          type: array
+          items:
+            $ref: '#/components/schemas/Response'
+
+    Requests:
+      type: object
+      additionalProperties: false
+      description: |
+        An object containing a list of Request objects.
+      required:
+        - messages
+      properties:
+        messages:
+          type: array
+          items:
+            $ref: '#/components/schemas/Request'
+
+    PickedRequests:
+      type: object
+      additionalProperties: false
+      description: |
+        An object containing a list of PickedRequest objects.
+      required:
+        - pickedMessages
+      properties:
+        pickedMessages:
+          type: array
+          items:
+            $ref: '#/components/schemas/PickedRequest'
+
+    PickedResponses:
+      type: object
+      additionalProperties: false
+      description: |
+        An object containing a list of PickedResponse objects.
+      required:
+        - pickedMessages
+      properties:
+        pickedMessages:
+          type: array
+          items:
+            $ref: '#/components/schemas/PickedResponse'
+
+    Error:
+      type: object
+      additionalProperties: false
+      description: |
+        An object containing an error message.
+      required:
+        - message
+      properties:
+        message:
+          type: string
+        code:
+          type: string
+
+    Amount:
+      type: object
+      additionalProperties: false
+      description: |
+        An amount of money in the smallest monetary unit of the specified currency.
+      required:
+        - amount
+        - currency
+      properties:
+        amount:
+          type: string
+          pattern: '^[0-9]+$'
+          description: The amount of money in the smallest monetary unit of the specified currency.
+        currency:
+          $ref: '#/components/schemas/CurrencyAlphabeticCode'
+
+    SettlementConversion:
+      type: object
+      description: |
+        The rate sent by the network used to convert the transaction amount to the settlement amount.
+
+        Only present if the transaction currency differs from the settlement currency.
+
+        To calculate the conversion rate, use the following formula:
+
+          conversion rate = factor / (10 ^ factorDecimalPosition)
+
+      required:
+        - date
+        - factor
+        - factorDecimalPosition
+      properties:
+        date:
+          description: |
+            The year, month, and day the conversion rate was determined.
+          type: string
+          format: date
+        factor:
+          description: |
+            The multiplying factor used to convert the transaction amount to the settlement
+            amount.
+          type: string
+        factorDecimalPosition:
+          description: |
+            The position the decimal point should be placed, starting from the right.
+          type: number
+
+    MessageType:
+      type: string
+      description: |
+        The type of message received from the network.
+      enum:
+        - PREAUTHORIZATION
+        - FINANCIAL
+        - ADMINISTRATIVE
+        - REVERSAL
+
+    MessageUsage:
+      type: string
+      description: |
+        The expected use of the message received from the network. 
+
+        A REQUEST is a message that can be declined, while and ADVICE cannot. RESPONSE and ADVICE RESPONSE are the 
+        responses to REQUEST and ADVICE messages, respectively.
+
+      enum:
+        - REQUEST
+        - RESPONSE
+        - ADVICE
+        - ADVICE RESPONSE
+
+    Category:
+      type: string
+      description: The category of message received from the network.
+      enum:
+        - GOODS AND SERVICE
+        - QUASICASH
+        - SCRIP
+        - ATM
+        - OTC
+        - AFD
+        - BALANCE INQUIRY
+        - ACCOUNT INQUIRY
+        - FUNDS TRANSFER
+        - BILL PAYMENT
+        - ADJUSTMENT
+        - RETURN
+        - LOAD
+        - UNLOAD
+        - ACTIVATION
+        - ACTIVATION AND LOAD
+        - DEACTIVATION
+        - DEACTIVATION AND UNLOAD
+        - TOKENIZATION
+        - REQUEST ACTIVATION METHODS
+        - DELIVER ACTIVATION CODE
+        - NOTIFY TOKEN ACTIVATED
+        - NOTIFY TOKEN UPDATED
+        - NOTIFY SUSPICIOUS EVENTS
+        - UNSUPPORTED
+
+    DebitCreditNeither:
+      type: string
+      description: |
+        The Request object's intended effect on the account balance.
+
+        For example, Balance Inquiries with no fees have no effect on the balance.
+      enum:
+        - DEBIT
+        - CREDIT
+        - NEITHER
+
+    DebitCredit:
+      type: string
+      enum:
+        - DEBIT
+        - CREDIT
+
+    Categorization:
+      type: object
+      additionalProperties: false
+      description: |
+        The categorization of the message received from the network.
+      required:
+        - messageType
+        - messageUsage
+        - category
+        - debitCredit
+      properties:
+        messageType:
+          $ref: '#/components/schemas/MessageType'
+        messageUsage:
+          $ref: '#/components/schemas/MessageUsage'
+        category:
+          $ref: '#/components/schemas/Category'
+        debitCredit:
+          $ref: '#/components/schemas/DebitCreditNeither'
+
+    AccountType:
+      type: string
+      enum:
+        - NOT PROVIDED
+        - UNSPECIFIED
+        - SAVINGS
+        - CHECKING
+        - CREDIT
+        - INVESTMENT
+        - UNIVERSAL
+        - OTHER
+
+    Accounts:
+      type: object
+      description: |
+        Used when transferring funds between accounts. 
+
+        For example, messages from ATMs that support multiple accounts may utilize this object.
+      additionalProperties: false
+      required:
+        - from
+        - to
+      properties:
+        from:
+          $ref: '#/components/schemas/AccountType'
+        to:
+          $ref: '#/components/schemas/AccountType'
+
+    PinCapabilities:
+      type: string
+      description: |
+        The terminal's ability to accept a PIN.
+      enum:
+        - NOT PROVIDED
+        - UNSPECIFIED
+        - PIN ENTRY CAPABILITY
+        - NO PIN ENTRY CAPABILITY
+        - PIN PAD INOPERATIVE
+        - PIN ENTRY CAPABILITY BUT OUT OF SERVICE
+        - PIN VERIFIED BY TERMINAL DEVICE
+
+    PanEntryMethod:
+      type: string
+      description: |
+        The method used to enter the PAN.
+      enum:
+        - NOT PROVIDED
+        - UNSPECIFIED
+        - MANUAL
+        - MAGNETIC STRIPE
+        - BAR CODE
+        - OCR
+        - INTEGRATED CIRCUIT CARD
+        - MANUAL KEY ENTERED
+        - CONTACTLESS EMV RULES
+        - CHIP CARD UNABLE MANUAL ENTRY
+        - CHIP CARD UNABLE MAGNETIC STRIPE
+        - ELECTRONIC COMMERCE
+        - PAN AUTO ENTRY VIA SERVER
+        - FULL MAGNETIC STRIPE
+        - CONTACTLESS MAG STRIPE RULES
+        - INTEGRATED CIRCUIT CARD CVV UNRELIABLE
+        - STORED VALUE PREREGISTERED CHECKOUT
+        - ON FILE
+        - SECURE ENTRY
+
+    TerminalType:
+      type: string
+      description: |
+        The type of terminal used to initiate the transaction.
+      enum:
+        - POINT OF SALE TERMINAL
+        - ATM
+        - HOME TERMINAL
+        - ELECTRONIC CASH REGISTER
+        - DIAL TERMINAL
+        - TRAVELERS CHECK MACHINE
+        - AUTOMATED FUEL DEVICE
+        - SCRIP MACHINE
+        - COUPON MACHINE
+        - TICKET MACHINE
+        - POINT OF BANKING TERMINAL
+        - TELLER
+        - FRANCHISE TELLER
+        - PERSONAL BANKING
+        - PUBLIC UTILITY
+        - VENDING
+        - SELF SERVICE
+        - AUTHORIZATION
+        - PAYMENT
+        - VRU
+        - SMART PHONE
+        - INTERACTIVE TELEVISION
+        - PERSONAL DIGITAL ASSISTANT
+        - SCREEN PHONE
+        - ELECTRONIC COMMERCE
+        - MICR TERMINAL AT POINT OF SALE
+        - NOT PROVIDED
+
+    CardholderPresence:
+      type: string
+      description: |
+        The presence of the cardholder during the transaction.
+      enum:
+        - CUSTOMER PRESENT
+        - CUSTOMER NOT PRESENT
+        - NOT PROVIDED
+
+    CardPresence:
+      type: string
+      description: |
+        The presence of the card during the transaction.
+      enum:
+        - CARD PRESENT
+        - CARD NOT PRESENT
+        - NOT PROVIDED
+
+    Merchant:
+      type: object
+      description: |
+        Information about the merchant and terminal where the transaction took place.
+      additionalProperties: false
+      required:
+        - type
+        - name
+        - terminalTransactionDateTime
+        - terminalSequenceNumber
+        - terminalIdentification
+        - identificationCode
+        - address
+        - city
+        - stateProvince
+        - country
+        - allowsPartialApproval
+        - panEntryMethod
+        - pinCapabilities
+        - cardholderPresence
+        - cardPresence
+        - terminalType
+        - terminalOperation
+        - terminalLocation
+        - cardRetentionCapability
+        - transactionStatus
+        - securityCondition
+      properties:
+        type:
+          type: string
+          description: |
+            The Merchant Category Code (MCC) - a four digit number identifying the kind of merchant 
+            involved in the transaction, e.g. grocery store, airline, hotel.
+        name:
+          type: string
+          description: The name of the merchant or business.
+        terminalTransactionDateTime:
+          type: string
+          description: The UTC datetime of the transaction according to the terminal's clock.
+          format: date-time
+        terminalSequenceNumber:
+          type: number
+          description: A counter or identifier used by the terminal to track the transactions it processes.
+        terminalIdentification:
+          type: string
+          description: Identifier for a terminal at the card acceptor's location.
+        identificationCode:
+          type: string
+          description: Identifier for the specific merchant accepting payment.
+        address:
+          type: string
+          description: The merchant's street address.
+        city:
+          type: string
+          description: The merchant's city address.
+        stateProvince:
+          type: string
+          description: The merchant's state or province address.
+        county:
+          type: string
+          description: The merchant's county address.
+        postalCode:
+          type: string
+          description: The merchant's postal code.
+        country:
+          type: string
+          description: The merchant's country.
+        allowsPartialApproval:
+          type: boolean
+          description: |
+            Has the value 'true' if the merchant accepts partial approvals. Otherwise, the value is 'false'.
+        panEntryMethod:
+          $ref: '#/components/schemas/PanEntryMethod'
+        pinCapabilities:
+          $ref: '#/components/schemas/PinCapabilities'
+        cardholderPresence:
+          $ref: '#/components/schemas/CardholderPresence'
+        cardPresence:
+          $ref: '#/components/schemas/CardPresence'
+        terminalType:
+          $ref: '#/components/schemas/TerminalType'
+        terminalOperation:
+          type: string
+          description: |
+            The entity operating the terminal.
+          enum:
+            - CUSTOMER
+            - CARD ACCEPTOR
+            - ADMINISTRATIVE
+            - UNKNOWN
+            - NOT PROVIDED
+        terminalLocation:
+          type: string
+          description: |
+            The location of the terminal.
+          enum:
+            - ON PREMISE
+            - OFF PREMISE
+            - UNKNOWN
+            - NOT PROVIDED
+        cardRetentionCapability:
+          type: string
+          description: |
+            The terminal's ability to retain the card.
+          enum:
+            - ABLE TO RETAIN CARD
+            - UNABLE TO RETAIN CARD
+            - UNKNOWN
+            - NOT PROVIDED
+        transactionStatus:
+          type: string
+          description: |
+            The status of the transaction.
+          enum:
+            - ORIGINAL PRESENTMENT
+            - FIRST PRESENTMENT
+            - SECOND PRESENTMENT
+            - THIRD PRESENTMENT
+            - PREVIOUSLY AUTHORIZED OR DEFERRED AUTHORIZATION
+            - RESUBMISSION
+            - CARD VALIDATION OR ACCOUNT STATUS INQUIRY
+            - UNKNOWN
+            - NOT PROVIDED
+        securityCondition:
+          type: string
+          description: |
+            The security condition of the transaction.
+          enum:
+            - NO CONCERN
+            - SUSPECTED FRAUD
+            - IDENTIFICATION VERIFIED
+            - ECOMMERCE WITH DIGITAL SIGNATURE
+            - ECOMMERCE
+            - SECURE ELECTRONIC TRANSACTION WITH CARDHOLDER CERTIFICATE
+            - SECURE ELECTRONIC TRANSACTION WITHOUT CARDHOLDER CERTIFICATE
+            - ECOMMERCE WITH CHANNEL ENCRYPTED
+            - INTERNET PINNED DEBIT TRANSACTION
+            - SECURE REMOTE COMMERCE DISCOVER CLICK TO PAY
+            - UNKNOWN
+            - NOT PROVIDED
+
+    Acquirer:
+      type: object
+      additionalProperties: false
+      description: |
+        Information about the acquirer involved in the transaction.
+      required:
+        - identificationCode
+        - country
+      properties:
+        identificationCode:
+          type: string
+          description: |
+            Uniquely identifies the acquirer.
+        clearingIdentificationCode:
+          description: |
+            Unvalidated data that may help identify the acquirer. It's optionally included by the acquirer in clearing messages.
+          type: string
+        country:
+          type: string
+          description: |
+            The country in which the acquirer is located.
+
+    LifeCycleIndicator:
+      type: string
+      description: |
+        The type of time interval in effect for the message.
+      enum:
+        - CALENDAR DAY
+        - HOURS
+        - MINUTES
+
+    AuthorizationLifeCycle:
+      type: object
+      additionalProperties: false
+      description: |
+        The length of time the acquirer is requesting the issuer to hold the funds.
+      required:
+        - lifeCycleIndicator
+        - actualInterval
+      properties:
+        lifeCycleIndicator:
+          $ref: '#/components/schemas/LifeCycleIndicator'
+        actualInterval:
+          type: number
+          description: |
+            The number of time intervals in effect for the message.
+
+    ReplacementAmounts:
+      type: object
+      additionalProperties: false
+      description: |
+        The actual transaction, settlement, and fee amounts when they differ from the original
+        approved amounts.
+      required:
+        - transactionAmount
+        - transactionFeeAmount
+        - settlementAmount
+        - settlementFeeAmount
+        - feeDetails
+      properties:
+        transactionAmount:
+          $ref: '#/components/schemas/Amount'
+        transactionFeeAmount:
+          description: |
+            The fee amount applied by the network or acquirer in the merchant's currency.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        settlementAmount:
+          $ref: '#/components/schemas/Amount'
+        settlementFeeAmount:
+          description: |
+            The fee amount applied by the network or acquirer in the BIN currency.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        feeDetails:
+          type: array
+          description: |
+            Details about the transaction and settlement fee amounts.
+          items:
+            $ref: '#/components/schemas/Fee'
+
+    EncryptedKey:
+      type: object
+      additionalProperties: false
+      description: |
+        An encrypted data encryption key paired with a hashed version of the public key used to encrypt.
+      required:
+        - publicKeyHash
+        - encryptedDataEncryptionKey
+      properties:
+        publicKeyHash:
+          description: The public key used to encrypt the encryptedDataEncryptionKey hashed using checkdigit/hash.
+          type: string
+          format: uuid
+        encryptedDataEncryptionKey:
+          type: string
+          description: RSA encrypted random AES-256 key.
+
+    AddressVerificationData:
+      type: object
+      additionalProperties: false
+      description: |
+        Data supplied to be used by the Address Verification Service. 
+
+        Neither streetAddress, nor postalCode are required as only one may be supplied and there's no
+        guarantee as to which one.
+      properties:
+        streetAddress:
+          type: string
+          description: Street address supplied by the cardholder for verification.
+        postalCode:
+          type: string
+          description: Postal code supplied by the cardholder for verification.
+
+    ToleranceType:
+      type: string
+      description: The type of tolerance to be applied, if applicable.
+      enum:
+        - FIXED
+        - PERCENTAGE
+        - NONE
+
+    Tolerance:
+      type: object
+      additionalProperties: false
+      description: Minimum expected tolerance as defined by the network.
+      required:
+        - type
+      properties:
+        type:
+          $ref: '#/components/schemas/ToleranceType'
+        value:
+          type: string
+          description: The amount of the type of tolerance to be applied.
+
+    IssuerNetwork:
+      type: string
+      description: The network on which we received the message.
+      enum:
+        - MASTERCARD
+        - MDES
+        - MNGS
+        - STAR
+        - VISA
+
+    AcquirerNetwork:
+      type: string
+      description: The network on which the message was acquired.
+      enum:
+        - ALLPOINT
+        - CIRRUS
+        - DEBIT MASTERCARD
+        - CREDIT MASTERCARD
+        - DISCOVER
+        - INTERLINK
+        - MAESTRO
+        - OTHER
+        - PLUS
+        - PULSE
+        - STAR
+        - STAR POS
+        - VISA
+        - APPLE PAY
+        - GOOGLE PAY
+        - SAMSUNG PAY
+        - MDES FOR MERCHANTS
+        - CLICK TO PAY
+
+    ResponseCode:
+      type: string
+      description: The message processing result.
+      enum:
+        - APPROVED
+        - REFER TO ISSUER
+        - REFER TO ISSUER SPECIAL CONDITION
+        - INVALID MERCHANT
+        - PICKUP
+        - DO NOT HONOR
+        - SYSTEM ERROR
+        - PICKUP CARD SPECIAL CONDITION
+        - HONOR WITH ID
+        - REQUEST IN PROGRESS
+        - PARTIAL APPROVAL
+        - INVALID TRANSACTION
+        - INVALID AMOUNT
+        - CARD NOT FOUND
+        - REENTER TRANSACTION
+        - INVALID RESPONSE
+        - UNACCEPTABLE TRANSACTION FEE
+        - FILE UPDATE NOT SUPPORTED
+        - UNABLE TO LOCATE RECORD
+        - DUPLICATE FILE UPDATE
+        - FILE UPDATE EDIT ERROR
+        - FILE UPDATE FILE LOCKED
+        - FILE UPDATE FAILED
+        - FORMAT ERROR
+        - NO CREDIT ACCOUNT
+        - REQUESTED FUNCTION NOT SUPPORTED
+        - LOST CARD CAPTURE
+        - NO UNIVERSAL ACCOUNT
+        - STOLEN CARD CAPTURE
+        - NO INVESTMENT ACCOUNT
+        - INSUFFICIENT FUNDS
+        - NO CHECKING ACCOUNT
+        - NO SAVINGS ACCOUNT
+        - EXPIRED CARD
+        - INCORRECT PIN
+        - NO CARD RECORD
+        - TRANSACTION NOT PERMITTED TO CARDHOLDER
+        - TRANSACTION NOT PERMITTED TO TERMINAL
+        - SUSPECTED FRAUD
+        - EXCEEDS WITHDRAWAL LIMIT
+        - RESTRICTED CARD
+        - SECURITY VIOLATION
+        - EXCEEDS WITHDRAWAL FREQUENCY LIMIT
+        - HARD CAPTURE
+        - LATE RESPONSE
+        - PIN TRIES EXCEEDED
+        - KEY SYNC ERROR
+        - CARDHOLDER NOT ELIGIBLE FOR POS
+        - ISSUER NOT AVAILABLE
+        - DUPLICATE
+        - INFORMATION NOT ON FILE
+        - CARD VERIFICATION FAILURE
+        - CUTOFF IN PROGRESS
+        - ISSUER INOPERATIVE
+        - TRANSACTION CANNOT COMPLETE LAW VIOLATION
+        - DUPLICATE TRANSMISSION
+        - RECONCILE ERROR
+        - SYSTEM MALFUNCTION
+        - CARD VERIFICATION2 FAILURE
+        - CARD VERIFICATION3 FAILURE
+        - EXPIRATION DATE MISMATCH
+        - INACTIVE CARD
+        - ITEM SUSPECTED FOR STOP PAY
+        - ACCOUNT CLOSED
+        - INELIGIBLE ACCOUNT
+        - ITEM SUBMITTED MORE THAN TWO TIMES
+        - NO ACCT ON FILE
+        - UNABLE TO LOCATE
+        - GENERAL DENIAL
+        - SPECIAL CONDITIONS
+        - PIN REQUIRED
+        - PAN TRANSFORMATION ERROR
+        - RISK BLOCK
+        - INVALID ARQC
+        - REQUIRE ADDITIONAL AUTHENTICATION
+        - OTHER
+
+    AdviceResponse:
+      type: object
+      description: Additional information about the advice, reversal, or both.
+      additionalProperties: false
+      required:
+        - adviceOriginator
+        - adviceReason
+        - reversalOriginator
+        - reversalReason
+      properties:
+        adviceOriginator:
+          $ref: '#/components/schemas/Originator'
+        adviceReason:
+          $ref: '#/components/schemas/AdviceReason'
+        reversalOriginator:
+          $ref: '#/components/schemas/Originator'
+        reversalReason:
+          $ref: '#/components/schemas/ReversalReason'
+        authorizationIdResponse:
+          type: string
+          description: |
+            Used to identify the message being corrected. This corresponds to the authorizationIdResponse in the 
+            Response of the message being correcting.
+        responseCode:
+          $ref: '#/components/schemas/ResponseCode'
+
+    Originator:
+      type: string
+      description: The party that initiated the advice or reversal.
+      enum:
+        - NOT APPLICABLE
+        - CARD ACCEPTOR
+        - ACQUIRER
+        - INTERMEDIATE FACILITY
+        - CUSTOMER
+        - SWITCH
+        - UNKNOWN
+
+    AdviceReason:
+      type: string
+      description: THe reason for the advice according to the advice originator.
+      enum:
+        - NOT APPLICABLE
+        - NOT AN ADVICE
+        - TIMED OUT REQUEST
+        - ISSUER NOT AVAILABLE
+        - ISSUER SIGNED OFF
+        - WITHIN BUSINESS AGREEMENT
+        - KEY NOT ESTABLISHED
+        - ISSUER REQUESTED STANDIN
+        - OTHER
+        - UNKNOWN
+
+    ReversalReason:
+      type: string
+      description: The reason for the reversal according to the reversal originator.
+      enum:
+        - NOT APPLICABLE
+        - ISSUER NOT AVAILABLE
+        - ISSUER SIGNED OFF
+        - WITHIN BUSINESS AGREEMENT
+        - TERMINAL PROCESSOR ERROR
+        - SYSTEM TIMEOUT
+        - TERMINAL DISPENSE ERROR
+        - TERMINAL COMMUNICATION ERROR
+        - TERMINAL ERROR
+        - LATE RESPONSE
+        - CUSTOMER CANCELLATION
+        - SUSPECTED FRAUD
+        - CHIP
+        - PARTIAL
+        - EDIT ERROR
+        - REVISED HOLD AMOUNT
+        - UNKNOWN
+
+    AddressVerificationResult:
+      type: string
+      description: |
+        The result of the supplied addressVerificationData being checked against the Address Verification System.
+      enum:
+        - ADDRESS MATCH ONLY
+        - POSTAL CODE MATCH ONLY
+        - FULL POSTAL CODE MATCH ONLY
+        - ADDRESS AND POSTAL CODE MATCH
+        - ADDRESS AND FULL POSTAL CODE MATCH
+        - NO MATCH
+        - UNAVAILABLE
+        - NOT PROVIDED
+
+    ApplicationTransactionCounterValidationResult:
+      type: string
+      description: The result of validating the applicationTransactionCounter value found in the card's chip data.
+      enum:
+        - VALID
+        - OUT OF RANGE
+        - DUPLICATE
+        - NOT VALIDATED
+        - BYPASSED
+        - NOT PROVIDED
+
+    SuppliedCardExpirationDate:
+      type: string
+      pattern: '([0-9][0-9])(0[1-9]|1[0-2])'
+      description: |
+        Card expiration date either supplied manually, such as when entering card information into an online payment 
+        form, or found in the card's track 1 data. The date is assumed to be the last millisecond of the month. Format
+        is YYMM.
+      example: '9912'
+
+    TrackValidationResult:
+      type: string
+      description: |
+        The validity of the card's track data used in the transaction.
+
+        VALID - The track data is valid and matches the card.
+        INVALID - The track data format is invalid.
+        MISMATCH - The track data does not match the card.
+      enum:
+        - VALID
+        - INVALID
+        - MISMATCH
+        - NOT PROVIDED
+
+    PINValidationResult:
+      type: string
+      description: The validity of the supplied PIN.
+      enum:
+        - VALID
+        - INVALID
+        - INVALID KEY
+        - UNAVAILABLE
+        - NOT PROVIDED
+
+    VerificationValueResult:
+      type: string
+      description: The validity of the supplied verification value.
+      enum:
+        - VALID
+        - INVALID
+        - UNAVAILABLE
+        - NOT PROVIDED
+
+    ARQCValidationResult:
+      type: string
+      description: The validity of the supplied ARQC (Authorization Request Cryptogram).
+      enum:
+        - VALID
+        - INVALID
+        - UNAVAILABLE
+        - NOT PROVIDED
+
+    EMV3DSecureAuthenticationResult:
+      type: string
+      enum:
+        - AUTHENTICATED BY ISSUER
+        - AUTHENTICATED BY NETWORK
+        - UNAUTHENTICATED
+        - UNAVAILABLE
+        - UNKNOWN
+        - NOT PROVIDED
+
+    IIASData:
+      type: object
+      description: Data received from merchants using an IIAS (Inventory Information Approval System).
+
+        An IIAS is used by merchants to identify which items are eligible healthcare expenses under
+        FSA (Flexible Spending Account) or HSA (Health Savings Account) rules.
+      additionalProperties: false
+      required:
+        - merchantId
+        - verificationResult
+        - healthCareAmount
+        - prescriptionAmount
+        - visionAmount
+      properties:
+        merchantId:
+          type: string
+          description: |
+            IIAS specific merchant id which is different from the merchant name or card acceptor identification code.
+        verificationResult:
+          type: string
+          description: |
+            The merchant IIAS validation result.
+
+            Has the value 'UNVERIFIED' if the merchant did not perform an IIAS validation, the value 'VERIFIED' if the 
+            merchant did verify with IIAS and is valid, the value '90PERCENT' if the merchant is exempt, and the value
+            NONCERTIFIED if the merchant submitted IIAS data but was unable to validate their certification status.
+          enum:
+            - UNVERIFIED
+            - VERIFIED
+            - 90PERCENT
+            - NONCERTIFIED
+        healthCareAmount:
+          $ref: '#/components/schemas/Amount'
+        prescriptionAmount:
+          $ref: '#/components/schemas/Amount'
+        visionAmount:
+          $ref: '#/components/schemas/Amount'
+
+    Token:
+      required:
+        - tokenId
+        - status
+      properties:
+        tokenId:
+          type: string
+          maxLength: 64
+          description: Uniquely identifies the token.
+        status:
+          $ref: '#/components/schemas/TokenStatus'
+        tokenExpiration:
+          type: string
+          description: The date the token expires.
+          pattern: '([0-9][0-9])(0[1-9]|1[0-2])'
+          example: '9912'
+
+    TokenStatus:
+      type: string
+      description: |
+        The current status of token.
+
+        INACTIVE - Token has not yet been activated.
+        ACTIVE - Active and ready.
+        SUSPENDED - Suspended and unable to be used.
+        DEACTIVATED - Permanently deactivated.
+      enum:
+        - INACTIVE
+        - ACTIVE
+        - SUSPENDED
+        - DEACTIVATED
+        - UNKNOWN
+
+    TokenNotificationReasonCode:
+      type: string
+      description: |
+        The reason for the notification.
+
+        Tokens 'DELETED FROM CONSUMER APP' may still be active.
+      enum:
+        - STATUS UPDATE
+        - REDIGITIZATION COMPLETE
+        - DELETED FROM CONSUMER APP
+
+    TokenNotificationData:
+      description: |
+        The data provided in a token notification. The notification may apply to multiple
+        tokens.
+      properties:
+        tokens:
+          type: array
+          description: Tokens affected by the notification.
+          items:
+            $ref: '#/components/schemas/Token'
+        reasonCode:
+          $ref: '#/components/schemas/TokenNotificationReasonCode'
+        activationCodeExpirationDateTime:
+          type: string
+          format: date-time
+          description: The UTC datetime the activation code expires.
+        numberOfActivationAttempts:
+          type: number
+          description: |
+            The number of times an activationCode was sent in order to activate a token.
+        numberOfActiveTokens:
+          type: number
+          description: |
+            The number of active tokens.
+
+            The value might differ from the number of tokens listed in the 'tokens' property of the notification, as 
+            this represents all tokens not just the ones being updated. Tokens that have been deleted from the wallet 
+            are excluded from the count.
+        tokenAuthentication:
+          type: string
+          description: Indicates the given tokens have been authenticated.
+          enum:
+            - AUTHENTICATED
+            - NOT AUTHENTICATED
+            - NOT PROVIDED
+        tokenAssuranceLevel:
+          type: number
+          description: |
+            A number that allows the token issuer to indicate the confidence level of the token on whether it belongs 
+            to the cardholder it claims to be associated with. 
+
+            Will only be present if tokenAuthentication = AUTHENTICATED
+        suspiciousEvent:
+          description: The event for why the notification is being sent.
+          required:
+            - reason
+          properties:
+            reason:
+              type: string
+              description: |
+                The reason why a suspiciousEvent is provided.
+
+                REPLENISH - There were suspicious ATC values reporting during Replenish.
+              enum:
+                - REPLENISH
+                - OTHER
+              example: 'REPLENISH'
+
+    ActivationTextPhoneNumber:
+      required:
+        - type
+        - value
+      description: Denotes an activation method using the cardholder's mobile phone number. Value is masked.
+      properties:
+        type:
+          type: string
+          enum:
+            - TEXT
+        value:
+          type: string
+
+    ActivationEmailAccountHolder:
+      required:
+        - type
+        - value
+      description: Denotes an activation method using the cardholder's email address. Value is masked.
+      properties:
+        type:
+          type: string
+          enum:
+            - EMAIL
+        value:
+          type: string
+          minLength: 1
+          maxLength: 64
+
+    ActivationCallAutomatedNumber:
+      required:
+        - type
+        - value
+      description: |
+        Denotes an activation method requiring the cardholder to call to an automated call center phone number. 
+        Value will be the phone number for the cardholder to call.
+      properties:
+        type:
+          type: string
+          enum:
+            - AUTOMATED NUMBER
+        value:
+          type: string
+
+    ActivationCallCustomerSupport:
+      required:
+        - type
+        - value
+      description: |
+        Denotes an activation method requiring the cardholder to call to a customer support call center phone number. 
+        Value will be the phone number for the cardholder to call.
+      properties:
+        type:
+          type: string
+          enum:
+            - SUPPORT NUMBER
+        value:
+          type: string
+
+    ActivationVisitWebsite:
+      required:
+        - type
+        - value
+      description: |
+        Denotes an activation method requiring the cardholder to visit a website. 
+        Value will be a URL.
+      properties:
+        type:
+          type: string
+          enum:
+            - WEBSITE
+        value:
+          type: string
+          maxLength: 64
+
+    ActivationVisitMobileApp:
+      required:
+        - type
+        - value
+      description: |
+        Denotes an activation method requiring the cardholder to use a specific mobile app to activate token. 
+        Value will be replaced by a formatted string.
+      properties:
+        type:
+          type: string
+          enum:
+            - APP
+        value:
+          type: string
+          maxLength: 64
+
+    ActivationCallCardHolderNumber:
+      required:
+        - type
+        - value
+      description: |
+        Denotes an activation method using an issuer-initiated voice call to the cardholder's phone. 
+        Value will be the cardholder's masked phone number used for voice calls.
+      properties:
+        type:
+          type: string
+          enum:
+            - CARDHOLDER NUMBER
+        value:
+          type: string
+
+    ActivationMethod:
+      oneOf:
+        - $ref: '#/components/schemas/ActivationTextPhoneNumber'
+        - $ref: '#/components/schemas/ActivationEmailAccountHolder'
+        - $ref: '#/components/schemas/ActivationCallAutomatedNumber'
+        - $ref: '#/components/schemas/ActivationCallCustomerSupport'
+        - $ref: '#/components/schemas/ActivationVisitWebsite'
+        - $ref: '#/components/schemas/ActivationVisitMobileApp'
+        - $ref: '#/components/schemas/ActivationCallCardHolderNumber'
+
+    RecommendationReason:
+      type: string
+      description: The reason for the Wallet Provider's recommended decision.
+      enum:
+        - ACCOUNT TOO NEW SINCE LAUNCH
+        - ACCOUNT TOO NEW
+        - ACCOUNT CARD TOO NEW
+        - ACCOUNT RECENTLY CHANGED
+        - SUSPICIOUS ACTIVITY
+        - INACTIVE ACCOUNT
+        - HAS SUSPENDED TOKENS
+        - DEVICE RECENTLY LOST
+        - TOO MANY RECENT ATTEMPTS
+        - TOO MANY RECENT TOKENS
+        - TOO MANY DIFFERENT CARDHOLDERS
+        - LOW DEVICE SCORE
+        - LOW ACCOUNT SCORE
+        - OUTSIDE HOME TERRITORY
+        - UNABLE TO ASSESS
+        - HIGH RISK
+        - LOW PHONE NUMBER SCORE
+        - LONG ACCOUNT TENURE
+        - GOOD ACTIVITY HISTORY
+        - ADDITIONAL DEVICE
+        - SOFTWARE UPDATE
+        - OTHER
+      example: 'ACCOUNT TOO NEW'
+
+    RecommendedDecision:
+      type: string
+      description: The decision recommended by the Wallet Provider.
+      enum:
+        - APPROVED
+        - DECLINED
+        - REQUIRE ADDITIONAL AUTHENTICATION
+      example: 'APPROVED'
+
+    WalletProviderScore:
+      type: string
+      description: |
+        Score given by the Wallet Provider on their confidence level of a particular property.
+      enum:
+        - SCORE 1
+        - SCORE 2
+        - SCORE 3
+        - SCORE 4
+        - SCORE 5
+        - NOT PROVIDED
+      example: SCORE 4
+
+    WalletProviderDecisioning:
+      type: object
+      description: |
+        The scores and reasons leading to the recommended decision.
+      required:
+        - recommendedDecision
+        - deviceScore
+        - accountScore
+        - phoneNumberScore
+        - recommendationReasons
+      properties:
+        recommendedDecision:
+          $ref: '#/components/schemas/RecommendedDecision'
+        deviceScore:
+          $ref: '#/components/schemas/WalletProviderScore'
+        accountScore:
+          $ref: '#/components/schemas/WalletProviderScore'
+        phoneNumberScore:
+          $ref: '#/components/schemas/WalletProviderScore'
+        recommendationReasons:
+          type: array
+          description: Reasons provided to the Wallet Provider on how the recommended decision was reached.
+          minLength: 0
+          items:
+            $ref: '#/components/schemas/RecommendationReason'
+
+    TokenizationData:
+      description: Data relevant to the process of a tokenization.
+      properties:
+        activationCode:
+          type: string
+          minLength: 1
+          maxLength: 32
+          description: The Activation Code to be distributed for tokenization.
+        tokenId:
+          type: string
+          maxLength: 64
+          description: A unique id assigned by the party that initiated the tokenization.
+        tokenType:
+          type: string
+          description: The type of token requested for this tokenization.
+          enum:
+            - EMBEDDED SECURE ELEMENT
+            - CLOUD
+            - STATIC
+        tokenRequestorId:
+          type: string
+          minLength: 11
+          maxLength: 11
+          description: Identifier for the party that requested the tokenization.
+        activationMethod:
+          $ref: '#/components/schemas/ActivationMethod'
+        walletProviderDecisioning:
+          $ref: '#/components/schemas/WalletProviderDecisioning'
+
+    EMVChipData:
+      type: object
+      description: Data generated between the card's EMV chip and the terminal used in the transaction.
+      additionalProperties: false
+      required:
+        - applicationId
+        - applicationTransactionCounter
+        - amountAuthorized
+        - amountOther
+      properties:
+        applicationId:
+          description: Identifier for the application used between the terminal and chip for generating chip data.
+          type: string
+        applicationTransactionCounter:
+          description: Application Transaction Counter (ATC) generated by the chip.
+          type: string
+        amountAuthorized:
+          $ref: '#/components/schemas/Amount'
+        amountOther:
+          $ref: '#/components/schemas/Amount'
+
+    FeeType:
+      type: string
+      description: The type of fee being applied to the transaction.
+      enum:
+        - CONVENIENCE
+        - TRANSACTION
+        - CURRENCY CONVERSION ASSESSMENT
+        - ISSUER CURRENCY CONVERSION ASSESSMENT
+        - SURCHARGE
+        - OPTIONAL ISSUER
+        - PROCESSING
+        - FOREIGN EXCHANGE
+
+    FeeApplication:
+      type: string
+      description: |
+        Indicates whether the fee should be applied to a cardholder's account (SETTLE) or recorded for information
+        purposes only (MEMO). Examples of MEMO fees are currency conversion fees (already in the settlement amount) and
+        interchange fees.
+      enum:
+        - MEMO
+        - SETTLE
+
+    Fee:
+      type: object
+      description: Details about the fees applied to the transaction and settlement amounts.
+      additionalProperties: false
+      required:
+        - type
+        - application
+        - transaction
+        - settlement
+      properties:
+        type:
+          $ref: '#/components/schemas/FeeType'
+        application:
+          $ref: '#/components/schemas/FeeApplication'
+        transaction:
+          $ref: '#/components/schemas/Amount'
+        settlement:
+          $ref: '#/components/schemas/Amount'
+
+    File:
+      type: object
+      description: |
+        Information about the file in which the message exists.
+
+        This may be used to change the status of a card.
+      additionalProperties: false
+      required:
+        - fileIdentifier
+        - fileDescription
+        - recordIdentifier
+        - fileDateTime
+      properties:
+        fileIdentifier:
+          type: string
+          description: A unique identifier for the file in which this message exists. Often will be the name of the file.
+        fileDescription:
+          type: string
+          description: A description of the file whose usage depends on the type of file that was processed.
+        recordIdentifier:
+          type: string
+          description: A unique identifier for this message in the processed file. Often this will be the record number.
+        fileDateTime:
+          type: string
+          format: date-time
+          description: A timestamp associated with the whole file not the individual message.
+
+    TransmissionDateTime:
+      type: string
+      format: date-time
+      description: |
+        The UTC datetime the original ISO8583 message entered into the network's system. 
+        Time is set by the initiator of the message.
+
+    SystemTraceAuditNumber:
+      type: string
+      description: |
+        A numeric identifier assigned by the system that initiated the message to help identify the transaction.
+        This is usually set by the merchant's Point of Sale (POS) or acquiring bank's system and so is useful for 
+        relating messages within a batch or session. It is not globally unique.
+
+    TransactionId:
+      type: string
+      description: |
+        A unique identifier that relates messages to a single transaction as defined by the network.
+
+        Note: A return is considered a distinct transaction from the original purchase.
+
+    TransactionGroupId:
+      type: string
+      description: |
+        A unique identifier that relates transactions together. For example, a purchase and a return may
+        be grouped by this identifier.
+
+    NewRequest:
+      type: object
+      additionalProperties: false
+      required:
+        - messageId
+        - transactionId
+        - transactionGroupId
+        - cardId
+        - receivedDateTime
+        - categorization
+        - accounts
+        - transactionAmount
+        - transactionFeeAmount
+        - settlementAmount
+        - settlementFeeAmount
+        - settlementConversion
+        - cashBackAmount
+        - feeDetails
+        - transmissionDateTime
+        - systemTraceAuditNumber
+        - retrievalReferenceNumber
+        - settlementDate
+        - captureDate
+        - encryptedKeys
+        - merchant
+        - acquirer
+        - network
+        - acquirerNetwork
+        - incremental
+        - lastClearing
+        - recurring
+        - minimumTolerance
+        - suppliedCardExpirationDate
+        - track1ValidationResult
+        - track2ValidationResult
+        - pinValidationResult
+        - verificationValueValidationResult
+        - verificationValue2ValidationResult
+        - verificationValue3ValidationResult
+        - dynamicVerificationValueValidationResult
+        - arqcValidationResult
+        - emv3DSecureAuthenticationResult
+      description: The incoming message request data received from the network to be processed.
+      properties:
+        messageId:
+          $ref: '#/components/schemas/MessageId'
+        cardId:
+          $ref: '#/components/schemas/CardId'
+        tokenId:
+          $ref: '#/components/schemas/TokenId'
+        transactionId:
+          $ref: '#/components/schemas/TransactionId'
+        transactionGroupId:
+          $ref: '#/components/schemas/TransactionGroupId'
+        matchedMessageId:
+          $ref: '#/components/schemas/MatchedMessageId'
+        receivedDateTime:
+          $ref: '#/components/schemas/ReceivedDateTime'
+        categorization:
+          $ref: '#/components/schemas/Categorization'
+        accounts:
+          $ref: '#/components/schemas/Accounts'
+        transactionAmount:
+          $ref: '#/components/schemas/Amount'
+        transactionFeeAmount:
+          description: |
+            Fee amount applied by the network or acquirer in the merchant's currency.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        settlementAmount:
+          $ref: '#/components/schemas/Amount'
+        settlementFeeAmount:
+          description: |
+            Fee amount applied by the network or acquirer in the BIN currency.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        cashBackAmount:
+          $ref: '#/components/schemas/Amount'
+        feeDetails:
+          type: array
+          description: Details about the fees that went into the transaction and settlement fee amounts
+          items:
+            $ref: '#/components/schemas/Fee'
+        settlementConversion:
+          $ref: '#/components/schemas/SettlementConversion'
+        transmissionDateTime:
+          $ref: '#/components/schemas/TransmissionDateTime'
+        systemTraceAuditNumber:
+          $ref: '#/components/schemas/SystemTraceAuditNumber'
+        acquirerLifecycleId:
+          description: |
+            This value is defined by the acquirer to uniquely identify a transaction through its lifecycle.
+          type: string
+        retrievalReferenceNumber:
+          type: string
+        acquirerReferenceData:
+          description: |
+            This value is a numeric string of data supplied by the acquirer in an acquirer-originated message.
+          type: string
+        settlementDate:
+          type: string
+          description: |
+            The date the funds are expected to be transferred between issuer and acquirer. 
+
+            This is not guaranteed.
+          format: date
+          example: '2020-01-01'
+        captureDate:
+          type: string
+          description: |
+            The date the transaction was processed by the acquirer.
+          format: date
+          example: '2020-01-01'
+        encryptedKeys:
+          description: |
+            A list of encrypted data encryption keys.
+
+            All encrypted data in MessageRequest will be encrypted with same AES generated key.
+            The key will be encrypted with multiple public keys, one for each of the RSA key pairs that can decrypt it.
+          minLength: 0
+          type: array
+          items:
+            $ref: '#/components/schemas/EncryptedKey'
+        merchant:
+          $ref: '#/components/schemas/Merchant'
+        acquirer:
+          $ref: '#/components/schemas/Acquirer'
+        authorizationLifeCycle:
+          $ref: '#/components/schemas/AuthorizationLifeCycle'
+        replacementAmounts:
+          $ref: '#/components/schemas/ReplacementAmounts'
+        network:
+          $ref: '#/components/schemas/IssuerNetwork'
+        acquirerNetwork:
+          $ref: '#/components/schemas/AcquirerNetwork'
+        file:
+          $ref: '#/components/schemas/File'
+        addressVerificationData:
+          $ref: '#/components/schemas/AddressVerificationData'
+        incremental:
+          description: |
+            Indicator whether this has been identified by the acquirer as an
+            incremental authorization or not.
+          type: boolean
+        lastClearing:
+          description: |
+            Indicator whether this has been identified by the acquirer as
+            the last clearing in a sequence or not.
+          type: boolean
+        recurring:
+          description: |
+            Indicator whether this has been identified by the acquirer as a
+            recurring transaction or not.
+          type: boolean
+        iiasData:
+          $ref: '#/components/schemas/IIASData'
+        minimumTolerance:
+          $ref: '#/components/schemas/Tolerance'
+        tokenization:
+          $ref: '#/components/schemas/TokenizationData'
+        tokenNotification:
+          $ref: '#/components/schemas/TokenNotificationData'
+        emvChipData:
+          $ref: '#/components/schemas/EMVChipData'
+        emv3DSecureData:
+          $ref: '#/components/schemas/EMV3DSecureData'
+        adviceResponse:
+          $ref: '#/components/schemas/AdviceResponse'
+        suppliedCardExpirationDate:
+          $ref: '#/components/schemas/SuppliedCardExpirationDate'
+        track1ValidationResult:
+          $ref: '#/components/schemas/TrackValidationResult'
+        track2ValidationResult:
+          $ref: '#/components/schemas/TrackValidationResult'
+        pinValidationResult:
+          $ref: '#/components/schemas/PINValidationResult'
+        verificationValueValidationResult:
+          description: |
+            Corresponds to the CVC (Mastercard), CVV (Visa), or 5CSC (Amex) found in the track data and only supplied 
+            in card swipe transactions.
+          allOf:
+            - $ref: '#/components/schemas/VerificationValueResult'
+        verificationValue2ValidationResult:
+          description: |
+            Corresponds to the CVC2 (Mastercard), CVV2 (Visa), or 4CSC (Amex) found on the back of the card for 
+            Mastercard and Visa, and on the front of the card for Amex. 
+            It is most often supplied in online transactions.
+          allOf:
+            - $ref: '#/components/schemas/VerificationValueResult'
+        verificationValue3ValidationResult:
+          description: |
+            Corresponds to the 3CSC (Amex) found on the back of the card and is only used for Amex transactions.
+          allOf:
+            - $ref: '#/components/schemas/VerificationValueResult'
+        dynamicVerificationValueValidationResult:
+          $ref: '#/components/schemas/VerificationValueResult'
+        arqcValidationResult:
+          $ref: '#/components/schemas/ARQCValidationResult'
+        emv3DSecureAuthenticationResult:
+          $ref: '#/components/schemas/EMV3DSecureAuthenticationResult'
+
+    EMV3DSecureData:
+      description: |
+        EMV 3-D Secure is a messaging protocol that enables consumers to authenticate themselves with their card issuer
+        when making card-not-present (CNP) e-commerce purchases. The additional security layer helps prevent unauthorized CNP
+        transactions and protects the merchant from exposure to CNP fraud.
+      oneOf:
+        - $ref: '#/components/schemas/EMV3DSecureMastercard'
+
+    EMV3DSecureMastercard:
+      type: object
+      required:
+        - network
+        - securityProtocol
+        - cardholderAuthentication
+        - ucafCollectionIndicator
+        - programProtocolIndicator
+        - cardholderAuthenticationFormat
+      properties:
+        network:
+          type: string
+          description: |
+            This value indicates the network used for the transaction. This value also serves as the discriminator
+            for the EMV3DSecureData object.
+          enum:
+            - MASTERCARD
+        securityProtocol:
+          type: string
+          enum:
+            - CHANNEL
+            - UNKNOWN
+            - NOT PROVIDED
+        cardholderAuthentication:
+          type: string
+          enum:
+            - CARDHOLDER CERTIFICATE NOT USED
+            - MASTERPASS
+            - TOKENIZED
+            - UNKNOWN
+            - NOT PROVIDED
+        ucafCollectionIndicator:
+          type: string
+          description: |
+            This data describes the merchant support and issuer expectations 
+            regarding the Universal Cardholder Authentication Field (UCAF) and
+            whether Account Holder Authentication Value (AAV) data is present and authenticated.
+
+            - NOT SUPPORTED may either indicate the merchant is not an Identity Check merchant, or the merchant is not 
+              an Identity Check merchant but UCAF data is present within the authorization. Chargeback rights 
+              exist in both cases.
+            - UCAF MUST BE PRESENT indicates the merchant participates in Identity Check, but authentication was not 
+              completed. No chargeback rights exist for fraud.
+            - UCAF MUST BE PRESENT AND AAV AUTHENTICATED indicates the merchant participates in Identity Check and was
+              properly authenticated. No chargeback rights exist for fraud.
+            - AAV PRESENT indicates the merchant participates in a program that exempts the merchant from using 
+              Identity Check for certain low-risk transactions. Chargeback rights exist.
+            - ISSUER RISK BASED DECISIONING indicates the issuer has their own risk-based decisioning enabled to 
+              determine whether to authorize payment. No chargeback rights exist for fraud.
+            - MERCHANT RISK BASED DECISIONING indicates the merchant has their own risk-based decisioning enabled to 
+              determine whether to accept payment. Chargeback rights exist.
+            - PARTIAL SHIPMENT OR RECURRING PAYMENT indicates the merchant participates in Identity Check and was 
+              properly authenticated for a partial shipment or recurring payment. Refer to the UCAF or the 
+              original authorization to determine whether chargeback rights exist.
+
+          enum:
+            - NOT SUPPORTED
+            - UCAF MUST BE PRESENT
+            - UCAF MUST BE PRESENT AND AAV AUTHENTICATED
+            - AAV PRESENT
+            - ISSUER RISK BASED DECISIONING
+            - MERCHANT RISK BASED DECISIONING
+            - PARTIAL SHIPMENT OR RECURRING PAYMENT
+            - UNKNOWN
+            - NOT PROVIDED
+        programProtocolIndicator:
+          type: string
+          enum:
+            - EMV 3-D SECURE VERSION 2.1
+            - EMV 3-D SECURE VERSION 2.2
+            - EMV 3-D SECURE VERSION 2.3
+            - EMV 3-D SECURE VERSION 2.4
+            - EMV 3-D SECURE VERSION 2.5
+            - EMV 3-D SECURE VERSION 2.6
+            - EMV 3-D SECURE VERSION 2.7
+            - EMV 3-D SECURE VERSION 2.8
+            - EMV 3-D SECURE VERSION 2.9
+            - UNKNOWN
+            - NOT PROVIDED
+        cardholderAuthenticationFormat:
+          type: string
+          enum:
+            - SECURE CODE
+            - SECURE CODE FOR AAV
+            - UNKNOWN
+            - NOT PROVIDED
+        universalCardholderAuthenticationField:
+          type: string
+          description: |
+            The Universal Cardholder Authentication Field (UCAF) is a data element that is used to convey
+            cardholder authentication data from the merchant to the issuer.
+
+    MessageId:
+      description: |
+        Uniquely identifies a message stored in the platform.
+
+        A message's request and response are stored and retrieved separately using this identifier.
+      type: string
+
+    MatchedMessageId:
+      description: |
+        A previously processed message possibly related to this message as determined by the matching algorithm.
+      allOf:
+        - $ref: '#/components/schemas/MessageId'
+
+    CardId:
+      description: |
+        Uniquely identifies a payment card stored in the platform.
+      type: string
+
+    TokenId:
+      description: |
+        Uniquely identifies a token stored in the platform.
+
+        A token is a unique, secure replacement for a primary account number (PAN) used in digital payment transactions (e.g. transactions made using Apple Pay).
+      type: string
+
+    ReceivedDateTime:
+      type: string
+      format: date-time
+      description: The UTC datetime the message was received from the network by the platform.
+
+    CreatedOn:
+      type: string
+      format: date-time
+      description: The UTC datetime the message was created in the platform.
+
+    Request:
+      type: object
+      additionalProperties: false
+      required:
+        - messageId
+        - cardId
+        - transactionId
+        - transactionGroupId
+        - receivedDateTime
+        - categorization
+        - accounts
+        - transactionAmount
+        - transactionFeeAmount
+        - settlementAmount
+        - settlementFeeAmount
+        - settlementConversion
+        - cashBackAmount
+        - feeDetails
+        - transmissionDateTime
+        - systemTraceAuditNumber
+        - retrievalReferenceNumber
+        - settlementDate
+        - captureDate
+        - encryptedKeys
+        - merchant
+        - acquirer
+        - network
+        - acquirerNetwork
+        - incremental
+        - lastClearing
+        - recurring
+        - minimumTolerance
+        - track1ValidationResult
+        - track2ValidationResult
+        - pinValidationResult
+        - suppliedCardExpirationDate
+        - verificationValueValidationResult
+        - verificationValue2ValidationResult
+        - verificationValue3ValidationResult
+        - dynamicVerificationValueValidationResult
+        - arqcValidationResult
+        - emv3DSecureAuthenticationResult
+        - createdOn
+      description: The stored request data received from the network to be processed.
+      properties:
+        messageId:
+          $ref: '#/components/schemas/MessageId'
+        cardId:
+          $ref: '#/components/schemas/CardId'
+        tokenId:
+          $ref: '#/components/schemas/TokenId'
+        transactionId:
+          $ref: '#/components/schemas/TransactionId'
+        transactionGroupId:
+          $ref: '#/components/schemas/TransactionGroupId'
+        matchedMessageId:
+          $ref: '#/components/schemas/MatchedMessageId'
+        receivedDateTime:
+          $ref: '#/components/schemas/ReceivedDateTime'
+        categorization:
+          $ref: '#/components/schemas/Categorization'
+        accounts:
+          $ref: '#/components/schemas/Accounts'
+        transactionAmount:
+          $ref: '#/components/schemas/Amount'
+        transactionFeeAmount:
+          description: |
+            Fee amount applied by the network or acquirer in the merchant's currency.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        settlementAmount:
+          $ref: '#/components/schemas/Amount'
+        settlementFeeAmount:
+          description: |
+            Fee amount applied by the network or acquirer in the BIN currency.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        cashBackAmount:
+          $ref: '#/components/schemas/Amount'
+        feeDetails:
+          type: array
+          description: Details about the fees that went into the transaction and settlement fee amounts
+          items:
+            $ref: '#/components/schemas/Fee'
+        settlementConversion:
+          $ref: '#/components/schemas/SettlementConversion'
+        transmissionDateTime:
+          $ref: '#/components/schemas/TransmissionDateTime'
+        systemTraceAuditNumber:
+          $ref: '#/components/schemas/SystemTraceAuditNumber'
+        acquirerLifecycleId:
+          description: |
+            Defined by the acquirer to identify a transaction through its lifecycle.
+          type: string
+        retrievalReferenceNumber:
+          type: string
+          description: |
+            A numeric identifier typically generated by the acquirer to uniquely identify a transaction on a given day.
+        acquirerReferenceData:
+          description: |
+            This value is a numeric string of data supplied by the acquirer in an acquirer-originated message.
+          type: string
+        settlementDate:
+          type: string
+          description: |
+            The date the funds are expected to be transferred between issuer and acquirer. 
+
+            This is not guaranteed.
+          format: date
+          example: '2020-01-01'
+        captureDate:
+          type: string
+          description: |
+            The date the transaction was processed by the acquirer.
+          format: date
+          example: '2020-01-01'
+        encryptedKeys:
+          description: An array of encrypted AES keys that can be decrypted using the appropriate private key.
+          minLength: 0
+          type: array
+          items:
+            $ref: '#/components/schemas/EncryptedKey'
+        merchant:
+          $ref: '#/components/schemas/Merchant'
+        acquirer:
+          $ref: '#/components/schemas/Acquirer'
+        authorizationLifeCycle:
+          $ref: '#/components/schemas/AuthorizationLifeCycle'
+        replacementAmounts:
+          $ref: '#/components/schemas/ReplacementAmounts'
+        network:
+          $ref: '#/components/schemas/IssuerNetwork'
+        acquirerNetwork:
+          $ref: '#/components/schemas/AcquirerNetwork'
+        file:
+          $ref: '#/components/schemas/File'
+        addressVerificationData:
+          $ref: '#/components/schemas/AddressVerificationData'
+        incremental:
+          description: |
+            Has the value 'true' if the acquirer identified the authorization as an incremental, otherwise the value
+            is 'false'.
+          type: boolean
+        lastClearing:
+          description: |
+            Has the value 'true' if the acquirer identified the message as the last clearing in a sequence, otherwise
+            the value is 'false'.
+          type: boolean
+        recurring:
+          description: |
+            Has the value 'true' if the acquirer identified the message as part of a recurring transaction, otherwise
+            the value is 'false'.
+          type: boolean
+        iiasData:
+          $ref: '#/components/schemas/IIASData'
+        minimumTolerance:
+          $ref: '#/components/schemas/Tolerance'
+        tokenization:
+          $ref: '#/components/schemas/TokenizationData'
+        tokenNotification:
+          $ref: '#/components/schemas/TokenNotificationData'
+        emvChipData:
+          $ref: '#/components/schemas/EMVChipData'
+        emv3DSecureData:
+          $ref: '#/components/schemas/EMV3DSecureData'
+        adviceResponse:
+          $ref: '#/components/schemas/AdviceResponse'
+        suppliedCardExpirationDate:
+          $ref: '#/components/schemas/SuppliedCardExpirationDate'
+        track1ValidationResult:
+          $ref: '#/components/schemas/TrackValidationResult'
+        track2ValidationResult:
+          $ref: '#/components/schemas/TrackValidationResult'
+        pinValidationResult:
+          $ref: '#/components/schemas/PINValidationResult'
+        verificationValueValidationResult:
+          $ref: '#/components/schemas/VerificationValueResult'
+        verificationValue2ValidationResult:
+          $ref: '#/components/schemas/VerificationValueResult'
+        verificationValue3ValidationResult:
+          $ref: '#/components/schemas/VerificationValueResult'
+        dynamicVerificationValueValidationResult:
+          $ref: '#/components/schemas/VerificationValueResult'
+        arqcValidationResult:
+          $ref: '#/components/schemas/ARQCValidationResult'
+        emv3DSecureAuthenticationResult:
+          $ref: '#/components/schemas/EMV3DSecureAuthenticationResult'
+        createdOn:
+          $ref: '#/components/schemas/CreatedOn'
+
+    PickedRequest:
+      type: object
+      additionalProperties: false
+      description: |
+        A PickedRequest object contains a subset of fields from a Request object. 
+
+        A PickedRequest object may be preferred to minimize the amount of data retrieved and the time taken to 
+        transmit and process the response.
+      required:
+        - createdOn
+      properties:
+        cardId:
+          $ref: '#/components/schemas/CardId'
+        messageId:
+          $ref: '#/components/schemas/MessageId'
+        matchedMessageId:
+          $ref: '#/components/schemas/MatchedMessageId'
+        receivedDateTime:
+          $ref: '#/components/schemas/ReceivedDateTime'
+        categorization:
+          $ref: '#/components/schemas/Categorization'
+        settlementAmount:
+          $ref: '#/components/schemas/Amount'
+        adviceResponse:
+          $ref: '#/components/schemas/AdviceResponse'
+        createdOn:
+          $ref: '#/components/schemas/CreatedOn'
+
+    Tag:
+      type: object
+      additionalProperties: false
+      description: |
+        A Tag object contains categorizing information that can be used to classify a transaction and determine max
+        spend amounts for a given tag.
+      required:
+        - tag
+        - maxAmount
+      properties:
+        tag:
+          type: string
+          description: The tag name.
+        maxAmount:
+          type: string
+          description: Maximum amount that can be approved for the tag.
+
+    DeclineReasonsEnum:
+      type: string
+      description: The reason for the decline.
+      enum:
+        - TRANSACTION CATEGORY NOT ALLOWED
+        - INTERNATIONAL TRANSACTIONS NOT ALLOWED
+        - RESTRICTED COUNTRY
+        - RESTRICTED MERCHANT TYPE
+        - RESTRICTED MERCHANT
+        - INVALID PIN
+        - PIN BLOCK ERROR
+        - PIN VALIDATION UNAVAILABLE
+        - INVALID VERIFICATION VALUE
+        - INVALID VERIFICATION VALUE2
+        - INVALID VERIFICATION VALUE3
+        - INVALID DYNAMIC VERIFICATION VALUE
+        - INVALID ATC
+        - INVALID ARQC
+        - NO CVN SUPPLIED
+        - VERIFICATION VALUE VALIDATION UNAVAILABLE
+        - VERIFICATION VALUE2 VALIDATION UNAVAILABLE
+        - VERIFICATION VALUE3 VALIDATION UNAVAILABLE
+        - DYNAMIC VERIFICATION VALUE VALIDATION UNAVAILABLE
+        - ARQC VALIDATION UNAVAILABLE
+        - CARD NOT FOUND
+        - CARD NOT CURRENT
+        - EXPIRED CARD
+        - BLOCKED CARD
+        - LOCKED CARD
+        - INACTIVE CARD
+        - INVALID CARD DATA
+        - UNSUPPORTED OPERATION
+        - INSUFFICIENT FUNDS
+        - AMOUNT LIMIT EXCEEDED
+        - COUNT LIMIT EXCEEDED
+        - MINIMUM AMOUNT REQUIRED
+        - PIN RETRY LIMIT EXCEEDED
+        - BUSINESS RULES
+        - SUSPECTED FRAUD
+        - INVALID ACCOUNT SELECTED
+        - INVALID MESSAGE DATA
+        - STOP RECURRING
+        - GENERAL DECLINE
+        - INCORRECT ACTIVATION CODE
+        - INCORRECT ACTIVATION CODE RETRIES EXCEEDED
+        - EXPIRED ACTIVATION CODE
+        - REQUIRE ADDITIONAL AUTHENTICATION
+        - WALLET RECOMMENDED DECLINE
+        - INTERNAL SERVICE ERROR
+        - TRANSIENT RETRYABLE ERROR
+        - CONFIGURATION LOCK
+
+    HoldExpirationDateTime:
+      type: string
+      description: The UTC datetime the hold on funds will expire.
+      format: date-time
+
+    ProprietaryAuxiliaryData:
+      type: object
+      description: An object containing client specific data.
+
+    AccountUsage:
+      type: object
+      additionalProperties: false
+      required:
+        - accountId
+        - debitCredit
+        - amount
+      properties:
+        accountId:
+          type: string
+          description: Uniquely identifies the account to which the amount and debit or credit were applied.
+        debitCredit:
+          $ref: '#/components/schemas/DebitCredit'
+        amount:
+          type: string
+
+    CurrencyAlphabeticCode:
+      type: string
+      description: |
+        The alphabetic code that represents the currency.
+      enum:
+        - AED
+        - AFN
+        - ALL
+        - AMD
+        - ANG
+        - AOA
+        - ARS
+        - AUD
+        - AWG
+        - AZN
+        - BAM
+        - BBD
+        - BDT
+        - BGN
+        - BHD
+        - BIF
+        - BMD
+        - BND
+        - BOB
+        - BOV
+        - BRL
+        - BSD
+        - BTN
+        - BWP
+        - BYN
+        - BZD
+        - CAD
+        - CDF
+        - CHE
+        - CHF
+        - CHW
+        - CLF
+        - CLP
+        - CNY
+        - COP
+        - COU
+        - CRC
+        - CUC
+        - CUP
+        - CVE
+        - CZK
+        - DJF
+        - DKK
+        - DOP
+        - DZD
+        - EGP
+        - ERN
+        - ETB
+        - EUR
+        - FJD
+        - FKP
+        - GBP
+        - GEL
+        - GHS
+        - GIP
+        - GMD
+        - GNF
+        - GTQ
+        - GYD
+        - HKD
+        - HNL
+        - HRK
+        - HTG
+        - HUF
+        - IDR
+        - ILS
+        - INR
+        - IQD
+        - IRR
+        - ISK
+        - JMD
+        - JOD
+        - JPY
+        - KES
+        - KGS
+        - KHR
+        - KMF
+        - KPW
+        - KRW
+        - KWD
+        - KYD
+        - KZT
+        - LAK
+        - LBP
+        - LKR
+        - LRD
+        - LSL
+        - LYD
+        - MAD
+        - MDL
+        - MGA
+        - MKD
+        - MMK
+        - MNT
+        - MOP
+        - MRU
+        - MUR
+        - MVR
+        - MWK
+        - MXN
+        - MXV
+        - MYR
+        - MZN
+        - NAD
+        - NGN
+        - NIO
+        - NOK
+        - NPR
+        - NZD
+        - OMR
+        - PAB
+        - PEN
+        - PGK
+        - PHP
+        - PKR
+        - PLN
+        - PYG
+        - QAR
+        - RON
+        - RSD
+        - RUB
+        - RWF
+        - SAR
+        - SBD
+        - SCR
+        - SDG
+        - SEK
+        - SGD
+        - SHP
+        - SLL
+        - SOS
+        - SRD
+        - SSP
+        - STN
+        - SVC
+        - SYP
+        - SZL
+        - THB
+        - TJS
+        - TMT
+        - TND
+        - TOP
+        - TRY
+        - TTD
+        - TWD
+        - TZS
+        - UAH
+        - UGX
+        - USD
+        - USN
+        - UYI
+        - UYU
+        - UYW
+        - UZS
+        - VES
+        - VND
+        - VUV
+        - WST
+        - XAF
+        - XAG
+        - XAU
+        - XBA
+        - XBB
+        - XBC
+        - XBD
+        - XCD
+        - XDR
+        - XOF
+        - XPD
+        - XPF
+        - XPT
+        - XSU
+        - XTS
+        - XUA
+        - XXX
+        - YER
+        - ZAR
+        - ZMW
+        - ZWL
+
+    Rate:
+      type: object
+      description: |
+        The currency conversion rate information.
+          
+        To calculate the conversion rate, use the following formula:
+
+            conversion rate = factor / (10 ^ factorDecimalPosition)
+      additionalProperties: false
+      required:
+        - factor
+        - factorDecimalPosition
+        - effectiveOn
+      properties:
+        factor:
+          description: |
+            The multiplying factor used to convert the transaction amount to the settlement
+            amount.
+          type: string
+        factorDecimalPosition:
+          description: |
+            The position the decimal point should be placed, starting from the right.
+          type: number
+          minimum: 0
+          maximum: 15
+        effectiveOn:
+          type: string
+          description: The UTC datetime the conversion rate went into effect.
+          format: date-time
+
+    AdditionalCurrencyConversionRate:
+      type: object
+      description: |
+        Contains the conversion rate from the settlement currency to a target currency that was in effect when processing this message.
+        The value can be obtained in one of four ways and will be represented by the conversionSource field.
+      additionalProperties: false
+      required:
+        - rate
+        - conversionSource
+        - targetCurrency
+      properties:
+        rate:
+          $ref: '#/components/schemas/Rate'
+        conversionSource:
+          type: string
+          description: |
+            - NONE
+              - The target currency matches the settlement currency.
+              - The rate will be 1.0
+              - example scenario: Settlement Currency = USD, Target Currency = USD, Transaction Currency = EUR
+            - NETWORK
+              - The target currency matches the message's transaction currency.
+              - The rate will be the inverse of the settlementConversion data provided by the network.
+              - example scenario: Settlement Currency = USD, Target Currency = EUR, Transaction Currency = EUR
+            - INTERNAL
+              - The target currency does not match the settlement or transaction currency and a settlement to target currency conversion rate is defined within the Rate service at the time of the transaction.
+              - The rate will be the settlement to target currency rate retrieved from the rate service at the time of the transaction.
+              - example scenario: Settlement Currency = USD, Target Currency = EUR, Transaction Currency = GBP, Rate from USD -> EUR is defined within the Rate service at the time of the transaction
+            - NOT FOUND
+              - The target currency does not match the settlement or transaction currency and no settlement to target currency rate is defined within the Rate service at the time of the transaction.
+              - The rate will be 0.0
+              - example scenario: Settlement Currency = USD, Target Currency = EUR, Transaction Currency = GBP, Rate from USD -> EUR is NOT defined within the Rate service at the time of the transaction
+            - NOT APPLICABLE
+              - The incoming message's settlement amount is 0
+              - The rate will be 0.0
+              - example scenarios: tokenization messages, balance inquiries, 0 value transactions
+          enum:
+            - NONE
+            - NETWORK
+            - INTERNAL
+            - NOT FOUND
+            - NOT APPLICABLE
+        targetCurrency:
+          $ref: '#/components/schemas/CurrencyAlphabeticCode'
+
+    DeclineReasons:
+      type: array
+      description: |
+        Reason the authorization was declined. These are internal reasons that are more detailed than what is
+        provided to the network.
+
+      items:
+        $ref: '#/components/schemas/DeclineReasonsEnum'
+
+    NewResponse:
+      type: object
+      description: The outgoing message response data to be sent back to the network.
+      additionalProperties: false
+      required:
+        - messageId
+        - cardId
+        - responseCode
+        - declineReasons
+        - capture
+        - requestedAmount
+        - requestedTolerance
+        - requestedFee
+        - requestedTotal
+        - requestedCashBack
+        - messageApprovedAmount
+        - messageApprovedTolerance
+        - messageApprovedFee
+        - messageApprovedTotal
+        - approvedAmount
+        - approvedTolerance
+        - approvedFee
+        - approvedTotal
+        - approvedCashBack
+        - pendingAmount
+        - pendingTolerance
+        - pendingFee
+        - pendingTotal
+        - completedAmount
+        - completedTolerance
+        - completedFee
+        - completedTotal
+        - pendingAccounts
+        - completedAccounts
+        - tags
+        - addressVerificationResult
+        - applicationTransactionCounterValidationResult
+        - processedBy
+      properties:
+        messageId:
+          $ref: '#/components/schemas/MessageId'
+        cardId:
+          $ref: '#/components/schemas/CardId'
+        authorizationIdResponse:
+          type: string
+          description: |
+            An identifier generated by the authorizing party used to help identify
+            the authorization. This is often provided to the cardholder on their transaction receipt.
+        responseCode:
+          $ref: '#/components/schemas/ResponseCode'
+        declineReasons:
+          $ref: '#/components/schemas/DeclineReasons'
+        capture:
+          type: boolean
+          description: |
+            Has the value 'true' if the card should be captured by the merchant and the merchant states they are
+            capable of capturing the card. Otherwise, the value is false.
+        requestedAmount:
+          $ref: '#/components/schemas/Amount'
+        requestedTolerance:
+          $ref: '#/components/schemas/Amount'
+        requestedFee:
+          description: |
+            Fee amount applied by the processor. This value does not include fees applied by
+            the network or acquirer. Those fees are included in requestedAmount and approvedAmount.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        requestedTotal:
+          $ref: '#/components/schemas/Amount'
+        requestedCashBack:
+          $ref: '#/components/schemas/Amount'
+        messageApprovedAmount:
+          $ref: '#/components/schemas/Amount'
+        messageApprovedTolerance:
+          $ref: '#/components/schemas/Amount'
+        messageApprovedFee:
+          $ref: '#/components/schemas/Amount'
+        messageApprovedTotal:
+          $ref: '#/components/schemas/Amount'
+        approvedAmount:
+          $ref: '#/components/schemas/Amount'
+        approvedTolerance:
+          $ref: '#/components/schemas/Amount'
+        approvedFee:
+          description: |
+            Fee amount applied by the processor. This value does not include fees applied by
+            the network or acquirer. Those fees are included in requestedAmount and approvedAmount.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        approvedTotal:
+          $ref: '#/components/schemas/Amount'
+        approvedCashBack:
+          $ref: '#/components/schemas/Amount'
+        pendingAmount:
+          $ref: '#/components/schemas/Amount'
+        pendingTolerance:
+          $ref: '#/components/schemas/Amount'
+        pendingFee:
+          $ref: '#/components/schemas/Amount'
+        pendingTotal:
+          $ref: '#/components/schemas/Amount'
+        completedAmount:
+          $ref: '#/components/schemas/Amount'
+        completedTolerance:
+          $ref: '#/components/schemas/Amount'
+        completedFee:
+          $ref: '#/components/schemas/Amount'
+        completedTotal:
+          $ref: '#/components/schemas/Amount'
+        availableBalance:
+          $ref: '#/components/schemas/Amount'
+        addressVerificationResult:
+          $ref: '#/components/schemas/AddressVerificationResult'
+        applicationTransactionCounterValidationResult:
+          $ref: '#/components/schemas/ApplicationTransactionCounterValidationResult'
+        entryId:
+          type: string
+          minLength: 1
+        pendingAccounts:
+          type: array
+          description: Accounts where there are still funds pending
+          items:
+            $ref: '#/components/schemas/AccountUsage'
+        completedAccounts:
+          type: array
+          description: Accounts where the funds have completed
+          items:
+            $ref: '#/components/schemas/AccountUsage'
+        holdExpirationDateTime:
+          $ref: '#/components/schemas/HoldExpirationDateTime'
+        tags:
+          type: array
+          description: A list of Tag objects.
+          items:
+            $ref: '#/components/schemas/Tag'
+        tokenization:
+          type: object
+          properties:
+            activationMethods:
+              type: array
+              minLength: 0
+              description: |
+                The activation methods to be used for this tokenization. Returning an empty array will mean 
+                that no additional activation methods are required to tokenize, with the except of any pre-configured 
+                with the party responsible for initializing the tokenization.
+              items:
+                $ref: '#/components/schemas/ActivationMethod'
+        processedBy:
+          type: string
+          description: The name of the service that provided the approval or decline.
+        proprietaryAuxiliaryData:
+          $ref: '#/components/schemas/ProprietaryAuxiliaryData'
+        additionalCurrencyConversionRates:
+          type: array
+          minLength: 0
+          description: Additional currency conversion rates used to convert the settlement currency to another currency.
+          items:
+            $ref: '#/components/schemas/AdditionalCurrencyConversionRate'
+
+    Response:
+      type: object
+      description: The stored response data to be sent back to the network.
+      additionalProperties: false
+      required:
+        - messageId
+        - cardId
+        - responseCode
+        - declineReasons
+        - capture
+        - requestedAmount
+        - requestedTolerance
+        - requestedFee
+        - requestedTotal
+        - requestedCashBack
+        - messageApprovedAmount
+        - messageApprovedTolerance
+        - messageApprovedFee
+        - messageApprovedTotal
+        - approvedAmount
+        - approvedTolerance
+        - approvedFee
+        - approvedTotal
+        - approvedCashBack
+        - pendingAmount
+        - pendingTolerance
+        - pendingFee
+        - pendingTotal
+        - completedAmount
+        - completedTolerance
+        - completedFee
+        - completedTotal
+        - pendingAccounts
+        - completedAccounts
+        - tags
+        - addressVerificationResult
+        - applicationTransactionCounterValidationResult
+        - processedBy
+        - createdOn
+      properties:
+        messageId:
+          $ref: '#/components/schemas/MessageId'
+        cardId:
+          $ref: '#/components/schemas/CardId'
+        authorizationIdResponse:
+          type: string
+          description: |
+            An identifier generated by the authorizing party - i.e. the Check Digit platform - used to help identify
+            the authorization.
+        responseCode:
+          $ref: '#/components/schemas/ResponseCode'
+        declineReasons:
+          $ref: '#/components/schemas/DeclineReasons'
+        capture:
+          type: boolean
+          description: |
+            Has the value 'true' if the card should be captured by the merchant. Otherwise, the value is false.
+        requestedAmount:
+          $ref: '#/components/schemas/Amount'
+        requestedTolerance:
+          $ref: '#/components/schemas/Amount'
+        requestedFee:
+          description: |
+            Fee amount applied by the processor. This value does not include fees applied by
+            the network or acquirer. Those fees are included in requestedAmount and approvedAmount.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        requestedTotal:
+          $ref: '#/components/schemas/Amount'
+        requestedCashBack:
+          $ref: '#/components/schemas/Amount'
+        messageApprovedAmount:
+          $ref: '#/components/schemas/Amount'
+        messageApprovedTolerance:
+          $ref: '#/components/schemas/Amount'
+        messageApprovedFee:
+          $ref: '#/components/schemas/Amount'
+        messageApprovedTotal:
+          $ref: '#/components/schemas/Amount'
+        approvedAmount:
+          $ref: '#/components/schemas/Amount'
+        approvedTolerance:
+          $ref: '#/components/schemas/Amount'
+        approvedFee:
+          description: |
+            Fee amount applied by the processor. This value does not include fees applied by
+            the network or acquirer. Those fees are included in requestedAmount and approvedAmount.
+          allOf:
+            - $ref: '#/components/schemas/Amount'
+        approvedTotal:
+          $ref: '#/components/schemas/Amount'
+        approvedCashBack:
+          $ref: '#/components/schemas/Amount'
+        pendingAmount:
+          $ref: '#/components/schemas/Amount'
+        pendingTolerance:
+          $ref: '#/components/schemas/Amount'
+        pendingFee:
+          $ref: '#/components/schemas/Amount'
+        pendingTotal:
+          $ref: '#/components/schemas/Amount'
+        completedAmount:
+          $ref: '#/components/schemas/Amount'
+        completedTolerance:
+          $ref: '#/components/schemas/Amount'
+        completedFee:
+          $ref: '#/components/schemas/Amount'
+        completedTotal:
+          $ref: '#/components/schemas/Amount'
+        availableBalance:
+          $ref: '#/components/schemas/Amount'
+        addressVerificationResult:
+          $ref: '#/components/schemas/AddressVerificationResult'
+        applicationTransactionCounterValidationResult:
+          $ref: '#/components/schemas/ApplicationTransactionCounterValidationResult'
+        entryId:
+          type: string
+          description: |
+            The unique identifier for the ledger entry created during processing.
+        pendingAccounts:
+          type: array
+          description: A list of AccountUsage objects for accounts where funds are pending.
+          items:
+            $ref: '#/components/schemas/AccountUsage'
+        completedAccounts:
+          type: array
+          description: A list of AccountUsage objects for accounts where funds have completed.
+          items:
+            $ref: '#/components/schemas/AccountUsage'
+        holdExpirationDateTime:
+          $ref: '#/components/schemas/HoldExpirationDateTime'
+        tags:
+          type: array
+          description: A list of Tag objects.
+          items:
+            $ref: '#/components/schemas/Tag'
+        tokenization:
+          type: object
+          properties:
+            activationMethods:
+              type: array
+              minLength: 0
+              description: |
+                The activation methods to be used for this tokenization.
+
+                Returning an empty array will mean that no additional activation methods are required to tokenize, with 
+                the exception of any pre-configured methods with the party responsible for initializing the 
+                tokenization.
+              items:
+                $ref: '#/components/schemas/ActivationMethod'
+        processedBy:
+          type: string
+          description: The name of the service that provided the approval or decline.
+        createdOn:
+          $ref: '#/components/schemas/CreatedOn'
+        proprietaryAuxiliaryData:
+          $ref: '#/components/schemas/ProprietaryAuxiliaryData'
+        additionalCurrencyConversionRates:
+          type: array
+          minLength: 0
+          description: Additional currency conversion rates used to convert the settlement currency to another currency.
+          items:
+            $ref: '#/components/schemas/AdditionalCurrencyConversionRate'
+
+    PickedResponse:
+      type: object
+      additionalProperties: false
+      description: |
+        A PickedResponse object contains a subset of fields from a Response object. 
+        A PickedResponse object may be preferred to minimize the amount of data retrieved and the time taken to 
+        transmit and process the response.
+      required:
+        - createdOn
+      properties:
+        messageId:
+          $ref: '#/components/schemas/MessageId'
+        declineReasons:
+          $ref: '#/components/schemas/DeclineReasons'
+        approvedTotal:
+          $ref: '#/components/schemas/Amount'
+        holdExpirationDateTime:
+          $ref: '#/components/schemas/HoldExpirationDateTime'
+        createdOn:
+          $ref: '#/components/schemas/CreatedOn'
+        proprietaryAuxiliaryData:
+          $ref: '#/components/schemas/ProprietaryAuxiliaryData'
+        additionalCurrencyConversionRates:
+          type: array
+          minLength: 0
+          description: Additional currency conversion rates used to convert the settlement currency to another currency.
+          items:
+            $ref: '#/components/schemas/AdditionalCurrencyConversionRate'
+
+    RequestField:
+      type: string
+      description: The message request fields to return.
+      enum:
+        - CARD_ID
+        - ADVICE_RESPONSE
+        - CATEGORIZATION
+        - MATCHED_MESSAGE_ID
+        - MESSAGE_ID
+        - RECEIVED_DATE_TIME
+        - SETTLEMENT_AMOUNT
+
+    ResponseField:
+      type: string
+      description: The message response fields to return.
+      enum:
+        - APPROVED_TOTAL
+        - DECLINE_REASONS
+        - HOLD_EXPIRATION_DATE_TIME
+        - MESSAGE_ID
+        - PROPRIETARY_AUXILIARY_DATA
+        - ADDITIONAL_CURRENCY_CONVERSION_RATES
+
+  parameters:
+    messageId:
+      in: path
+      name: messageId
+      required: true
+      schema:
+        $ref: '#/components/schemas/MessageId'
+
+    at:
+      in: query
+      name: at
+      description: |
+        Identifies at what point in time the data should be returned. Must not
+        be in the future.
+      required: true
+      schema:
+        type: string
+        format: date-time
+
+    cardIds:
+      in: query
+      name: cardIds
+      description: Returns messages created by these cardIds.
+      required: true
+      schema:
+        type: array
+        minItems: 1
+        items:
+          $ref: '#/components/schemas/CardId'
+
+    toDate:
+      in: query
+      name: toDate
+      description: |
+        Returns entries created before this time. Must be at least 1 second in
+        the past.
+      required: true
+      schema:
+        type: string
+        format: date-time
+
+    fromDate:
+      in: query
+      name: fromDate
+      description: |
+        Returns entries created at or after this time. Must be at least 1 second
+        in the past.
+      schema:
+        type: string
+        format: date-time
+
+    createdOn:
+      name: Created-On
+      in: header
+      description: Sets the created-on timestamp for the newly created record.
+      required: true
+      schema:
+        type: string
+        format: date-time
+
+    responseFields:
+      in: query
+      name: fields
+      description: Returns the requested fields in the PickedResponse object.
+      required: true
+      schema:
+        type: array
+        minItems: 1
+        items:
+          $ref: '#/components/schemas/ResponseField'
+
+    requestFields:
+      in: query
+      name: fields
+      description: Returns the requested fields in the PickedRequest object.
+      required: true
+      schema:
+        type: array
+        minItems: 1
+        items:
+          $ref: '#/components/schemas/RequestField'
+
+  responses:
+    Ping:
+      description: Operation successful.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Ping'
+
+    ServerError:
+      description: Operation unsuccessful.
+      content:
+        application/json:
+          schema:
+            $ref: '#/components/schemas/Error'
+  headers:
+    Created-On:
+      description: The created-on timestamp for the record.
+      required: true
+      schema:
+        type: string
+        format: date-time
+
+    Updated-On:
+      description: The updated-on timestamp for the existing record.
+      required: true
+      schema:
+        type: string
+        format: date-time