openapi: 3.2.0
info:
  description: Public API of Diebold Nixdorf for Banking Core Systems integration
  version: 4.3.0
  title: DN Open Backend Authorization Processing API
  contact:
    name: Thorsten Brinkmann
    email: Thorsten.Brinkmann@dieboldnixdorf.com
  termsOfService: /terms-of-use
servers:
- url: https://localhost:8080/OB-API-REST/v2
security:
- basic: []
- bearer: []
tags:
- name: Authorization Processing API
paths:
  /login:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Performs a login
      tags:
      - Authorization Processing API
      operationId: login
      description: 'Posts details of the login step of an ATM transaction.


        This indicates the start of consumer session at the ATM.

        The host needs to note the login of a consumer and provide the following information

        - list of enabled transactions

        - information on accounts linked to the card'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/login.request'
            examples:
              LoginRequest:
                $ref: '#/components/examples/LoginRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/login.response'
              examples:
                LoginResponse:
                  $ref: '#/components/examples/LoginResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /logout:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Performs a logout
      tags:
      - Authorization Processing API
      operationId: logout
      description: 'Posts details of the logout step of an ATM transaction.


        Host needs to note the logoff of current consumer session at the ATM.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/logout.request'
            examples:
              LogoutRequest:
                $ref: '#/components/examples/LogoutRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n  "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logout.response'
              examples:
                LogoutResponse:
                  $ref: '#/components/examples/LogoutResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /cassCounterChanged:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Lists changes to cassette counters
      tags:
      - Authorization Processing API
      operationId: cassCounterChanged
      description: 'Posts details of the changes in different cassette counter devices.

        Includes information like the reason for the change, the type of change, the devices that have changed with their changed values.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cassCounterChanged.request'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n  "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cassCounterChanged.response'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /pinChangeAuthorize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Authorizes a pin change operation
      tags:
      - Authorization Processing API
      operationId: pinChangeAuthorize
      description: Posts details of the authorization of a pinchange operation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pinChange.authorize.Request'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n  "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below\n  "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pinChange.authorize.response'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /pinChangeFinalize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finalizes a pin change operation
      tags:
      - Authorization Processing API
      operationId: pinChangeFinalize
      description: 'Posts details of the finalization of a pinchange operation as per the accountingState.


        If the accountingState is OK, the transaction is successful. Else, a reversal is triggered.


        The host must perform reversal of the pin change operation in case of failure and ensure that the previous pin is recoverable.

        The previous pin must be restored.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pinChange.finalize.request'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n  "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pinchange.finalize.response'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /withdrawalAuthorize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Authorizes a withdrawal transaction
      tags:
      - Authorization Processing API
      operationId: withdrawalAuthorize
      description: 'Posts details of the authorization of a withdrawal transaction. The host must authenticate and authorize the transaction and do necessary operation on the presented amount.

        Note: All amounts present in the request must be treated individually and they are exclusive of transaction fees. Fees, if present have to be additionally added to transaction amount while operating on account.


        Key scenarios associated with a withdrawal authorize transaction:


        - withdrawal without fee/FCC/DCC - There is no fee, FCC or DCC involved. The host must debit the specified amount from the specified account


        - withdrawal with fee - If fee is applicable and if confirmation is required (fees.type - DIRECT_ACQUIRER_FEE) from the consumer, a resubmit response is sent by the host in the first withdrawalAuthorize response. The consumer accepts/declines the fee in the subsequent withdrawalAuthorize request and the host processes the request considering the fee with the requested amount. If a fee is applicable but consumer confirmation is not required (fees.type - INDIRECT_ACQUIRER_FEE), the host must debit the fee and the specified amount without sending resubmit response.


        - withdrawal with FCC (Foreign Currency Conversion) - If FCC is available and a confirmation is required (foreignCurrencyConversion.fccState - CONFIRM_REQUIRED ) from the consumer, a resubmit response is sent by the host in the first withdrawalAuthorize response. The consumer accepts/declines the FCC in the subsequent withdrawalAuthorize request and the host processes the request. If FCC is available but consumer confirmation is not required (fccState - CONF_NOT_REQUIRED ) , the host must debit the specified amount in base currency without sending resubmit response.


        - withdrawal with DCC (Dynamic Currency Conversion) - If DCC is available, a confirmation is required (dynamicCurrencyConversion.mode - DCC_CURRENCY_AVAILABLE) from the consumer and, a resubmit response is sent by the host in the first withdrawalAuthorize response. The consumer accepts/declines the DCC in the subsequent withdrawalAuthorize request and the host processes the request as per the consumers response


        - withdrawal with a combination of fee/FCC/DCC - If fee, FCC and DCC are available in a combination (extendedResponse.code - MULTI_CONFIRM_REQUIRED), a resubmit response is sent by the host in the first withdrawalAuthorize response. The consumer accepts/declines the fee, FCC and/or DCC in the subsequent withdrawalAuthorize request and the host processes the request'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/withdrawal.authorize.request'
            examples:
              WithdrawalAuthorizeRequestWithoutFee:
                $ref: '#/components/examples/WithdrawalAuthorizeRequestWithoutFee'
              WithdrawalAuthorizeRequestWithFeeConfirmed:
                $ref: '#/components/examples/WithdrawalAuthorizeRequestWithFeeConfirmed'
              WithdrawalAuthorizeRequestWithFCC:
                $ref: '#/components/examples/WithdrawalAuthorizeRequestWithFCC'
              WithdrawalAuthorizeRequestWithFCCAccepted:
                $ref: '#/components/examples/WithdrawalAuthorizeRequestWithFCCAccepted'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/withdrawal.authorize.response'
              examples:
                WithdrawalAuthorizeResponseWithoutFee:
                  $ref: '#/components/examples/WithdrawalAuthorizeResponseWithoutFee'
                WithdrawalAuthorizeResponseWithFee:
                  $ref: '#/components/examples/WithdrawalAuthorizeResponseWithFee'
                WithdrawalAuthorizeResponseWithFCCConfirmRequired:
                  $ref: '#/components/examples/WithdrawalAuthorizeResponseWithFCCConfirmRequired'
                WithdrawalAuthorizeResponseWithFCCConfirmNotRequired:
                  $ref: '#/components/examples/WithdrawalAuthorizeResponseWithFCCConfirmNotRequired'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /withdrawalFinalize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finalizes a withdrawal transaction
      tags:
      - Authorization Processing API
      operationId: withdrawalFinalize
      description: 'Posts details of the finalization of a withdrawal transaction as per the accountingState.


        If the accountingState is OK, the transaction is successful. Else, a reversal is triggered.


        The host must perform reversal operations on all the accounts where operations were performed in the authorize step.


        The ''amount'' attribute represents the dispensed amount. In case of a partial dispense, the host must perform a reversal of the undispensed amount.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/withdrawal.finalize.request'
            examples:
              WithdrawalFinalizeRequest:
                $ref: '#/components/examples/WithdrawalFinalizeRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/withdrawal.finalize.response'
              examples:
                WithdrawalFinalizeResponse:
                  $ref: '#/components/examples/WithdrawalFinalizeResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /transferAuthorize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Authorizes a transfer transaction
      tags:
      - Authorization Processing API
      operationId: transferAuthorize
      description: 'Posts details of the authorization of a transfer transaction. The host must authenticate and authorize the transaction and do necessary operation on the presented amount.


        Key scenarios associated with a transfer authorize transaction:


        - transfer without fee/FCC - There is no fee or FCC involved. The host must transfer the specified amount from the source account to the target account


        - transfer with fee - If fee is applicable and a confirmation is required from the consumer, a resubmit response is sent by the host in the first transferAuthorize response. The consumer accepts/declines the fee in the subsequent transferAuthorize request and the host processes the request considering the fee with the requested amount. If a fee is applicable but consumer confirmation is not required, the host must debit the fee and the specified amount from the source account


        - transfer with FCC (Foreign Currency Conversion) - If FCC is available and a confirmation is required from the consumer, a resubmit response is sent by the host in the first transferAuthorize response. The consumer accepts/declines the FCC in the subsequent transferAuthorize request and the host processes the request. If FCC is available but consumer confirmation is not required, the host must transfer the specified amount in base currency


        - transfer with a combination of fee/FCC - If fee and FCC are available in a combination, a resubmit response is sent by the host in the first transferAuthorize response. The consumer accepts/declines the fee, FCC in the subsequent transferAuthorize request and the host processes the request'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transfer.authorize.request'
            examples:
              TransferAuthorizeRequestWithoutFee:
                $ref: '#/components/examples/TransferAuthorizeRequestWithoutFee'
              TransferAuthorizeRequestWithFee:
                $ref: '#/components/examples/TransferAuthorizeRequestWithFee'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transfer.authorize.response'
              examples:
                TransferAuthorizeResponseWithoutFee:
                  $ref: '#/components/examples/TransferAuthorizeResponseWithoutFee'
                TransferAuthorizeResponseWithFee:
                  $ref: '#/components/examples/TransferAuthorizeResponseWithFee'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /transferFinalize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finalizes a transfer transaction
      tags:
      - Authorization Processing API
      operationId: transferFinalize
      description: 'Posts details of the finalization of a transfer transaction as per the accountingState.


        If the accountingState is OK, the transaction is successful. Else, a reversal is triggered.


        The host must perform reversal operations on all the accounts where operations were performed in the authorize step.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/transfer.finalize.request'
            examples:
              TransferFinalizeRequest:
                $ref: '#/components/examples/TransferFinalizeRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n                  "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transfer.finalize.response'
              examples:
                TransferFinalizeResponse:
                  $ref: '#/components/examples/TransferFinalizeResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /depositAuthorize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Authorizes a deposit transaction
      tags:
      - Authorization Processing API
      operationId: depositAuthorize
      description: 'Posts details of the authorization of a deposit transaction. The host must authenticate the transaction and do necessary operation on the presented amount.


        Key scenarios associated with a deposit authorize transaction:


        - deposit - the specified amount is deposited only into the single account specified in the targetAccount property.


        - split deposit - the overall amount is split and deposited into multiple accounts as specified in the splitDeposit property.


        The host must specify the cash and check limits (limits per transaction, if any) in the response.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deposit.authorize.request'
            examples:
              DepositAuthorizeRequest:
                $ref: '#/components/examples/DepositAuthorizeRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deposit.authorize.response'
              examples:
                DepositAuthorizeResponse:
                  $ref: '#/components/examples/DepositAuthorizeResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /depositValidate:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Validates a deposit transaction
      tags:
      - Authorization Processing API
      operationId: depositValidate
      description: 'Posts details of the validations of a deposit transaction.


        The host must validate the details of the check/s and proceess valid check/s.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deposit.validate.request'
            examples:
              DepositValidateRequestWithFCCCurrency:
                $ref: '#/components/examples/DepositValidateRequestWithFCCCurrency'
              DepositValidateRequest:
                $ref: '#/components/examples/DepositValidateRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deposit.validate.response'
              examples:
                DepositValidateResponseWithFCCConfirmNotRequired:
                  $ref: '#/components/examples/DepositValidateResponseWithFCCConfirmNotRequired'
                DepositValidateResponseWithFCCConfirmRequired:
                  $ref: '#/components/examples/DepositValidateResponseWithFCCConfirmRequired'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /depositFinishValidation:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finishes the validation of a deposit transaction
      tags:
      - Authorization Processing API
      operationId: depositFinishValidation
      description: 'Posts details of the finished validations of a deposit transaction.


        The host must validate that there are sufficient funds to perform the transaction by considering the validated amount and the fees.

        If the validated amount is less than the fee amount, the host must fail the transaction with INSUFFICIENT_FUNDS.

        If the validated amount is missing, the host must fail the transaction with REQUEST_DATA_INVALID.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deposit.finishValidation.request'
            examples:
              DepositFinishValidationRequestWithFeeAccepted:
                $ref: '#/components/examples/DepositFinishValidationRequestWithFeeAccepted'
              DepositFinishValidationRequestWithoutFee:
                $ref: '#/components/examples/DepositFinishValidationRequestWithoutFee'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n     "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deposit.finishValidation.response'
              examples:
                DepositFinishValidationResponseWithFee:
                  $ref: '#/components/examples/DepositFinishValidationResponseWithFee'
                DepositFinishValidationResponseWithoutFee:
                  $ref: '#/components/examples/DepositFinishValidationResponseWithoutFee'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /depositProcessClearing:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Processes the clearing of a deposit transaction
      tags:
      - Authorization Processing API
      operationId: depositProcessClearing
      description: 'Posts details of the clearings processed in a deposit transaction. The host must authorize the transaction and do necessary operation on the presented amount.


        The host must operate on the accounts involved.

        - The fee (if applicable) must be credited in to the fee account.

        - For a deposit transaction :

        - the remaining validatedAmount must be credited into the specified account.

        - the check amounts must be debited from the check accounts and credited into the specified account.

        - For a split deposit transaction :

        - the specified amounts must be credited into the specified accounts.


        In case of a check deposit transaction, the check amount must be held till the checks are cleared by the clearing house.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deposit.processClearing.request'
            examples:
              DepositProcessClearingRequest:
                $ref: '#/components/examples/DepositProcessClearingRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below "
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deposit.processClearing.response'
              examples:
                DepositProcessClearingResponse:
                  $ref: '#/components/examples/DepositProcessClearingResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /depositFinalize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finalizes a deposit transaction
      tags:
      - Authorization Processing API
      operationId: depositFinalize
      description: 'Posts details of the finalization of a deposit transaction as per the accountingState


        If the accountingState is OK, the transaction is successful. Else, a reversal is triggered.


        The host must perform reversal operations on all the accounts where operations were performed in the processClearing step.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/deposit.finalize.request'
            examples:
              DepositFinalizeRequest:
                $ref: '#/components/examples/DepositFinalizeRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deposit.finalize.response'
              examples:
                DepositFinalizeResponse:
                  $ref: '#/components/examples/DepositFinalizeResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /mixedMediaPaymentAuthorize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Authorizes a mixed media payment transaction
      tags:
      - Authorization Processing API
      operationId: mixedMediaPaymentAuthorize
      description: 'Posts details of the authorization of a mixed media payment transaction. The host must authenticate the transaction and do necessary operation on the presented amount.


        Key scenarios associated with a mixed media payment authorize transaction revolve around payments of different types. Below fields specify the details.


        - paymentType - the type of payment being performed e.g. loan, credit-card, bill etc.

        - paymentSubType - the subtype of the payment e.g. principal payment, payoff etc.


        The host must specify the cash and check limits (as applicable) in the response'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mmp.authorize.request'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n\n  "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mmp.authorize.response'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /mixedMediaPaymentValidate:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Validates a mixed media payment transaction
      tags:
      - Authorization Processing API
      operationId: mixedMediaPaymentValidate
      description: 'Posts details of the validations of a mixed media payment transaction.


        The host must validate that:

        - for a check-only transaction, the inserted check is valid. If not, fail the transaction with REQUEST_DATA_INVALID.

        - for a cash-only transaction, the inserted cash is greater than zero. If not, fail the transaction with REQUEST_DATA_INVALID.

        - for a cash-and-check transaction, the inserted check is valid and the inserted cash is greater than zero. If not, fail the transaction with REQUEST_DATA_INVALID.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mmp.validate.request'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mmp.validate.response'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /mixedMediaPaymentFinishValidation:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finishes the validation a mixed media payment transaction
      tags:
      - Authorization Processing API
      operationId: mixedMediaPaymentFinishValidation
      description: 'Posts details of the finished validations of a mixed media payment transaction.


        The host must validate that there are sufficient funds to perform the payment by considering the validatedAmount and the fee amount. If not, the host must fail the transaction with INSUFFICIENT_FUNDS.

        If the validatedAmount is missing, the host must fail the transaction with REQUEST_DATA_INVALID.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mmp.finishvalidation.request'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n          "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mmp.finishvalidation.response'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /mixedMediaPaymentProcessClearing:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Processes the clearing of a mixed media payment transaction
      tags:
      - Authorization Processing API
      operationId: mixedMediaPaymentProcessClearing
      description: 'Posts details of the clearings processed in a mixed media payment transaction. The host must authorize the transaction and do necessary operation on the presented amount.


        The host must operate on the accounts involved.

        - The fee (if applicable) must be credited in to the fee account.

        - The check amounts must be debited from the check accounts and credited into the ''targetAccount''.

        - The cash amount must be credited into the payment account specified in the ''targetAccount''.

        - The creditAmount/ debitAmount (if available) must be credited/debited into/from the ''account''.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mmp.processclearing.request'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mmp.processclearing.response'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /mixedMediaPaymentFinalizeCashOut:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finalizes the cashout of a mixed media payment transaction
      tags:
      - Authorization Processing API
      operationId: mixedMediaPaymentFinalizeCashOut
      description: 'Posts details of the cashout finalized in a mixed media payment transaction

        **This API is invoked only if the dispensedAmount is non-zero**'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mmp.finalizecashout.request'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mmp.finalizecashout.response'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /mixedMediaPaymentFinalize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finalizes a mixed media payment transaction
      tags:
      - Authorization Processing API
      operationId: mixedMediaPaymentFinalize
      description: 'Posts details of the finalization of a mixed media payment transaction.


        If the accountingState is OK, the transaction is successful. Else, a reversal is triggered.


        The host must perform reversal operations on all the accounts where operations were performed in the processClearing step.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/mmp.finalize.request'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mmp.finalize.response'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /checkCashingAuthorize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Authorizes a check cashing transaction
      tags:
      - Authorization Processing API
      operationId: checkCashingAuthorize
      description: Posts details of the authorization of a check cashing transaction. The host must authenticate the transaction and do necessary operation on the presented amount.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/checkcashing.authorize.request'
            examples:
              CheckCashingAuthorizeRequest:
                $ref: '#/components/examples/CheckCashingAuthorizeRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n      "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkcashing.authorize.response'
              examples:
                CheckCashingAuthorizeResponse:
                  $ref: '#/components/examples/CheckCashingAuthorizeResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /checkCashingValidate:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Validates a check cashing transaction
      tags:
      - Authorization Processing API
      operationId: checkCashingValidate
      description: 'Posts details of the validations of a check cashing transaction.


        The host must validate the details of the check/s and proceess valid check/s.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/checkcashing.validate.request'
            examples:
              CheckCashingValidateChecksRequest:
                $ref: '#/components/examples/CheckCashingValidateChecksRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkcashing.validate.response'
              examples:
                CheckCashingValidateChecksResponse:
                  $ref: '#/components/examples/CheckCashingValidateChecksResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /checkCashingFinishValidation:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finishes the validation of a check cashing transaction
      tags:
      - Authorization Processing API
      operationId: checkCashingFinishValidation
      description: 'Posts details of the finished validations of a check cashing transaction.


        The host must validate that there are sufficient funds to perform the transaction by considering the validated amount and the fees. If the validated amount is less than the fee amount, the host must fail the transaction with INSUFFICIENT_FUNDS. If the validated amount is missing, the host must fail the transaction with REQUEST_DATA_INVALID.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/checkcashing.finishvalidation.request'
            examples:
              CheckCashingFinishValidationRequest:
                $ref: '#/components/examples/CheckCashingFinishValidationRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkcashing.finishvalidation.response'
              examples:
                CheckCashingFinishValidationResponse:
                  $ref: '#/components/examples/CheckCashingFinishValidationResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /checkCashingProcessClearing:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Processes the clearing of a check cashing transaction
      tags:
      - Authorization Processing API
      operationId: checkCashingProcessClearing
      description: 'Posts details of the clearings processed in a check cashing transaction. The host must authorize the transaction and do necessary operation on the presented amount.


        The host must operate on the accounts involved.


        The check amounts must be debited from the check accounts.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/checkcashing.processclearing.request'
            examples:
              CheckCashingProcessClearingRequest:
                $ref: '#/components/examples/CheckCashingProcessClearingRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkcashing.processclearing.response'
              examples:
                CheckCashingProcessClearingResponse:
                  $ref: '#/components/examples/CheckCashingProcessClearingResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /checkCashingAuthorizeCashOut:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Authorizes the cashout of a check cashing transaction
      tags:
      - Authorization Processing API
      operationId: checkCashingAuthorizeCashOut
      description: 'Posts details of the cashout authorized in a check cashing transaction.


        The host must perform the following operations.

        - Credit the fee amount into the fee account

        - Calculate the ''creditAmount'' as ''check amount - requestedAmount - fee amount'' and credit it into ''account'''
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/checkcashing.authorizecashout.request'
            examples:
              CheckCashingAuthorizeCashOutRequest:
                $ref: '#/components/examples/CheckCashingAuthorizeCashOutRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkcashing.authorizecashout.response'
              examples:
                CheckCashingAuthorizeCashOutResponse:
                  $ref: '#/components/examples/CheckCashingAuthorizeCashOutResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /checkCashingFinalizeCashOut:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finalizes the cashout of a check cashing transaction
      tags:
      - Authorization Processing API
      operationId: checkCashingFinalizeCashOut
      description: 'Posts details of the cashout finalized in a check cashing transaction.


        If a reversal is triggered, the host must perform reversal operations on all the accounts where operations were performed in the processClearing and authorizeCashOut steps.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/checkcashing.finalizecashout.request'
            examples:
              CheckCashingFinalizeCashOutRequest:
                $ref: '#/components/examples/CheckCashingFinalizeCashOutRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkcashing.finalizecashout.response'
              examples:
                CheckCashingFinalizeCashOutResponse:
                  $ref: '#/components/examples/CheckCashingFinalizeCashOutResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /checkCashingFinalize:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Finalizes a check cashing transaction
      tags:
      - Authorization Processing API
      operationId: checkCashingFinalize
      description: Posts details of the finalization of a check cashing transaction
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/checkcashing.finalize.request'
            examples:
              CheckCashingFinalizeRequest:
                $ref: '#/components/examples/CheckCashingFinalizeRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/checkcashing.finalize.response'
              examples:
                CheckCashingFinalizeResponse:
                  $ref: '#/components/examples/CheckCashingFinalizeResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /currencyExchangeRates:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Retrieves the exchange rates for a given pair of currencies
      tags:
      - Authorization Processing API
      operationId: currencyExchangeRates
      description: 'Posts details of the exchange rates retrieved for the given pair of currencies.


        The host responds with:

        - ''exchangeRateDefs'' if exchange rates are available for the requested currencies

        - ''notSupportedCurrencyExchangeRates'' if exchange rates are not available for the requested currencies'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/currencyExchangeRates.request'
            examples:
              CurrencyExchangeRatesRequestSupportedCurrencies:
                $ref: '#/components/examples/CurrencyExchangeRatesRequestSupportedCurrencies'
              CurrencyExchangeRatesRequestNotSupportedCurrencies:
                $ref: '#/components/examples/CurrencyExchangeRatesRequestNotSupportedCurrencies'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/currencyExchangeRates.response'
              examples:
                CurrencyExchangeRatesResponseSupportedCurrencies:
                  $ref: '#/components/examples/CurrencyExchangeRatesResponseSupportedCurrencies'
                CurrencyExchangeRatesResponseNotSupportedCurrencies:
                  $ref: '#/components/examples/CurrencyExchangeRatesResponseNotSupportedCurrencies'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /addCash:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Adds details of cash added to the transaction
      tags:
      - Authorization Processing API
      operationId: addCash
      description: 'Posts details of the cash added to the transaction.


        This is applicable to deposit, mixedMediaPayent or checkCashing transactions.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/addCash.request'
            examples:
              AddCashRequest:
                $ref: '#/components/examples/AddCashRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below\n         "
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addCash.response'
              examples:
                AddCashResponse:
                  $ref: '#/components/examples/AddCashResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /addCheck:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Adds details of the check added to the transaction
      tags:
      - Authorization Processing API
      operationId: addCheck
      description: 'Posts details of the check added to the transaction.


        The host must validate if the inserted check is valid and fit for further processing.


        This is applicable to deposit, mixedMediaPayent or checkCashing transactions.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/addCheck.request'
            examples:
              AddCheckRequest:
                $ref: '#/components/examples/AddCheckRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/addCheck.response'
              examples:
                AddCheckResponse:
                  $ref: '#/components/examples/AddCheckResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
  /updateChecks:
    post:
      parameters:
      - $ref: '#/components/parameters/version'
      - $ref: '#/components/parameters/initiatingPartyId'
      - $ref: '#/components/parameters/productName'
      - $ref: '#/components/parameters/initiatingPartyName'
      - $ref: '#/components/parameters/timestamp'
      - $ref: '#/components/parameters/referenceId'
      - $ref: '#/components/parameters/authorization'
      summary: Updates details of the check added to the transaction
      tags:
      - Authorization Processing API
      operationId: updateChecks
      description: 'Posts details of updates made to the check added previously to the transaction.


        This is applicable to deposit, mixedMediaPayent or checkCashing transactions.'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/updateChecks.request'
            examples:
              UpdateChecksRequest:
                $ref: '#/components/examples/UpdateChecksRequest'
        description: "If payload encryption scheme is used, Request body will follow schema __EnvelopeRequest__. <br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n    {\n      \"envelope\": {\n        \"keyId\" : \"6K7FNu88LpwYucaZYJkb5snOYZkrruZhgGzq8OfmOE0\",\n        \"requestor\": \"Alpha.Farm.Cluster.TXMServer01\",\n        \"payload\": \"BB20WIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPLDE+\"\n      }\n    }\n\nIf payload encryption scheme is not used, Request body will follow schema as mentioned below"
      responses:
        '200':
          description: "If payload encryption scheme is used, Response body will follow schema __EnvelopeResponse__.<br>Encryption algorithm: ECIES as in IEEE P 1363a<br><br> __Example Value:__<br>\n\n      {\n        \"envelope\": {\n            \"keyId\" : \"7PFu8nPcrnSqJk-cXnX2XOkksxWJp0imi1PWUs74i38\",\n            \"payload\": \"WWabWIJRTz/T9vkGhETgpehzc6dDoioQ9DJV4lRA6ICaWwLPQRs+\"\n          }\n      } \nIf payload encryption scheme is not used, Response body will follow schema as mentioned below"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/updateChecks.response'
              examples:
                UpdateChecksResponse:
                  $ref: '#/components/examples/UpdateChecksResponse'
        '400':
          description: Invalid input fields, object invalid
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '500':
          description: Error while performing operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '401':
          description: Unauthorized access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
        '403':
          description: Forbidden access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceResponse'
              examples:
                ServiceResponseFailExample:
                  $ref: '#/components/examples/ServiceResponseFailExample'
components:
  schemas:
    mmp.finalize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            checkAmount:
              $ref: '#/components/schemas/CheckAmount'
            cashInAmount:
              $ref: '#/components/schemas/CashInAmount'
            debitAmount:
              $ref: '#/components/schemas/DebitAmount'
            creditAmount:
              $ref: '#/components/schemas/CreditAmount'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            itemMixUsed:
              type: array
              description: List of used check and/or cash items
              items:
                $ref: '#/components/schemas/CassCounter'
            itemMixTotal:
              type: array
              description: List of total check and/or cash items
              items:
                $ref: '#/components/schemas/CassCounter'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            mediaStates:
              $ref: '#/components/schemas/MediaStates'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    CheckAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The check amount of the transaction
    deposit.finishValidation.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              fees:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionFee'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    Credit:
      type: object
      description: Credit amounts to be represnted in amounts as CREDIT_LIMIT, AVAILABLE_CREDIT, LAST_CHARGE_DUE, INTEREST_PAID_YEAR_TO_DATE, INTEREST_PAID_PREVIOUS_YEAR_TO_DATE, INTEREST_AMOUNT, MINIMUM_AMOUNT_DUE, REWARD_BALANCE, LAST_STATEMENT_BALANCE
      properties:
        interestRate:
          type: number
          format: double
          description: Interest rate for this account
          example: 2.34
    CheckImage:
      type: object
      required:
      - image
      description: Check Image
      properties:
        image:
          type: string
          description: Base 64 Image
        imageType:
          $ref: '#/components/schemas/ImageType'
    checkcashing.validate.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            transactionId:
              $ref: '#/components/schemas/TransactionId'
            targetAccount:
              $ref: '#/components/schemas/TargetAccount'
            cashBackAmount:
              $ref: '#/components/schemas/CashBackAmount'
            checkAmount:
              $ref: '#/components/schemas/CheckAmount'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetails'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    mmp.finishvalidation.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            validatedAmount:
              $ref: '#/components/schemas/ValidatedAmount'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetails'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            mediaStates:
              $ref: '#/components/schemas/MediaStates'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    CancelReason:
      type: string
      description: Reason for cancellation
      example: HARDWARE_ERROR
      enum:
      - UNDEFINED
      - TIME_OUT
      - CONSUMER_CANCEL
      - HARDWARE_ERROR
      - COMMUNICATION_ERROR
      - NOT_AUTHORIZED
      - DOOR_OPENED
      - LIMIT_EXCEEDED
      - WORKSTATION_CLOSED
      - CHIP_ERROR
      - MESSAGE_INVALID
      - HSM_STATE_INVALID
      - CARD_READ_ERROR
      - SERVER_ERROR
      - CLIENT_ERROR
      - APPLICATION_CANCEL
      - COUNTERFEIT_LIMIT_EXCEEDED
    pinchange.finalize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    CashBackAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The amount to be encashed from the check
    ClientTransactionTime:
      type: string
      description: 'In Local Timezone <br> For ''selfService'' channel, the local time the transaction takes place. <br><br>

        For ''network'' channel, data element DE12 - the local time the transaction takes place at the card acceptor location.'
      example: '164052'
    CheckValidationTransactionId:
      type: string
      description: Identifier for check validation
      example: '808123458'
    HostSumAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The amount set by the host system if some checks are denied and the total amount is decreased by this decision
    ValidateResponseCheck:
      type: object
      allOf:
      - $ref: '#/components/schemas/ProcessClearingResponseCheck'
      - type: object
        properties:
          checkActionCode:
            type: string
            description: Action to be taken post the check recognition
            enum:
            - NONE
            - CORRECT
            - VERIFY_IMAGE
            - SUSPECTED_DUPLICATE
            - REMOVE
            example: NONE
          suspectedFraud:
            type: boolean
            description: True if check is suspected as fraud.
          payableAmount:
            $ref: '#/components/schemas/PayableAmount'
          validatedAmount:
            $ref: '#/components/schemas/ValidatedAmount'
          rejectedBy:
            $ref: '#/components/schemas/RejectedBy'
          deleted:
            $ref: '#/components/schemas/Deleted'
    CheckDetails:
      type: object
      required:
      - id
      description: Details of checks
      properties:
        id:
          type: string
          description: Unique identifier of the check record maintained by the client. This value needs to be mirrored and returned by the host while passing details for this same check in the response
          example: 7892480d0a1948099c71beffa823ed0e
        hostId:
          type: string
          description: Transaction identifier provided by the check processing system after validation
          example: 442347823ebfad58676644aaaa432323
        transactionId:
          $ref: '#/components/schemas/TransactionId'
        checkActionCode:
          type: string
          description: Action to be taken post the check recognition
          enum:
          - NONE
          - CORRECT
          - VERIFY_IMAGE
          - SUSPECTED_DUPLICATE
          - REMOVE
          example: NONE
        deleted:
          $ref: '#/components/schemas/Deleted'
        suspectedFraud:
          type: boolean
          description: Flag to indicate if the check is suspected to be a fraud
          example: false
        micrReadIntegrity:
          type: string
          enum:
          - GOOD
          - PARTIAL
          - BAD
          description: Defines the integrity of the MICR which is read
          example: GOOD
        micr:
          type: string
          description: Contains the MICR (Magnetic Ink Character Recognition) as raw string as scanned and recognized from the check
          example: '*192307*T06300277T41442*'
        routingTransitNumber:
          type: string
          description: Identifies the bank on which the document is drawn. For instance, in the US this is the Routing and Transit number, and in the UK it is the Sort Code
          example: '063100277'
        mediaState:
          $ref: '#/components/schemas/MediaState'
        printData:
          type: string
          description: The string that must be printed on the back of the check
          example: Dated July 17th, 2020
        date:
          type: string
          description: Creation date-time, or date-time of last update for this record
          format: yyyy-MM-dd'T'HH:mm:ssZ
          example: 2024-06-01T16:40:52+0000
        score:
          type: integer
          description: Score of the Optical Character recognition (OCR)
          example: 0
        accountNumber:
          type: string
          description: Identifies the account on which the check is drawn
          example: A0123456789
        checkNumber:
          type: string
          description: Check number as provided by MICR line
          example: '123456'
        courtesyAmount:
          $ref: '#/components/schemas/CourtesyAmount'
        micrAmount:
          $ref: '#/components/schemas/MICRAmount'
        payableAmount:
          $ref: '#/components/schemas/PayableAmount'
        userAmount:
          $ref: '#/components/schemas/UserAmount'
        validatedAmount:
          $ref: '#/components/schemas/ValidatedAmount'
        documentSequenceNumber:
          type: integer
          description: The document sequence number. Order number of the entered checks
          example: 1
        rejectedBy:
          $ref: '#/components/schemas/RejectedBy'
        externalProcessingCode:
          type: string
          description: Processing Code read from the MICR line. (a.k.a. Transaction Code (UK), Trancode (AU))
          example: '4'
        checkType:
          $ref: '#/components/schemas/CheckType'
        checkState:
          $ref: '#/components/schemas/CheckState'
    TransactionResponse:
      type: object
      allOf:
      - $ref: '#/components/schemas/TransactionWithStandin'
      description: Exact replica of the request 'transaction' object which must be returned by the host
    Address:
      type: object
      properties:
        street:
          type: string
          description: The name of the street.
          example: Mainstreet
        streetno:
          type: string
          description: The street number of this address.
          example: '119'
        city:
          type: string
          description: The name of the city.
          example: New York City
        zipcode:
          type: string
          description: The zip code of this city.
          example: N5467
        countrycode:
          type: string
          description: Country code
          example: USA
    CourtesyAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: Amount read by Optical Character Recognition (OCR) from the check image
    transfer.finalize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    mmp.validate.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              hostSumAmount:
                $ref: '#/components/schemas/HostSumAmount'
              hostCashBackAmount:
                $ref: '#/components/schemas/HostCashBackAmount'
              accountInformation:
                $ref: '#/components/schemas/AccountInformationBase'
              checkValidationTransactionId:
                $ref: '#/components/schemas/CheckValidationTransactionId'
              checkModificationAllowed:
                description: Flag to indicate if check modification is allowed
                type: boolean
                example: false
              checks:
                type: array
                items:
                  $ref: '#/components/schemas/ValidateResponseCheck'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    checkcashing.processclearing.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              checks:
                type: array
                items:
                  $ref: '#/components/schemas/ProcessClearingResponseCheck'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountingState:
      description: Outcome of the transaction at the acceptor
      type: string
      enum:
      - OK
      - ABORT
      - CRITICAL
      - NOT_AUTHORIZED
      example: OK
    checkcashing.authorizecashout.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            requestedAmount:
              $ref: '#/components/schemas/RequestedAmount'
            creditAmount:
              $ref: '#/components/schemas/CreditAmountCC'
            account:
              $ref: '#/components/schemas/AccountCC'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    UserAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The amount which is entered by the User
    addCheck.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - check
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            check:
              $ref: '#/components/schemas/CheckDetailsWithImage'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    CardHandlingIndicator:
      type: string
      enum:
      - OUT
      - RETAIN
      - CHAINING_ALLOWED
      - RETAIN_ON_SUCCESS
      description: Card Handling Indicator
      example: OUT
    AccountRefFee:
      type: object
      description: "The account in which fee transactions are to be performed. \n"
      required:
      - accountType
      properties:
        accountNumber:
          description: Fee account number
          type: string
          minLength: 1
          example: A0123456789
        accountType:
          $ref: '#/components/schemas/AccountType'
        accountName:
          $ref: '#/components/schemas/AccountName'
        accountSubType:
          $ref: '#/components/schemas/AccountSubType'
    HostCashBackAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The amount set by the host system if some checks are denied and the cashback amount is decreased by this decision
    currencyExchangeRates.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - currencyExchangeRatePairs
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            currencyExchangeRatePairs:
              type: array
              items:
                $ref: '#/components/schemas/CurrencyExchangeRatePairs'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    AdditionalProperties:
      type: object
      additionalProperties:
        type: string
      description: Additional properties can be provided within this object
    checkcashing.finalizecashout.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            dispensedAmount:
              $ref: '#/components/schemas/DispensedAmount'
            requestedAmount:
              $ref: '#/components/schemas/RequestedAmountFinalizeCashOut'
            account:
              $ref: '#/components/schemas/AccountForUndispensedAmount'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            cashOutItemMixUsed:
              type: array
              description: List of dispensed notes and coins
              items:
                $ref: '#/components/schemas/CassCounter'
            cashOutItemMixTotal:
              type: array
              description: List of dispensed notes and coins since last settlement
              items:
                $ref: '#/components/schemas/CassCounter'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            mediaStates:
              $ref: '#/components/schemas/MediaStates'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    withdrawal.finalize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            amount:
              $ref: '#/components/schemas/Amount'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            mediaStates:
              $ref: '#/components/schemas/MediaStates'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            itemMixUsed:
              type: array
              description: List of dispensed notes and coins
              items:
                $ref: '#/components/schemas/CassCounter'
            itemMixTotal:
              type: array
              description: list of dispensed notes and coins since last settlement
              items:
                $ref: '#/components/schemas/CassCounter'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    Date:
      type: string
      format: yyyy-MM-dd
      description: The date pattern is defined 'yyyy-MM-dd', with yyyy as 4-digit year, MM as 2-digit month and dd as 2-digit date of month
      example: '2020-07-23'
    CreditAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The balance amount of the transaction to be credited to the consumer
    SupplementaryData:
      type: object
      description: 'Additional information incorporated as an extension to the message by mixins based on the transaction type          '
    Loan:
      type: object
      description: Loan balance to be represented in amounts as LOAN_BALANCE, INTEREST_AMOUNT, REGULAR_PAYMENT_AMOUNT, REGULAR_PAYMENT_DUE, PRINCIPLE_BALANCE, MINIMUM_AMOUNT_DUE, LAST_PAYMENT_AMOUNT, LAST_CHARGE_DUE, INTEREST_PAID_YEAR_TO_DATE, INTEREST_PAID_PREVIOUS_YEAR_TO_DATE
      properties:
        loanType:
          $ref: '#/components/schemas/LoanType'
        loanMaturityDate:
          $ref: '#/components/schemas/Date'
    Deleted:
      type: boolean
      description: Flag to indicate that the check is rejected or must be returned to the consumer
    ServiceResponse:
      type: object
      required:
      - responseCode
      properties:
        responseCode:
          $ref: '#/components/schemas/ResponseCode'
        extendedResponse:
          $ref: '#/components/schemas/ExtendedResponse'
    addCheck.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              check:
                $ref: '#/components/schemas/CheckDetailsWithImage'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    DebitAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The amount of the transaction to be debited from the consumer's account when the amount being paid is less than the payment amount being requested
    AccountPermissions:
      type: object
      properties:
        accessPermission:
          $ref: '#/components/schemas/AccessPermission'
        markedForDepositOnly:
          type: boolean
          example: false
          description: Flag to identify if the account is for Deposit only
    checkcashing.processclearing.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            checkAmount:
              $ref: '#/components/schemas/CheckAmount'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetails'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    CheckState:
      type: string
      enum:
      - OPEN
      - RETURNED
      - RETAINED
      - ENDORSED
      - CONFIRMED
      - AMENDED
      - REJECTED
      - PROCESSED_OK
      - PROCESSED_ERROR
      description: State of the check
      example: ENDORSED
    CassCounter:
      type: object
      properties:
        device:
          $ref: '#/components/schemas/Device'
        changeType:
          $ref: '#/components/schemas/DeviceChangeType'
        denomCounter:
          type: array
          items:
            $ref: '#/components/schemas/DenomCounter'
    ForeignCurrencyConversionState:
      type: string
      description: '

        In the request, this field defines whether the consumer accepted or declined the FCC.


        In the response, this field defines whether a confirmation is required or not from the consumer for FCC.

        '
      enum:
      - CONFIRM_REQUIRED
      - CONF_NOT_REQUIRED
      - CONFIRMED
      - DECLINED
      example: CONFIRM_REQUIRED
    ExtendedResponseCode:
      type: string
      enum:
      - OK
      - SERVER_FAILURE
      - NO_RESULT
      - ACCOUNT_NOT_FOUND
      - ACCOUNT_CLOSED
      - ACCOUNT_TYPE_INVALID
      - LIMIT_EXCEEDED
      - INSUFFICIENT_FUNDS
      - REQUEST_DATA_INVALID
      - TRX_NOT_PERMITTED_TO_ACCOUNT
      - TRANSACTION_NOT_POSSIBLE
      - HOST_OFFLINE
      - HOST_CANCEL
      - HOST_BUSINESS_ERROR
      - RESPONSE_FEE_CONFIRM_REQUIRED
      - OVERDRAFT_CONFIRM_REQUIRED
      - PIN_VALIDATION_FAILED
      - FCC_CONFIRM_REQUIRED
      - DIRECT_CURRENCY_CONVERSION_CONFIRM_REQUIRED
      - MULTI_CONFIRM_REQUIRED
      - CARD_NOT_FOUND
      - CARD_NOT_FOUND_FOR_EXPIRY_DATE
      - CARD_BLOCKED
      - CARD_EXPIRED
      - CARD_MANIPULATED
      - PIN_INACTIVE
      - PIN_TRY_LIMIT_EXCEEDED
      - PINS_DIFFER
      - OFFLINE_OKAY
      - SERVER_NOT_READY
      example: OK
      description: Extended Response Code Mapping
    AccountMMP:
      type: object
      allOf:
      - $ref: '#/components/schemas/AccountRef'
      description: The account to which the creditAmount has to be credited or the debitAmount has to be debited
    withdrawal.authorize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - accountRef
          - amount
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            pin:
              $ref: '#/components/schemas/Pin'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            amount:
              $ref: '#/components/schemas/Amount'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            dynamicCurrencyConversion:
              $ref: '#/components/schemas/DynamicCurrencyConversion'
            foreignCurrencyConversion:
              $ref: '#/components/schemas/ForeignCurrencyConversion'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    withdrawal.finalize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    mmp.finalizecashout.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              accountInformation:
                $ref: '#/components/schemas/AccountInformationBase'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    transfer.authorize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - accountRefTo
          - accountRefFrom
          - amount
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            accountRefFrom:
              $ref: '#/components/schemas/AccountRef'
            accountRefTo:
              $ref: '#/components/schemas/AccountRef'
            amount:
              $ref: '#/components/schemas/Amount'
            textKey:
              type: string
              description: Text key (typically used for accounting references and defined by the central bank of the state)
              example: textKey
            textKeyExtension:
              type: string
              description: Text key extension (used for accounting references)
              example: textKeyExtension
            remark:
              type: string
              description: Transaction remark
              example: Transaction Remark
            senderName:
              type: string
              description: Sender Name
              example: ABC Corp.
            receiverName:
              type: string
              description: Receiver Name
              example: XYZ Ltd.
            orderId:
              type: string
              description: Order Id
              example: order Id
            changeId:
              type: string
              description: Change Id
              example: change Id
            scheduledDate:
              $ref: '#/components/schemas/Date'
            creationDate:
              $ref: '#/components/schemas/Date'
            referenceNumber:
              type: string
              description: Reference number to identify a particular consumer/account for which payment is made
              example: ''
            paymentType:
              $ref: '#/components/schemas/PaymentType'
            paymentSubType:
              $ref: '#/components/schemas/PaymentSubType'
            foreignCurrencyConversion:
              $ref: '#/components/schemas/ForeignCurrencyConversion'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    checkcashing.finishvalidation.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              fees:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionFee'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    CreditAmountCC:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: 'The balance amount of the transaction to be credited to the consumer, calculated as (checkAmount - requestedAmount - feeAmount) '
    addCash.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              accountRef:
                $ref: '#/components/schemas/AccountRef'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountSubType:
      description: Represents the SubType of an account for AccountType
      type: string
      example: Savings account
    mmp.finalizecashout.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            dispensedAmount:
              $ref: '#/components/schemas/DispensedAmount'
            requestedAmount:
              $ref: '#/components/schemas/RequestedAmountFinalizeCashOut'
            account:
              $ref: '#/components/schemas/AccountForUndispensedAmount'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            cashOutItemMixUsed:
              type: array
              description: List of dispensed notes and coins
              items:
                $ref: '#/components/schemas/CassCounter'
            cashOutItemMixTotal:
              type: array
              description: List of dispensed notes and coins since last settlement
              items:
                $ref: '#/components/schemas/CassCounter'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            mediaStates:
              $ref: '#/components/schemas/MediaStates'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    deposit.validate.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              hostSumAmount:
                $ref: '#/components/schemas/HostSumAmount'
              hostCashBackAmount:
                $ref: '#/components/schemas/HostCashBackAmount'
              accountInformation:
                $ref: '#/components/schemas/AccountInformationBase'
              checkValidationTransactionId:
                $ref: '#/components/schemas/CheckValidationTransactionId'
              checks:
                type: array
                items:
                  $ref: '#/components/schemas/ValidateResponseCheck'
              foreignCurrencyConversionList:
                type: array
                items:
                  $ref: '#/components/schemas/ForeignCurrencyConversion'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    login.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              enabledTransactions:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionTypes'
              consumerId:
                $ref: '#/components/schemas/ConsumerId'
              accounts:
                type: array
                items:
                  $ref: '#/components/schemas/AccountInfo'
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    ResponseCode:
      type: string
      enum:
      - OK
      - FAIL
      - RESUBMIT
      example: OK
    CurrencyExchangeRateDefs:
      type: object
      required:
      - directQuotation
      - baseCurrency
      - foreignCurrency
      - rateSell
      - rateBuy
      - decimals
      - currencyExchangeRateCategory
      description: Currency exchange rate details for supported currencies
      properties:
        directQuotation:
          type: boolean
          description: Flag to indicate whether a direct or an indirect quotation mode has to be used with this exchange rate. A direct quote is a foreign exchange rate involving a quote in fixed units of foreign currency against variable amounts of the domestic currency. An indirect quote is a currency quotation in the foreign exchange market that expresses the amount of foreign currency required to buy or sell one unit of the domestic currency
          example: false
        baseCurrency:
          $ref: '#/components/schemas/BaseCurrency'
        foreignCurrency:
          $ref: '#/components/schemas/CurrencyForeign'
        rateSell:
          type: integer
          description: The sell exchange rate as long value
          example: 84
        rateBuy:
          type: integer
          description: The buy exchange rate as long value
          example: 82
        decimals:
          type: integer
          description: The decimal places of the exchange rate
          example: 2
        currencyExchangeRateCategory:
          $ref: '#/components/schemas/CurrencyExchangeRateCategory'
    deposit.finalize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              deleteChecks:
                type: boolean
                description: Whether the check data must be deleted by the Client
                example: false
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    PaymentSubType:
      type: string
      description: Payment subtype
      enum:
      - PRINCIPAL
      - REGULAR
      - PAYOFF
      - INTEREST_ONLY
      - MINIMUM
      - NOT_SPECIFIED
    deposit.finalize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            checkAmount:
              $ref: '#/components/schemas/CheckAmount'
            cashInAmount:
              $ref: '#/components/schemas/CashInAmount'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            splitDeposit:
              type: array
              items:
                $ref: '#/components/schemas/SplitDeposit'
            itemMixUsed:
              type: array
              description: List of used check and/or cash items
              items:
                $ref: '#/components/schemas/CassCounter'
            itemMixTotal:
              type: array
              description: List of total check and/or cash items
              items:
                $ref: '#/components/schemas/CassCounter'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            mediaStates:
              $ref: '#/components/schemas/MediaStates'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    CurrencyExchangeRate:
      type: object
      required:
      - baseCurrency
      - foreignCurrency
      - rate
      - decimals
      description: Currency exchange rate
      properties:
        directQuotation:
          type: boolean
          description: '

            Flag to indicate whether a direct or an indirect quotation mode has to be used with this exchange rate.


            A direct quote is a foreign exchange rate involving a quote in fixed units of foreign currency against variable amounts of the domestic currency.


            An indirect quote is a currency quotation in the foreign exchange market that expresses the amount of foreign currency required to buy or sell one unit of the domestic currency

            '
          example: false
        sell:
          type: boolean
          description: '

            Flag to indicate whether it is a sell rate (true) or a buy rate (false).


            For withdrawal and transfer transactions, it is true.


            For a deposit transaction, it is false.

            '
          example: false
        cash:
          type: boolean
          description: '

            Flag to indicate whether it is a cash rate (true) or a non-cash rate (false).


            For withdrawal and deposit transactions, it is true.


            For a transfer transaction, it is false.

            '
          example: true
        baseCurrency:
          $ref: '#/components/schemas/Currency'
        foreignCurrency:
          $ref: '#/components/schemas/CurrencyForeign'
        rate:
          type: integer
          description: The exchange rate as long value
          example: 82
        decimals:
          type: integer
          description: The decimal places of the exchange rate
          example: 2
    RejectedBy:
      type: string
      enum:
      - UNDEFINED
      - CONSUMER
      - SYSTEM
      - TELLER
      description: Indicates who has rejected the check
      example: SYSTEM
    PaymentType:
      type: string
      description: Payment type
      enum:
      - LOAN
      - CREDIT_CARD
      - BILL
      - NOT_SPECIFIED
    CurrencyForeign:
      description: Currency code of the foreign currency
      type: string
      minLength: 3
      pattern: '[A-Z]{3,3}'
      example: EUR
    IsStandin:
      type: boolean
      description: Standin request indicator
      example: false
    DispensedAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The total dispensed amount
    Currency:
      description: Currency code
      type: string
      minLength: 3
      pattern: '[A-Z]{3,3}'
      example: USD
    ClearingType:
      type: string
      enum:
      - CASH
      - CHECK
      - CASH_AND_CHECK
      - PAYMENT
      description: Clearing Type
      example: CASH
    NetworkId:
      type: string
      description: Id of the acquiring network (scheme specific)
      example: MAC
    RequestedAmountFinalizeCashOut:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The amount that was authorized for cashout
    checkcashing.finishvalidation.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            validatedAmount:
              $ref: '#/components/schemas/ValidatedAmount'
            checkValidationTransactionId:
              $ref: '#/components/schemas/CheckValidationTransactionId'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetails'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            mediaStates:
              $ref: '#/components/schemas/MediaStates'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    deposit.validate.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            transactionId:
              $ref: '#/components/schemas/TransactionId'
            targetAccount:
              $ref: '#/components/schemas/TargetAccount'
            checkAmount:
              $ref: '#/components/schemas/CheckAmount'
            cashInAmounts:
              type: array
              items:
                $ref: '#/components/schemas/Amount'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetails'
            foreignCurrencyConversionList:
              type: array
              items:
                $ref: '#/components/schemas/ForeignCurrencyConversion'
            itemMixUsed:
              type: array
              description: List of used check and/or cash items
              items:
                $ref: '#/components/schemas/CassCounter'
            splitDeposit:
              type: array
              items:
                $ref: '#/components/schemas/SplitDeposit'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    PointOfInteraction:
      properties:
        clientId:
          type: string
          description: Client Id
          example: '123'
        clientType:
          $ref: '#/components/schemas/ClientType'
        institutionId:
          type: string
          description: The id of the institute
          example: '1234'
        tellerId:
          type: string
          description: The id of the teller
          example: ''
        branchCode:
          type: string
          description: Branch code
          example: ''
        clientTransactionDate:
          $ref: '#/components/schemas/ClientTransactionDate'
        clientTransactionTime:
          $ref: '#/components/schemas/ClientTransactionTime'
        channel:
          $ref: '#/components/schemas/Channel'
        address:
          $ref: '#/components/schemas/AddressPOI'
        networkId:
          $ref: '#/components/schemas/NetworkId'
        merchantCategory:
          $ref: '#/components/schemas/MerchantCategory'
    AccountAmountType:
      type: string
      enum:
      - LEDGER_BALANCE
      - AVAILABLE_BALANCE
      - AVAILABLE_CREDIT
      - CREDIT_LIMIT
      - OVERDRAFT_LIMIT
      - LOAN_BALANCE
      - INTEREST_AMOUNT
      - REGULAR_PAYMENT_AMOUNT
      - REGULAR_PAYMENT_DUE
      - PRINCIPLE_BALANCE
      - CURRENT_AMOUNT_DUE
      - LAST_PAYMENT_AMOUNT
      - LAST_CHARGE_DUE
      - INTEREST_PAID_YEAR_TO_DATE
      - INTEREST_PAID_PREVIOUS_YEAR_TO_DATE
      - OFF_HOST_DEBIT_AMOUNT
      - OFF_HOST_CREDIT_AMOUNT
      - TOTAL_DEBIT_AMOUNT
      - TOTAL_CREDIT_AMOUNT
      - PAYOFF_AMOUNT
      - OWING_AMOUNT
      - AMOUNT_ALREADY_DRAWN_ON
      - MEMBER_PROVIDED_FEE_AMOUNT
      - REMAINING_PREAUTHORIZED_AMOUNT
      - HEALTHCARE_ELIGIBILITY_AMOUNT
      - PRESCRIPTION_ELIGIBILITY_AMOUNT
      - PREPAID_ONLINE_BILL_PAY_FEE_AMOUNT
      - CASH_BACK
      - ORIGINAL_AMOUNT
      - POI_AMOUNT
      - CO_PAY_AMOUNT
      - MINIMUM_AMOUNT_DUE
      - REWARD_BALANCE
      - LAST_STATEMENT_BALANCE
      example: AVAILABLE_BALANCE
      description: Amount types for account
    ClientType:
      type: string
      description: The type of the hardware terminal device
      enum:
      - ADMINISTRATIVE_TERMINAL
      - POS_TERMINAL
      - ATM
      - HOME_TERMINAL
      - ECR
      - DIAL_TERMINAL
      - TRAVELERS_CHECK_MACHINE
      - FUEL_MACHINE
      - 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
      - INTERNET_TERMINAL
      - MICR_TERMINAL
      - MOBILE_ACCEPTANCE_SOLUTION
      - UNKNOWN
      - NOT_CARDHOLDER_ACTIVATED
      - LEVEL_1_CAT_ATM_WITH_PIN
      - LEVEL_2_CAT_SELF_SERVICE_TERMINAL
      - LEVEL_3_CAT_LIMITED_AMOUNT_TERMINAL
      - LEVEL_4_CAT_IN_FLIGHT_COMMERCE
      - LEVEL_6_CAT_ECOMMERCE
      - LEVEL_7_CAT_TRANSPONDER_TRANSACTION
      - LEVEL_8_CAT_MOBILE_INITIATED
      - LEVEL_9_CAT_MPOS_ACCEPTANCE_DEVICE
      example: ATM
    checkcashing.validate.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              hostCheckAmount:
                $ref: '#/components/schemas/HostCheckAmount'
              hostCashBackAmount:
                $ref: '#/components/schemas/HostCashBackAmount'
              accountInformation:
                $ref: '#/components/schemas/AccountInformationBase'
              checkValidationTransactionId:
                $ref: '#/components/schemas/CheckValidationTransactionId'
              checks:
                type: array
                items:
                  $ref: '#/components/schemas/ValidateResponseCheck'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    checkcashing.finalizecashout.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              accountInformation:
                $ref: '#/components/schemas/AccountInformationBase'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    ClearingState:
      type: string
      enum:
      - OK
      - NOT_SET
      - FAILED
      description: Clearing State of the inserted media
      example: OK
    HostCheckAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/HostCashBackAmount'
      description: The amount set by the host system if some checks are denied and the total check amount is decreased by this decision
    checkcashing.authorize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    checkcashing.authorizecashout.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              businessDate:
                $ref: '#/components/schemas/Date'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    mmp.finalize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountCC:
      type: object
      allOf:
      - $ref: '#/components/schemas/AccountRef'
      description: The account to which the creditAmount has to be credited
    AccountStatus:
      type: string
      description: The status of the account
      enum:
      - ACTIVE
      - APPROVED
      - CLOSED
      - DORMANT
      - PENDING_CLOSED
      - CHARGEOFF
      - INACTIVE
      - NON_ACCRUAL
      - MATURED
      - ESCHEAT
      - ASSUMED
      - LOAN_DENIED
      - ORIGINATING
      - REDEEMED
      - MATURED_NOT_REDEEMED
      - NO_DEBIT
      - NO_CREDIT
      - NO_POST
      - FROZEN_NON_ACCRUAL
      - CHARGEDOFF_NON_ACCRUAL
      - OCCUPIED
      - NOT_AVAILABLE
      - UNOCCUPIED
      - ACTIVE_NO_POD
      - DO_NOT_CLOSE_ON_ZERO_BALANCE
      - FROZEN_ACCRUAL
      - OPEN_PRIMARY_ACCOUNT
      - RESTRICTED_PRIMARY_ACCOUNT
      - RESTRICTED_TO_DEPOSIT
      - NOT_SPECIFIED
      example: ACTIVE
    ExtendedResponseMessage:
      type: string
      description: Extended Response Message
      example: OK
    LoanType:
      type: string
      enum:
      - LOAN
      - CONSUMER_LOAN
      - COMMERCIAL_LOAN
      - MORTGAGE_LOAN
      - EXTERNAL_LOAN
      - LOAN_DENIAL
      example: MORTGAGE_LOAN
      description: All the possible account types for LOAN Accounts
    deposit.processClearing.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              checks:
                type: array
                items:
                  $ref: '#/components/schemas/ProcessClearingResponseCheck'
              cashInClearingState:
                $ref: '#/components/schemas/ClearingState'
              checkClearingState:
                $ref: '#/components/schemas/ClearingState'
              accounts:
                type: array
                items:
                  $ref: '#/components/schemas/AccountInformationBase'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    CashInLimit:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: Amount limit for cash in the transaction
    BestMatchedElement:
      type: string
      example: TRACK_2
      description: Best matched element for Consumer Identification
      enum:
      - TRACK_2
      - NFC
      - EMV
      - CUSTOM
    ConfirmationNumber:
      type: string
      description: The unique identifier for the transaction
      example: '998087999'
    PointOfInteractionSettlementDate:
      type: string
      description: 'In Local Timezone <br> For ''selfService'' channel, ATM booking date for the transaction. <br><br>

        For ''network'' channel, data element DE15 - the  month and day funds are transferred between the acquirer and issuer.'
      format: MMDD
      example: 0921
    SourceCurrency:
      description: Currency code of the source currency
      type: string
      minLength: 3
      pattern: '[A-Z]{3,3}'
      example: USD
    MediaState:
      description: The state of the media
      type: string
      enum:
      - UNKNOWN
      - RETAINED
      - OK
      - JAMMED
      - NO_MEDIA
      - REMAINED_IN_SLOT
      - REJECTED
      - RECYCLED
      - RECYCLING_ERROR
      example: OK
    Channel:
      type: string
      enum:
      - selfService
      - network
      - teller
      - mobile
      - undefined
      description: Channel through which transaction is initiated.
    currencyExchangeRates.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              exchangeRateDefs:
                type: array
                items:
                  $ref: '#/components/schemas/CurrencyExchangeRateDefs'
              notSupportedCurrencyExchangeRates:
                type: array
                items:
                  $ref: '#/components/schemas/NotSupportedCurrencyExchangeRatePairs'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    DenomCounter:
      type: object
      description: Denomination Counter
      properties:
        currency:
          description: Currency code
          type: string
          minLength: 3
          pattern: '[A-Z]{3,3}'
          example: USD
        denomination:
          type: string
          description: Denomination
          example: '500'
        release:
          type: integer
          description: Release of document (e.g. newer edition of banknote)
          example: 1
        physicalType:
          $ref: '#/components/schemas/PhysicalType'
        dispensedCounter:
          type: integer
          description: counter
          example: 2
        dispensedToConsumerCount:
          type: integer
          description: counter
          example: 4
        remainingTotalCounter:
          type: integer
          description: counter
        level4Count:
          type: integer
          description: counter
        level3Count:
          type: integer
          description: counter
        level2Count:
          type: integer
          description: counter
        unfitCount:
          type: integer
          description: counter
        retainCount:
          type: integer
          description: counter
        rejectCounter:
          type: integer
          description: counter
        retractCounter:
          type: integer
          description: counter
    CurrencyExchangeRateCategory:
      type: string
      description: The category of this currency exchange
      enum:
      - CASH
      - NON_CASH
      example: CASH
    CardPan:
      type: object
      required:
      - pan
      properties:
        bestMatchedElement:
          $ref: '#/components/schemas/BestMatchedElement'
        pan:
          type: string
          minLength: 1
          description: Primary Account Number (PAN) of the card
          example: '4490739000000895'
        track2:
          type: string
          example: 4490739000000895D161222366
          description: ISO track 2 issued from the magnetic stripe card or from the ICC
        emvData:
          type: array
          items:
            $ref: '#/components/schemas/EMVTagData'
        cardSequenceNumber:
          type: string
          example: '05'
          description: Identify a card or a payment token inside a set of cards with the same PAN
        expiryDate:
          type: string
          description: Expiry date of the card expressed in YYMM format
          example: '2107'
        consumerGroup:
          type: string
          description: Consumer Group Name
          example: CG_ON_US_DEBIT
    checkcashing.authorize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              businessDate:
                $ref: '#/components/schemas/Date'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    mmp.authorize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            targetAccount:
              $ref: '#/components/schemas/TargetAccount'
            sourceAccount:
              $ref: '#/components/schemas/SourceAccount'
            requestedAmount:
              $ref: '#/components/schemas/RequestedAmount'
            textKey:
              type: string
              description: Text key (typically used for accounting references and defined by the central bank of the state)
              example: textKey
            textKeyExtension:
              type: string
              description: Text key extension (used for accounting references)
              example: textKeyExtension
            remark:
              type: string
              description: Transaction remark
              example: Transaction remark
            senderName:
              type: string
              description: Sender's Name
            receiverName:
              type: string
              description: Receiver's Name
            orderId:
              type: string
              description: Order identifier
              example: A4323
            changeId:
              type: string
              description: Change Id
              example: change Id
            scheduledDate:
              $ref: '#/components/schemas/ScheduledDate'
            creationDate:
              $ref: '#/components/schemas/Date'
            referenceNumber:
              type: string
              description: Reference number to identify a particular consumer/account for which payment is made
              example: ''
            paymentType:
              $ref: '#/components/schemas/PaymentType'
            paymentSubType:
              $ref: '#/components/schemas/PaymentSubType'
            invoicingParty:
              type: string
              description: Invoicing party
            externalPaymentId:
              type: string
              example: '4711'
              description: External payment identifier
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    FeeType:
      type: string
      enum:
      - DIRECT_ACQUIRER_FEE
      - INDIRECT_ACQUIRER_FEE
      - ISSUER_FEE
      - SPECIAL_FEE
      - SETTLEMENT_ACQUIRER_FEE
      - TELLER_MODIFIABLE_FEE
      - DCC_COMMISSION_FEE
      example: DIRECT_ACQUIRER_FEE
    ForeignCurrencyConversion:
      type: object
      required:
      - fccState
      - amount
      - amountInBaseCurrency
      - exchangeRate
      properties:
        fccState:
          $ref: '#/components/schemas/ForeignCurrencyConversionState'
        amount:
          allOf:
          - $ref: '#/components/schemas/AmountForeign'
          description: The amount converted to foreign currency
        amountInBaseCurrency:
          allOf:
          - $ref: '#/components/schemas/Amount'
          description: The amount in base currency of the Financial Institute
        exchangeRate:
          $ref: '#/components/schemas/CurrencyExchangeRate'
    mmp.finishvalidation.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              fees:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionFee'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccessPermission:
      type: string
      enum:
      - NO_PERMISSION
      - FULL_PERMISSION
      - DEPOSIT_ONLY_PERMISSION
      - WITHDRAWAL_ONLY_PERMISSION
      example: FULL_PERMISSION
      description: The Access permission of the Account
    TargetAccount:
      type: object
      allOf:
      - $ref: '#/components/schemas/AccountRef'
      description: The account to which the amount has to be credited
    PayableAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The amount which may be payed on this check
    deposit.finishValidation.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            validatedAmount:
              $ref: '#/components/schemas/ValidatedAmount'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetails'
            checkValidationTransactionId:
              $ref: '#/components/schemas/CheckValidationTransactionId'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            mediaStates:
              $ref: '#/components/schemas/MediaStates'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    Device:
      type: object
      description: ATM Device
      required:
      - device
      properties:
        device:
          type: string
          description: Device id. For a list of all 185 possible devices please refer to - http://[xxx.xxx.xxx.xxx]/pce-manuals/ruegen/pdf25/KnowledgeBase/doc/content.html?url=content/html/KnowledgeBase_SRV/SEC_possible_devices.html&search=PCEDeviceConstant
          example: DOCUMENT_FEED
        deviceState:
          type: string
          description: State of Device OPERATIONAL or NON_OPERATIONAL
          example: OPERATIONAL
    AccountName:
      type: string
      description: The account name which is displayed to the user
      example: Your Savings account
    AmountForeign:
      description: The basic type of an amount.
      type: object
      required:
      - value
      - currency
      properties:
        value:
          type: string
          example: '82.00'
        currency:
          type: string
          example: EUR
    AlternateAmounts:
      type: object
      properties:
        lowerAlternateAmount:
          $ref: '#/components/schemas/Amount'
        higherAlternateAmount:
          $ref: '#/components/schemas/Amount'
    pinChange.authorize.Request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - card
          - oldPin
          - newPin
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            oldPin:
              $ref: '#/components/schemas/Pin'
            newPin:
              $ref: '#/components/schemas/Pin'
            verifiedNewPin:
              $ref: '#/components/schemas/Pin'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    mmp.processclearing.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              checks:
                type: array
                items:
                  $ref: '#/components/schemas/ProcessClearingResponseCheck'
              cashInClearingState:
                $ref: '#/components/schemas/ClearingState'
              checkClearingState:
                $ref: '#/components/schemas/ClearingState'
              accounts:
                type: array
                items:
                  $ref: '#/components/schemas/AccountInformationBase'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountOwnership:
      type: string
      enum:
      - PRIMARY
      - JOINT
      - NOT_SPECIFIED
      - CUSTODIAN
      - TRUSTEE
      - POWER_OF_ATTORNEY
      - AUTHORIZED_SIGNER
      - TRUSTOR
      - CO_BORROWER
      - CO_SIGNER
      - CO_OWNER
      - CO_MAKER
      - CORPORATION
      - BORROWER
      - CORPORATE_OWNER
      - JOINT_PRIMARY
      - JOINT_SECONDARY
      - JOINT_AND
      - JOINT_OR
      - ENDORSER
      - GUARANTOR
      - GRANTOR
      - LANDLORD
      - SECONDARY
      - TENANT
      - SOLE_PROPRIETOR
      - GUARDIAN
      - EXECUTOR
      example: PRIMARY
    ConsumerAccountCurrency:
      description: Currency code of the consumer account
      type: string
      minLength: 3
      pattern: '[A-Z]{3,3}'
      example: EUR
    logout.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    SourceAccount:
      type: object
      allOf:
      - $ref: '#/components/schemas/AccountRef'
      description: The account from which the payment amount has to be deducted
    CheckType:
      type: string
      enum:
      - ON_US
      - OFF_US
      - GOVERNMENT
      - NOT_SPECIFIED
      example: ON_US
      description: The Check Type value of the check
    AccountForUndispensedAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/AccountRef'
      description: The account to which the undispensed amount has to be credited in case of a) Dispense failure (identified through mediaStates) b) Partial dispense
    TransactionWithStandin:
      type: object
      allOf:
      - $ref: '#/components/schemas/TransactionBase'
      - type: object
        properties:
          isStandin:
            $ref: '#/components/schemas/IsStandin'
    TransactionId:
      type: string
      description: Unique transaction identifier
      example: e025d7ee74db4ddcbfe4af45ca42327a
    PhysicalType:
      type: string
      description: Type of documents
      enum:
      - COIN
      - NOTE
      example: NOTE
    pinChange.authorize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              businessDate:
                $ref: '#/components/schemas/Date'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    deposit.authorize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            pin:
              $ref: '#/components/schemas/Pin'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            targetAccount:
              $ref: '#/components/schemas/TargetAccount'
            splitDeposit:
              type: array
              items:
                $ref: '#/components/schemas/SplitDeposit'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    Amounts:
      type: array
      items:
        $ref: '#/components/schemas/AccountAmount'
    deposit.processClearing.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            targetAccount:
              $ref: '#/components/schemas/TargetAccount'
            checkAmount:
              $ref: '#/components/schemas/CheckAmount'
            cashInAmount:
              $ref: '#/components/schemas/CashInAmount'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetails'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            clearingType:
              $ref: '#/components/schemas/ClearingType'
            splitDeposit:
              type: array
              items:
                $ref: '#/components/schemas/SplitDeposit'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    MediaStates:
      type: array
      items:
        properties:
          media:
            $ref: '#/components/schemas/MediaType'
          state:
            $ref: '#/components/schemas/MediaState'
    DeviceChangeType:
      type: string
      enum:
      - UNKNOWN
      - DEVICE_ADDED
      - DEVICE_REMOVED
      - CASH_ADDED
      - CASH_REMOVED
      - NO_SOP_OPERATED_CHANGE
      - NEW_CHECK_PERIOD
      example: UNKNOWN
      description: Device Change type
    transfer.finalize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    MerchantCategory:
      type: string
      description: Identifier representing the merchant's type of business product or service
      example: '6011'
    cassCounterChanged.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            reason:
              $ref: '#/components/schemas/CassCounterChangeReason'
            newCassCounterList:
              type: array
              items:
                $ref: '#/components/schemas/CassCounter'
            oldCassCounterList:
              type: array
              items:
                $ref: '#/components/schemas/CassCounter'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    SplitDeposit:
      type: object
      required:
      - account
      - amount
      description: Account and Amount data for Split Deposit processing
      properties:
        account:
          $ref: '#/components/schemas/AccountRef'
        amount:
          $ref: '#/components/schemas/Amount'
    TargetCurrency:
      description: Currency code of the target currency
      type: string
      minLength: 3
      pattern: '[A-Z]{3,3}'
      example: EUR
    Conductor:
      type: object
      required:
      - conductorId
      - firstName
      properties:
        conductorId:
          type: string
          example: '4562893742'
        firstName:
          type: string
          example: Betty
        lastName:
          type: string
          example: Adams
        role:
          type: string
          example: PRIMARY
        primaryIdentifier:
          type: integer
          example: 1
        accountPermissions:
          type: array
          items:
            $ref: '#/components/schemas/AccountPermissions'
    updateChecks.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          required:
          - checks
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetailsWithImage'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    BaseCurrency:
      description: Currency code of the base currency
      type: string
      minLength: 3
      pattern: '[A-Z]{3,3}'
      example: USD
    ConsumerId:
      type: string
      description: A unique identifier of a consumer
      example: '123456'
    TransactionBase:
      type: object
      required:
      - id
      - type
      - operation
      properties:
        id:
          type: string
          minLength: 1
          example: '212423521525'
        transactionTime:
          type: string
          description: Transaction time
          format: yyyy-MM-dd'T'HH:mm:ssZ
          example: 2020-09-01T16:40:52+0000
        poiSettlementDate:
          $ref: '#/components/schemas/PointOfInteractionSettlementDate'
        businessCorrelationId:
          type: string
          description: Unique ID for a transaction business case
          maxLength: 50
          example: 7f2b9fcde28b42abbc10b0b9640f6ede
        type:
          $ref: '#/components/schemas/TransactionTypes'
        operation:
          type: string
          minLength: 1
          description: Operation performed for the given transaction type given by the 'type' property
        retrievalReferenceNumber:
          type: string
          example: '827364775848'
          description: 'A numeric value containing the unique transaction reference number '
        authorizationIdentificationResponse:
          type: string
          example: '000123'
          description: A numeric value containing the authorization code
    CassCounterChangeReason:
      type: string
      enum:
      - STARTUP
      - CASS_COUNTER_CIT_REPLENISHMENT
      - CASS_COUNTER_SOP_ENTRY
      - CASS_COUNTER_BRANCH_REPLENISHMENT
      - CASS_COUNTER_CHANGED_WITHOUT_TRANSACTION
      example: CASS_COUNTER_CIT_REPLENISHMENT
    checkcashing.finalize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountInformationBase:
      type: object
      required:
      - accountType
      - accountNumber
      - amounts
      properties:
        accountNumber:
          description: Account number
          type: string
          minLength: 5
          example: '19023456789'
        accountCurrency:
          description: Currency code
          type: string
          pattern: '[A-Z]{3,3}'
          example: USD
        accountType:
          $ref: '#/components/schemas/AccountType'
        accountSubType:
          $ref: '#/components/schemas/AccountSubType'
        accountName:
          $ref: '#/components/schemas/AccountName'
        instituteName:
          description: The name or identifier of the institute
          type: string
          example: Deutsche Bank
        effectiveDateTime:
          type: string
          description: The date and time stamp in UTC from which the balances specified in the 'amounts' property are effective
          format: yyyy-MM-dd'T'HH:mm:ssZ
          example: 2024-06-01T00:00:00+0000
        amounts:
          $ref: '#/components/schemas/Amounts'
    RequestedCurrency:
      description: Currency code of the requested currency
      type: string
      minLength: 3
      pattern: '[A-Z]{3,3}'
      example: EUR
    checkcashing.finalize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            checkAmount:
              $ref: '#/components/schemas/CheckAmount'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            itemMixUsed:
              type: array
              description: List of used check and/or cash items
              items:
                $ref: '#/components/schemas/CassCounter'
            itemMixTotal:
              type: array
              description: List of total check and/or cash items
              items:
                $ref: '#/components/schemas/CassCounter'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            mediaStates:
              $ref: '#/components/schemas/MediaStates'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    logout.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    ImageType:
      type: string
      enum:
      - BMP
      - JPEG
      - PNG
      - TIFF
      description: ImageType of the check
      example: JPEG
    CurrencyExchangeRatePairs:
      type: object
      required:
      - sourceCurrency
      - targetCurrency
      properties:
        sourceCurrency:
          $ref: '#/components/schemas/SourceCurrency'
        targetCurrency:
          $ref: '#/components/schemas/TargetCurrency'
        currencyExchangeRateCategory:
          $ref: '#/components/schemas/CurrencyExchangeRateCategory'
    Payment:
      type: object
      description: Payment amounts to be represnted in amounts as REGULAR_PAYMENT_AMOUNT, REGULAR_PAYMENT_DUE, PRINCIPAL_BALANCE, PAYOFF_AMOUNT, LAST_PAYMENT_AMOUNT
      properties:
        regularPaymentDueDate:
          $ref: '#/components/schemas/Date'
        regularPaymentFrequency:
          type: string
          description: Regular payment frequency. This can be DAILY| MONTHLY|WEEKLY|YEARLY
          example: MONTHLY
        lastPaymentDate:
          $ref: '#/components/schemas/Date'
        paymentMethod:
          type: string
          description: The payment method of this account.
    transfer.authorize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              businessDate:
                $ref: '#/components/schemas/Date'
              fees:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionFee'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              accountRefFrom:
                $ref: '#/components/schemas/AccountInformationBase'
              accountRefTo:
                $ref: '#/components/schemas/AccountInformationBase'
              amount:
                $ref: '#/components/schemas/Amount'
              textKey:
                type: string
                description: Text key (typically used for accounting references and defined by the central bank of the state)
                example: textKey
              textKeyExtension:
                type: string
                description: Text key extension (used for accounting references)
                example: textKeyExtension
              remark:
                type: string
                description: Transaction remark
                example: Some remark
              senderName:
                type: string
                description: Sender Name
                example: ABC Corp.
              receiverName:
                type: string
                description: Receiver Name
                example: XYZ Ltd.
              orderId:
                type: string
                description: Order Id
                example: order Id
              changeId:
                type: string
                description: Change Id
                example: change Id
              scheduledDate:
                $ref: '#/components/schemas/Date'
              creationDate:
                $ref: '#/components/schemas/Date'
              referenceNumber:
                type: string
                description: Reference number to identify a particular consumer/account for which payment is made
                example: ''
              paymentType:
                $ref: '#/components/schemas/PaymentType'
              paymentSubType:
                $ref: '#/components/schemas/PaymentSubType'
              foreignCurrencyConversion:
                $ref: '#/components/schemas/ForeignCurrencyConversion'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountRef:
      type: object
      description: "The account on which the transaction is to be performed. \n"
      required:
      - accountNumber
      - accountType
      properties:
        accountNumber:
          description: Account number
          type: string
          minLength: 1
          example: A0123456789
        accountType:
          $ref: '#/components/schemas/AccountType'
        accountName:
          $ref: '#/components/schemas/AccountName'
        accountSubType:
          $ref: '#/components/schemas/AccountSubType'
    AccountAmount:
      type: object
      properties:
        amountType:
          $ref: '#/components/schemas/AccountAmountType'
        value:
          description: The amount value of the given currency
          type: string
          pattern: '[0-9]{1,13}\.[0-9]{1,3}'
          minimum: 0
          example: '100.50'
        currency:
          description: Currency code
          type: string
          pattern: '[A-Z]{3,3}'
          example: USD
    ProcessClearingResponseCheck:
      type: object
      required:
      - id
      description: Details of checks
      properties:
        id:
          type: string
          description: Unique identifier of the check record maintained by the client. This value needs to be mirrored and returned by the host while passing details for this same check in the response
          example: 7892480d0a1948099c71beffa823ed0e
        hostId:
          type: string
          description: Transaction identifier provided by the check processing system after validation
          example: 442347823ebfad58676644aaaa432323
        printData:
          type: string
          description: The string that must be printed on the back of the check
          example: Dated July 17th, 2020
        checkState:
          $ref: '#/components/schemas/CheckState'
    RequestedAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The amount requested for this transaction
    mmp.validate.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            transactionId:
              $ref: '#/components/schemas/TransactionId'
            targetAccount:
              $ref: '#/components/schemas/TargetAccount'
            checkAmount:
              $ref: '#/components/schemas/CheckAmount'
            cashInAmount:
              $ref: '#/components/schemas/CashInAmount'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetails'
            itemMixUsed:
              type: array
              description: List of used check and/or cash items
              items:
                $ref: '#/components/schemas/CassCounter'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    AddCashTotalAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: A sum of all level 3 and level 4 amounts
    CheckLimit:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: Amount limit for check in the transaction
    AccountInfo:
      type: object
      allOf:
      - $ref: '#/components/schemas/AccountInformationBase'
      - type: object
        properties:
          accountOwnerName:
            type: string
            description: 'The owner of the account. '
            example: JOHN DOE
          accountOwnership:
            $ref: '#/components/schemas/AccountOwnership'
          accountStatus:
            $ref: '#/components/schemas/AccountStatus'
          cardNumber:
            type: string
            description: Card number
            example: 3999821321
          branchCode:
            description: The branch code of the bank
            type: string
            example: 1234
          bankCode:
            description: Contains the BIC (bank identifier code)
            type: string
            example: '11133444'
          nickName:
            type: string
            description: NickName
            example: Nick
          openDate:
            $ref: '#/components/schemas/Date'
          accountMaturityDate:
            $ref: '#/components/schemas/Date'
          conductors:
            type: array
            items:
              $ref: '#/components/schemas/Conductor'
          possibleTransactionsAsSourceAccount:
            type: array
            items:
              $ref: '#/components/schemas/TransactionTypes'
          possibleTransactionsAsTargetAccount:
            type: array
            items:
              $ref: '#/components/schemas/TransactionTypes'
          loan:
            $ref: '#/components/schemas/Loan'
          credit:
            $ref: '#/components/schemas/Credit'
          payment:
            $ref: '#/components/schemas/Payment'
          accountWarnings:
            type: array
            items:
              $ref: '#/components/schemas/Warning'
    deposit.authorize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              businessDate:
                $ref: '#/components/schemas/Date'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              checkLimit:
                $ref: '#/components/schemas/CheckLimit'
              cashInLimit:
                $ref: '#/components/schemas/CashInLimit'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    MediaType:
      description: The type of media
      type: string
      enum:
      - NOTE
      - NOTE_L2
      - NOTE_L3
      - NOTE_L4
      - NOTE_UNFIT
      - COIN
      - PRINT_DOCUMENTS
      - CHECK
      - ENVELOPE
      - CARD
      - PASSBOOK
      example: NOTE
    ExtendedResponse:
      type: object
      required:
      - code
      properties:
        code:
          $ref: '#/components/schemas/ExtendedResponseCode'
        message:
          $ref: '#/components/schemas/ExtendedResponseMessage'
    withdrawal.authorize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              businessDate:
                $ref: '#/components/schemas/Date'
              fees:
                type: array
                items:
                  $ref: '#/components/schemas/TransactionFee'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              accountInformation:
                $ref: '#/components/schemas/AccountInformationBase'
              alternateAmounts:
                $ref: '#/components/schemas/AlternateAmounts'
              dynamicCurrencyConversion:
                $ref: '#/components/schemas/DynamicCurrencyConversion'
              foreignCurrencyConversion:
                $ref: '#/components/schemas/ForeignCurrencyConversion'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    NotSupportedCurrencyExchangeRatePairs:
      type: object
      allOf:
      - $ref: '#/components/schemas/CurrencyExchangeRatePairs'
      description: The currency pairs for which exchange rates are requested but not supported. This field is always populated with requested currency pairs for which exchange rate details are not available.
    HostResponseData:
      type: object
      description: Host Response details
      properties:
        hostResponseCode:
          type: string
          description: Host response code
          example: '00000'
        hostTransactionTime:
          type: string
          description: Host transaction datetime in milliseconds
          format: yyyy-MM-dd'T'HH:mm:ssZ
          example: 2020-09-01T16:40:52+0000
        hostMessage:
          type: string
          description: Host response message
          example: Success
    addCash.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            accountRef:
              $ref: '#/components/schemas/AccountRef'
            level4AmountList:
              type: array
              description: A list of level 4 amounts
              items:
                $ref: '#/components/schemas/Amount'
            level3AmountList:
              type: array
              description: A list of level 3 amounts
              items:
                $ref: '#/components/schemas/Amount'
            totalAmount:
              $ref: '#/components/schemas/AddCashTotalAmount'
              description: The total of all level3 and level4 amounts
            itemMixUsed:
              type: array
              description: List of used check and/or cash items
              items:
                $ref: '#/components/schemas/CassCounter'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    FeeState:
      type: string
      enum:
      - CONF_REQUIRED
      - CONF_DECLINED
      - CONFIRMED
      - CONF_NOT_REQUIRED
      example: CONF_NOT_REQUIRED
    ClientTransactionDate:
      type: string
      description: 'In Local Timezone <br> For ''selfService'' channel, the local month and day the transaction takes place. <br><br>

        For ''network'' channel, data element DE13 - the local month and day the transaction takes place at the card acceptor location.'
      format: MMDD
      example: 0921
    login.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    DynamicCurrencyConversionState:
      type: string
      description: '

        In the request, this field defines whether DCC has been confirmed or declined by the consumer.


        In the response, this field defines whether dynamic currency conversion is available.

        '
      enum:
      - DCC_CURRENCY_AVAILABLE
      - DCC_CONSUMER_CONFIRMED
      - DCC_CONSUMER_DECLINED
      example: DCC_CURRENCY_AVAILABLE
    pinChange.finalize.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            accountingState:
              $ref: '#/components/schemas/AccountingState'
            cancelReason:
              $ref: '#/components/schemas/CancelReason'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    MICRAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: Amount read from the MICR line
    EMVTagData:
      type: object
      properties:
        tag:
          $ref: '#/components/schemas/EMVTags'
        value:
          type: string
          description: Hex Encoded value of EMVTag
          example: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
    AddressPOI:
      type: object
      allOf:
      - $ref: '#/components/schemas/Address'
      - type: object
        properties:
          state:
            type: string
            description: The name of the state.
            example: New York
          longitude:
            type: number
            description: The longitude coordinate of this location.
          latitude:
            type: number
            description: The latitude coordinate of this location
    TransactionFee:
      type: object
      required:
      - name
      - type
      - state
      - amount
      properties:
        name:
          type: string
          description: Fee name
          example: TRANSACTION_FEE
        type:
          $ref: '#/components/schemas/FeeType'
        amount:
          $ref: '#/components/schemas/Amount'
        accountRef:
          $ref: '#/components/schemas/AccountRefFee'
        state:
          $ref: '#/components/schemas/FeeState'
    cassCounterChanged.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    ScheduledDate:
      type: string
      description: Date when the transaction is scheduled
    TransactionTypes:
      type: string
      enum:
      - sbLogin
      - sbLogout
      - sbRelogin
      - sbOpenConsumer
      - sbCardlessLogin
      - sbAccountMovement
      - sbAccountOverview
      - sbCheckCashing
      - sbDeposit
      - sbMixedMediaPayment
      - sbTransfer
      - sbWithdrawal
      - sbPinChange
      - sbPrestagedCashOut
      - sbPrestagedCashIn
      - sbEReceipt
      - sbLoadCustomerPreferences
      - sbSaveCustomerPreferences
      - sbAssistedWithdrawal
      - sbAssistedDeposit
      - sbLimitApproval
      - sbRequestSupport
      - sbCreditorSelection
      - withdrawal
      - balanceInquiry
      - transfer
      - purchase
      - deposit
      - payment
      - refund
      - purchaseCashback
      - cashDisbursement
      - consumerProfile
      - moneyTransferDebit
      - moneyTransferCredit
      - paymentDebit
      - paymentCredit
      - adjustmentDebit
      - adjustmentCredit
      - financialProfile
      - quasiCash
      - requestCurrencyExchangeRates
      description: Type of Transaction or BusinessCase performed
    ValidatedAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: Amount which has been validated
    DynamicCurrencyConversion:
      required:
      - mode
      - dccOverAllAmount
      - notDccOverallAmount
      - exchangeRate
      type: object
      properties:
        mode:
          $ref: '#/components/schemas/DynamicCurrencyConversionState'
        requestedCurrency:
          $ref: '#/components/schemas/RequestedCurrency'
        consumerAccountCurrency:
          $ref: '#/components/schemas/ConsumerAccountCurrency'
        notDccOverallAmount:
          allOf:
          - $ref: '#/components/schemas/AmountForeign'
          description: The overall amount without performing a currency conversion
        dccOverAllAmount:
          allOf:
          - $ref: '#/components/schemas/Amount'
          description: The overall amount post performing a currency conversion
        exchangeRate:
          $ref: '#/components/schemas/CurrencyExchangeRate'
    updateChecks.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    Pin:
      type: object
      required:
      - encryptedPin
      properties:
        encryptedPin:
          type: string
          description: Hex encoded value of PIN block
          example: B1D2AC6236D99348
        format:
          type: string
          description: Encryption format for provided PIN
          example: VISA_1
        zpkGeneration:
          type: string
          description: Generation of Zone PIN Key used to encrypt the PIN
          example: '2'
    Amount:
      description: "The basic type of an amount. \nAlways an unsigned value. \nThe host must perform operations on this value as per the context of the transaction.\n\ne.g. \nFor a withdrawal transaction, the value must be debited, whereas for a deposit transaction, the value must be credited.\n"
      type: object
      required:
      - value
      - currency
      properties:
        value:
          description: The amount value of the given currency.
          type: string
          pattern: '[0-9]{1,13}\.[0-9]{1,3}'
          minimum: 0
          example: '100.00'
        currency:
          description: Currency code
          type: string
          minLength: 3
          pattern: '[A-Z]{3,3}'
          example: USD
    EMVTags:
      type: string
      example: EMV_57
      enum:
      - ISSUER_SCRIPTS
      - ISSUER_SCRIPTS_RESULT
      - EMV_42
      - EMV_4F
      - EMV_50
      - EMV_57
      - EMV_5A
      - EMV_5F28
      - EMV_5F55
      - EMV_5F56
      - EMV_5F57
      - EMV_61
      - EMV_6F
      - EMV_70
      - EMV_73
      - EMV_77
      - EMV_80
      - EMV_81
      - EMV_82
      - EMV_83
      - EMV_84
      - EMV_86
      - EMV_87
      - EMV_88
      - EMV_89
      - EMV_8A
      - EMV_8B
      - EMV_8C
      - EMV_8D
      - EMV_8E
      - EMV_8F
      - EMV_90
      - EMV_91
      - EMV_92
      - EMV_93
      - EMV_94
      - EMV_95
      - EMV_97
      - EMV_98
      - EMV_99
      - EMV_9A
      - EMV_9B
      - EMV_9C
      - EMV_9D
      - EMV_5F20
      - EMV_5F24
      - EMV_5F25
      - EMV_5F2A
      - EMV_5F2D
      - EMV_5F30
      - EMV_5F34
      - EMV_5F36
      - EMV_5F50
      - EMV_5F53
      - EMV_5F54
      - EMV_9F01
      - EMV_9F02
      - EMV_9F03
      - EMV_9F04
      - EMV_9F05
      - EMV_9F06
      - EMV_9F07
      - EMV_9F08
      - EMV_9F09
      - EMV_9F0B
      - EMV_9F0D
      - EMV_9F0E
      - EMV_9F0F
      - EMV_9F10
      - EMV_9F11
      - EMV_9F12
      - EMV_9F13
      - EMV_9F14
      - EMV_9F15
      - EMV_9F16
      - EMV_9F17
      - EMV_9F18
      - EMV_9F19
      - EMV_9F1A
      - EMV_9F1B
      - EMV_9F1C
      - EMV_9F1D
      - EMV_9F1E
      - EMV_9F1F
      - EMV_9F20
      - EMV_9F21
      - EMV_9F22
      - EMV_9F23
      - EMV_9F24
      - EMV_9F26
      - EMV_9F27
      - EMV_9F2D
      - EMV_9F2E
      - EMV_9F2F
      - EMV_9F32
      - EMV_9F33
      - EMV_9F34
      - EMV_9F35
      - EMV_9F36
      - EMV_9F37
      - EMV_9F38
      - EMV_9F39
      - EMV_9F3A
      - EMV_9F3B
      - EMV_9F3C
      - EMV_9F3D
      - EMV_9F40
      - EMV_9F41
      - EMV_9F42
      - EMV_9F43
      - EMV_9F44
      - EMV_9F45
      - EMV_9F46
      - EMV_9F47
      - EMV_9F48
      - EMV_9F49
      - EMV_9F4A
      - EMV_9F4B
      - EMV_9F4C
      - EMV_9F4D
      - EMV_9F4E
      - EMV_9F4F
      - EMV_9F53
      - EMV_9F5B
      - EMV_A5
      - EMV_BF0C
      - EMV_C0
      - EMV_6E
      - EMV_E7
      - EMV_DF01
      - EMV_DF02
      - EMV_DF03
      - EMV_DF04
    CashInAmount:
      type: object
      allOf:
      - $ref: '#/components/schemas/Amount'
      description: The cash amount of the transaction
    mmp.processclearing.request:
      type: object
      required:
      - pointOfInteraction
      - payload
      - transaction
      properties:
        pointOfInteraction:
          $ref: '#/components/schemas/PointOfInteraction'
        transaction:
          $ref: '#/components/schemas/TransactionBase'
        payload:
          type: object
          properties:
            consumerId:
              $ref: '#/components/schemas/ConsumerId'
            card:
              $ref: '#/components/schemas/CardPan'
            emvRequest:
              type: array
              items:
                $ref: '#/components/schemas/EMVTagData'
            targetAccount:
              $ref: '#/components/schemas/TargetAccount'
            checkAmount:
              $ref: '#/components/schemas/CheckAmount'
            cashInAmount:
              $ref: '#/components/schemas/CashInAmount'
            checks:
              type: array
              items:
                $ref: '#/components/schemas/CheckDetails'
            debitAmount:
              $ref: '#/components/schemas/DebitAmount'
            creditAmount:
              $ref: '#/components/schemas/CreditAmount'
            account:
              $ref: '#/components/schemas/AccountMMP'
            fees:
              type: array
              items:
                $ref: '#/components/schemas/TransactionFee'
            clearingType:
              $ref: '#/components/schemas/ClearingType'
            additionalProperties:
              $ref: '#/components/schemas/AdditionalProperties'
            supplementaryData:
              $ref: '#/components/schemas/SupplementaryData'
    mmp.authorize.response:
      type: object
      allOf:
      - $ref: '#/components/schemas/ServiceResponse'
      - type: object
        required:
        - payload
        properties:
          payload:
            type: object
            properties:
              confirmationNumber:
                $ref: '#/components/schemas/ConfirmationNumber'
              hostResponseData:
                $ref: '#/components/schemas/HostResponseData'
              transaction:
                $ref: '#/components/schemas/TransactionResponse'
              cardHandlingIndicator:
                $ref: '#/components/schemas/CardHandlingIndicator'
              businessDate:
                $ref: '#/components/schemas/Date'
              emvResponse:
                type: array
                items:
                  $ref: '#/components/schemas/EMVTagData'
              checkLimit:
                $ref: '#/components/schemas/CheckLimit'
              cashInLimit:
                $ref: '#/components/schemas/CashInLimit'
              additionalProperties:
                $ref: '#/components/schemas/AdditionalProperties'
              supplementaryData:
                $ref: '#/components/schemas/SupplementaryData'
    AccountType:
      type: string
      enum:
      - UNSPECIFIED
      - GIRO
      - SAVINGS
      - SECURITIES_DEPOSIT
      - SAVINGS_SECURITIES_DEPOSIT
      - GIRO_SECURITIES_DEPOSIT
      - FIXED_TERM_DEPOSIT
      - CREDIT_CARD
      - LOAN
      - MORTGAGE
      - FOREIGN_CURRENCY
      - EXTERNAL
      - CHECKING
      - UNIVERSAL
      - SPENDING_POWER
      - FEE_COLLECTION_ACCOUNT
      - ATM
      - VENDOR
      - SHAREHOLDER
      - GENERAL_LEDGER
      - CASH_RESERVE
      - LOAN_DENIAL
      - LEASE
      - CONSUMER_LOAN
      - COMMERCIAL_LOAN
      - RETIREMENT_LOAN
      - EXTERNAL_LOAN
      - SHARE
      - INDIVIDUAL_RETIREMENT
      - CARD_PAN
      - HEALTH_SAVINGS
      - CREDIT
      - CREDIT_LINE
      - CERTIFIED_DEPOSIT
      - INSTALLMENT
      - OTHER
      - DEFAULT_INVESTMENT_ACCOUNT
      - CASH_BENEFIT
      - OTHER_LOAN
      - DEBIT_CARD
      - DEFERRED_DEBIT_CARD
      - CHARGE_ACCOUNT
      - PREPAID
      - EMPLOYEE_BENEFIT
      example: SAVINGS
      description: '| Symbolic name              | Comment                                                        | |----------------------------|----------------------------------------------------------------| | UNSPECIFIED                | Default value for unknown accounts.                              | | GIRO                       | Giro account.                                                  | | SAVINGS                    | Savings account.  | SECURITIES_DEPOSIT         | Depot of securities (shares and so on).                        | | SAVINGS_SECURITIES_DEPOSIT | Savings securities.                                            | | GIRO_SECURITIES_DEPOSIT    | Giro securities.                                               | | FIXED_TERM_DEPOSIT         | Fixed term deposit.                                            | | CREDIT_CARD                | Credit card account. (ISO 8583; MC DE.54->30 / VISA DE.54->30).| | LOAN                       | An account that covers a credit and its balance and movements. | | MORTGAGE                   | Security for a loan.                                           | | FOREIGN_CURRENCY           | An account that holds money in a foreign curreny.              | | EXTERNAL                   | An account that represents an account of a foreign institution.| | CHECKING                   | Checking account. (ISO 8583; MC DE.54->20 / VISA DE.54->20)    |  | UNIVERSAL                  | ISO 8583; VISA DE.54->40)                                      |  | SPENDING_POWER             | ISO 8583; VISA DE.54->64)                                      |  | FEE_COLLECTION_ACCOUNT     | used to collect fees                                           |  | ATM                        | ATM                                                            | | VENDOR                     | Vendor                                                         | | SHAREHOLDER                | Shareholder                                                    | | GENERAL_LEDGER             | General ledger                                                 | | CASH_RESERVE               | Cash Reserve Line of Credit                                    | | LOAN_DENIAL                | Load denial                                                    | | LEASE                      | Lease                                                          | | CONSUMER_LOAN              | Consumer loan                                                  | | COMMERCIAL_LOAN            | Cemercial loan                                                 | | RETIREMENT_LOAN            | Retirement loan                                                | | EXTERNAL_LOAN              | External loan                                                  | | SHARE                      | Share                                                          | | INDIVIDUAL_RETIREMENT      | Individual Retirement Account(IRA)                             |'
    Warning:
      type: object
      required:
      - warningCode
      - effectiveDate
      properties:
        effectiveDate:
          $ref: '#/components/schemas/Date'
        expirationDate:
          $ref: '#/components/schemas/Date'
        warningCode:
          type: string
          example: 94
          description: The warning code for warning.
        description:
          type: string
          description: The description for this warning.
        category:
          type: string
          description: The category for this warning.
    CheckDetailsWithImage:
      type: object
      allOf:
      - $ref: '#/components/schemas/CheckDetails'
      - type: object
        properties:
          checkImageBack:
            $ref: '#/components/schemas/CheckImage'
          checkImageFront:
            $ref: '#/components/schemas/CheckImage'
  examples:
    AddCheckResponse:
      value:
        responseCode: OK
        extendedResponse:
          code: OK
          message: OK
        payload:
          check:
            id: 7892480d0a1948099c71beffa823ed0e
            hostId: 442347823ebfad58676644aaaa432323
            transactionId: e025d7ee74db4ddcbfe4af45ca42327a
            checkActionCode: NONE
            deleted: false
            suspectedFraud: false
            micrReadIntegrity: GOOD
            micr: T123*****1390
            routingTransitNumber: '063100277'
            mediaState: OK
            printData: Dated March 23rd, 2024
            date: '2024-03-23'
            score: 0
            accountNumber: A0123456789
            checkNumber: '123456'
            courtesyAmount:
              value: '100.00'
              currency: USD
            micrAmount:
              value: '100.00'
              currency: USD
            userAmount:
              value: '100.00'
              currency: USD
            documentSequenceNumber: 1
            externalProcessingCode: '4'
            checkType: ON_US
            checkState: ENDORSED
            checkImageFront:
              image: SUkqAN*******AAAA
              imageType: JPEG
            checkImageBack:
              image: SUkqAN*******AAAA
              imageType: JPEG
    DepositFinishValidationRequestWithFeeAccepted:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: finishValidation
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          validatedAmount:
            value: '20.00'
            currency: USD
          fees:
          - name: Acquirer fee
            type: DIRECT_ACQUIRER_FEE
            amount:
              value: '1.00'
              currency: USD
            accountRef:
              accountNumber: C0123456789
              accountType: FEE_COLLECTION_ACCOUNT
              accountName: Fee account
              accountSubType: Fee account
            state: CONFIRMED
          accountingState: OK
          mediaStates:
          - state: OK
            media: NOTE
    WithdrawalAuthorizeRequestWithoutFee:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbWithdrawal
          operation: authorize
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          accountRef:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
          amount:
            value: '20.00'
            currency: USD
    CheckCashingValidateChecksResponse:
      value:
        payload:
          confirmationNumber: '998087999'
          hostResponseData:
            hostResponseCode: '00000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: Success
          cardHandlingIndicator: CHAINING_ALLOWED
          hostCheckAmount:
            value: '100.50'
            currency: USD
          hostCashBackAmount:
            value: '100.50'
            currency: USD
          accountInformation:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          checkValidationTransactionId: '808123458'
          checks:
          - id: A90A87312EE34C8CAE77BB0AEAB826F7
            hostId: 442347823ebfad58676644aaaa432323
            checkActionCode: NONE
            suspectedFraud: false
            deleted: false
            printData: Dated March 23rd, 2024
        responseCode: OK
    DepositProcessClearingRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: finishValidation
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          targetAccount:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
          cashInAmount:
            value: '20.00'
            currency: USD
          checkAmount:
            value: '20.00'
            currency: USD
          clearingType: CASH_AND_CHECK
    WithdrawalAuthorizeRequestWithFCCAccepted:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbWithdrawal
          operation: authorize
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          accountRef:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
          amount:
            value: '20.00'
            currency: EUR
          foreignCurrencyConversion:
            fccState: CONFIRMED
            amount:
              value: '20.00'
              currency: EUR
            amountInBaseCurrency:
              value: '25.00'
              currency: USD
            exchangeRate:
              baseCurrency: USD
              foreignCurrency: EUR
              directQuotation: false
              sell: true
              cash: true
              rate: 80
              decimals: 2
    WithdrawalAuthorizeResponseWithFCCConfirmNotRequired:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          businessDate: '2024-04-15'
          emvResponse:
            tag: ISSUER_DATA
            value: 72629F18040*****0000005
          accountInformation:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          foreignCurrencyConversion:
            fccState: CONF_NOT_REQUIRED
            amount:
              value: '20.00'
              currency: EUR
            amountInBaseCurrency:
              value: '25.00'
              currency: USD
            exchangeRate:
              baseCurrency: USD
              foreignCurrency: EUR
              directQuotation: false
              sell: true
              cash: true
              rate: 80
              decimals: 2
    CurrencyExchangeRatesResponseNotSupportedCurrencies:
      value:
        responseCode: OK
        payload:
          notSupportedCurrencyExchangeRates:
          - sourceCurrency: USD
            targetCurrency: CAD
            currencyExchangeRateCategory: CASH
    CheckCashingFinalizeRequest:
      value:
        payload:
          pointOfInteraction: null
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbCheckCashing
          operation: confirm
          consumerId: '7745'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          checkAmount:
            value: '150.00'
            currency: EUR
          itemMixUsed:
          - device:
              device: CASH_RECYCLING_CASSETTE_1_1
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 2
              dispensedToConsumerCount: 2
              remainingTotalCounter: 1013
          - device:
              device: CASH_RECYCLING_CASSETTE_1_2
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 1
              dispensedToConsumerCount: 1
              remainingTotalCounter: 999
          - device:
              device: CASH_RECYCLING_CASSETTE_1_3
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '2000'
              physicalType: NOTE
              dispensedCounter: 1
              dispensedToConsumerCount: 1
              remainingTotalCounter: 1006
          - device:
              device: CASH_RECYCLING_CASSETTE_1_4
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '5000'
              physicalType: NOTE
              dispensedCounter: 2
              dispensedToConsumerCount: 2
              remainingTotalCounter: 1004
          - device:
              device: CHECKIN_CASSETTE_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter:
            - retainCount: 1
          itemMixTotal:
          - device:
              device: CASHIN_CASSETTE_LEVEL2_1
              deviceState: OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
          - device:
              device: CASHOUT_RETRACT_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter: []
          - device:
              device: CASHIN_RETRACT_1
              deviceState: OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
            denomCounter: []
          - device:
              device: CASHOUT_REJECT_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter:
            - rejectCounter: 1
          - device:
              device: CASH_RECYCLING_CASSETTE_1_1
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 14
              dispensedToConsumerCount: 14
              remainingTotalCounter: 1011
              level4Count: 1011
          - device:
              device: CASH_RECYCLING_CASSETTE_1_2
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 2
              dispensedToConsumerCount: 2
              remainingTotalCounter: 998
              level4Count: 998
          - device:
              device: CASH_RECYCLING_CASSETTE_1_3
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '2000'
              physicalType: NOTE
              dispensedCounter: 7
              dispensedToConsumerCount: 6
              remainingTotalCounter: 1005
              level4Count: 1005
          - device:
              device: CASH_RECYCLING_CASSETTE_1_4
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '5000'
              physicalType: NOTE
              dispensedCounter: 3
              dispensedToConsumerCount: 3
              remainingTotalCounter: 1002
              level4Count: 1002
          - device:
              device: CHECKIN_CASSETTE_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter:
            - retainCount: 5
          - device:
              device: CHECKIN_RETRACT_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter: []
          accountingState: OK
          mediaStates:
          - state: OK
            media: CHECK
    CheckCashingFinishValidationResponse:
      value:
        payload:
          confirmationNumber: '998087999'
          hostResponseData:
            hostResponseCode: '00000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: Success
          cardHandlingIndicator: CHAINING_ALLOWED
        responseCode: OK
    TransferFinalizeRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbTransfer
          operation: confirm
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
            accountingState: OK
    WithdrawalFinalizeRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '270'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbWithdrawal
          operation: confirm
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          accountingState: OK
          accountRef:
            accountNumber: A0123456789
            accountType: CHECKING
            accountName: Your Checking Account
            accountSubType: Checking account
          amount:
            value: '20.00'
            currency: USD
          mediaStates:
          - state: OK
            media: NOTE
          itemMixUsed:
          - device:
              device: CASHOUT_CASSETTE_1_3
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: USD
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 2
              dispensedToConsumerCount: 2
              remainingTotalCounter: 169
          itemMixTotal:
          - device:
              device: CASHOUT_CASSETTE_1_1
              deviceState: OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
            denomCounter:
            - currency: USD
              denomination: '100'
              physicalType: NOTE
              dispensedCounter: 11
              dispensedToConsumerCount: 4
              remainingTotalCounter: 189
          - device:
              device: CASHOUT_CASSETTE_1_2
              deviceState: NOT_OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
            denomCounter:
            - currency: EUR
              denomination: '500'
              physicalType: NOTE
              dispensedCounter: 3
              remainingTotalCounter: 197
          - device:
              device: CASHOUT_CASSETTE_1_3
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: USD
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 31
              dispensedToConsumerCount: 26
              remainingTotalCounter: 169
          - device:
              device: CASHOUT_CASSETTE_1_5
              deviceState: NOT_OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
            denomCounter:
            - currency: USD
              denomination: '1'
              physicalType: NOTE
          - device:
              device: CASHOUT_CASSETTE_1_6
              deviceState: NOT_OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
            denomCounter:
            - currency: USD
              denomination: '5'
              physicalType: NOTE
          - device:
              device: CASHOUT_CASSETTE_1_7
              deviceState: NOT_OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
            denomCounter:
            - currency: USD
              denomination: '10'
              physicalType: NOTE
          - device:
              device: CASHOUT_CASSETTE_1_8
              deviceState: NOT_OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
            denomCounter:
            - currency: USD
              denomination: '25'
              physicalType: NOTE
          - device:
              device: CASHOUT_REJECT_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter:
            - rejectCounter: 15
          - device:
              device: CASHOUT_RETRACT_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter: []
    AddCashResponse:
      value:
        responseCode: OK
        extendedResponse:
          code: OK
          message: OK
        payload:
          accountRef:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Business Savings
    CheckCashingAuthorizeCashOutResponse:
      value:
        payload:
          confirmationNumber: '998087999'
          hostResponseData:
            hostResponseCode: '00000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: Success
          cardHandlingIndicator: CHAINING_ALLOWED
          businessDate: '2019-09-23'
          emvResponse:
          - tag: ISSUER_DATA
            value: 72629F18040*****0000005
        responseCode: OK
    LoginRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbLogin
          operation: process
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
    AddCashRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: addCash
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          accountRef:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Business Savings
          level3AmountList:
          - value: '0.00'
            currency: USD
          level4AmountList:
          - value: '20.00'
            currency: USD
          totalAmount:
            value: '20.00'
            currency: USD
          itemMixUsed:
          - device:
              device: CASHIN_CASSETTE_1_1
              deviceState: OPERATIONAL
            changeType: CASH_ADDED
            denomCounter:
            - currency: USD
              denomination: '2000'
              physicalType: NOTE
              level4Count: 1
    CheckCashingFinalizeResponse:
      value:
        payload:
          confirmationNumber: '998087999'
          hostResponseData:
            hostResponseCode: '00000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: Success
          cardHandlingIndicator: CHAINING_ALLOWED
        responseCode: OK
    ServiceResponseFailExample:
      value:
        responseCode: FAIL
        extendedResponse:
          code: SERVER_FAILURE
          message: SERVER_FAILURE
    CheckCashingFinishValidationRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbCheckCashing
          operation: finishValidation
        payload:
          consumerId: '7745'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          validatedAmount:
            value: '150.00'
            currency: EUR
          checks:
          - id: A90A87312EE34C8CAE77BB0AEAB826F7
            hostId: 442347823ebfad58676644aaaa432323
            transactionId: DN200VPFS01110840011151162741
            checkActionCode: NONE
            deleted: false
            suspectedFraud: false
            micrReadIntegrity: GOOD
            micr: T123*****1390
            mediaState: OK
            printData: Dated March 23rd, 2024
            date: '2024-03-23'
            score: 987
            checkNumber: '0'
            courtesyAmount:
              value: '150.00'
              currency: EUR
            checkState: OPEN
          accountingState: OK
          mediaStates:
          - state: NO_MEDIA
            media: CHECK
    CurrencyExchangeRatesRequestNotSupportedCurrencies:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbLogout
          operation: process
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          currencyExchangeRatePairs:
          - sourceCurrency: USD
            targetCurrency: CAD
            currencyExchangeRateCategory: CASH
    LoginResponse:
      value:
        responseCode: OK
        payload:
          enabledTransactions:
          - sbLogin
          - sbLogout
          - sbOpenConsumer
          - sbRelogin
          - sbCardlessLogin
          - sbAccountMovement
          - sbAccountOverview
          - sbCheckCashing
          - sbDeposit
          - sbMixedMediaPayment
          - sbTransfer
          - sbWithdrawal
          - sbPinChange
          - sbPrestagedCashOut
          - sbPrestagedCashIn
          - sbEReceipt
          - sbLoadCustomerPreferences
          - sbSaveCustomerPreferences
          - sbAssistedWithdrawal
          - sbAssistedDeposit
          - sbLimitApproval
          - sbRequestSupport
          - sbCreditorSelection
          - sbPaymentData
          - sbPrestagedDeposit
          accounts:
          - accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountSubType: Savings account
            accountName: Your Savings account
            instituteName: Bank
            amounts:
            - amountType: LEDGER_BALANCE
              currency: USD
              value: '100.20'
            - amountType: AVAILABLE_BALANCE
              currency: USD
              value: '100.20'
            accountOwnership: PRIMARY
            accountStatus: ACTIVE
            branchCode: '1234'
            openDate: '2024-01-01'
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: OK
          cardHandlingIndicator: CHAINING_ALLOWED
          consumerId: '123456'
    DepositFinalizeRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: confirm
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          checkAmount:
            value: '20.00'
            currency: USD
          cashInAmount:
            value: '20.00'
            currency: USD
          accountingState: OK
          mediaStates:
          - state: OK
            media: NOTE
          itemMixUsed:
          - device:
              device: CASHIN_CASSETTE_1_1
              deviceState: OPERATIONAL
            changeType: CASH_ADDED
            denomCounter:
            - currency: USD
              denomination: '2000'
              physicalType: NOTE
              level4Count: 1
          itemMixTotal:
          - device:
              device: CHECKIN_CASSETTE_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter:
            - retainCount: 2
          - device:
              device: CHECKIN_RETRACT_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter: []
          - device:
              device: CASHIN_CASSETTE_1_1
              deviceState: OPERATIONAL
            changeType: CASH_ADDED
            denomCounter:
            - currency: USD
              denomination: '100'
              physicalType: NOTE
              level4Count: 5
            - currency: USD
              denomination: '2000'
              physicalType: NOTE
              level4Count: 2
            - currency: USD
              denomination: '10000'
              physicalType: NOTE
              level4Count: 1
            - currency: USD
              denomination: '5000'
              physicalType: NOTE
              level4Count: 1
          - device:
              device: CASHIN_RETRACT_1
              deviceState: OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
            denomCounter:
            - retractCounter: 1
          - device:
              device: CASHIN_CASSETTE_LEVEL2_1
              deviceState: OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
          - device:
              device: CASHIN_CASSETTE_LEVEL3_1
              deviceState: OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
    UpdateChecksRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: updateChecks
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          checks:
          - id: 6b836323d16c44a5b1dea08947d7d1e1
            transactionId: 110a0f87a53e466ebf40f5f470cb4121
            checkActionCode: NONE
            deleted: false
            suspectedFraud: false
            micrReadIntegrity: GOOD
            micr: T123*****1390
            mediaState: OK
            date: '2024-04-15'
            documentSequenceNumber: 1
            accountNumber: A0123456789
            checkNumber: '123456'
            courtesyAmount:
              value: '100.00'
              currency: USD
            micrAmount:
              value: '100.00'
              currency: USD
            userAmount:
              value: '100.00'
              currency: USD
            externalProcessingCode: '4'
            checkType: ON_US
            checkState: OPEN
    DepositValidateResponseWithFCCConfirmNotRequired:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          hostCashBackAmount:
            currency: USD
            value: '4000.00'
          emvResponse:
            tag: ISSUER_DATA
            value: 72629F18040*****0000005
          accountInformation:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          foreignCurrencyConversion:
            fccState: CONF_NOT_REQUIRED
            amount:
              value: '20.00'
              currency: EUR
            amountInBaseCurrency:
              value: '25.00'
              currency: USD
            exchangeRate:
              baseCurrency: USD
              foreignCurrency: EUR
              directQuotation: false
              sell: true
              cash: true
              rate: 80
              decimals: 2
    DepositValidateResponseWithFCCConfirmRequired:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          hostCashBackAmount:
            currency: USD
            value: '4000.00'
          emvResponse:
            tag: ISSUER_DATA
            value: 72629F18040*****0000005
          accountInformation:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          foreignCurrencyConversion:
            fccState: CONFIRM_REQUIRED
            amount:
              value: '20.00'
              currency: EUR
            amountInBaseCurrency:
              value: '25.00'
              currency: USD
            exchangeRate:
              baseCurrency: USD
              foreignCurrency: EUR
              directQuotation: false
              sell: true
              cash: true
              rate: 80
              decimals: 2
    TransferFinalizeResponse:
      value:
        responseCode: OK
        payload:
          confirmationNumber: '99887999'
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: OK
          cardHandlingIndicator: CHAINING_ALLOWED
    WithdrawalAuthorizeResponseWithFee:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          businessDate: '2024-04-15'
          emvResponse:
            tag: ISSUER_DATA
            value: 72629F18040*****0000005
          accountInformation:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          fees:
          - name: Acquirer fee
            type: DIRECT_ACQUIRER_FEE
            amount:
              value: '1.00'
              currency: USD
            accountRef:
              accountNumber: C0123456789
              accountType: FEE_COLLECTION_ACCOUNT
              accountName: Fee account
              accountSubType: Fee account
            state: CONF_REQUIRED
    LogoutRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbLogout
          operation: process
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
    DepositFinishValidationResponseWithFee:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          fees:
          - name: Acquirer fee
            type: DIRECT_ACQUIRER_FEE
            amount:
              value: '1.00'
              currency: USD
            accountRef:
              accountNumber: C0123456789
              accountType: FEE_COLLECTION_ACCOUNT
              accountName: Fee account
              accountSubType: Fee account
            state: CONF_REQUIRED
    DepositProcessClearingResponse:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          emvResponse:
            tag: ISSUER_DATA
            value: 72629F18040*****0000005
          cashInClearingState: OK
          checkClearingState: OK
          accounts:
          - accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: LEDGER_BALANCE
              value: '100.50'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '100.50'
              currency: USD
    CurrencyExchangeRatesRequestSupportedCurrencies:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbLogout
          operation: process
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          currencyExchangeRatePairs:
          - sourceCurrency: USD
            targetCurrency: EUR
            currencyExchangeRateCategory: CASH
    DepositValidateRequestWithFCCCurrency:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: validateDeposit
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          targetAccount:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
          checkAmount:
            currency: EUR
            value: '20.00'
          cashInAmounts:
          - currency: EUR
            value: '20.00'
          foreignCurrencyConversionList:
          - amount:
              currency: EUR
              value: '20.00'
            amountInBaseCurrency:
              currency: USD
              value: '22.22'
            exchangeRate:
              baseCurrency: USD
              cash: true
              decimals: 2
              directQuotation: false
              foreignCurrency: EUR
              rate: 90
              sell: false
            fccState: CONFIRMED
          itemMixUsed:
          - changeType: NO_SOP_OPERATED_CHANGE
            denomCounter:
            - currency: EUR
              denomination: '2000'
              level4Count: 1
              physicalType: NOTE
              remainingTotalCounter: 1005
            device:
              device: CASH_RECYCLING_CASSETTE_1_3
              deviceState: OPERATIONAL
    WithdrawalFinalizeResponse:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: OK
          cardHandlingIndicator: OUT
    WithdrawalAuthorizeRequestWithFCC:
      value:
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          accountRef:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
          amount:
            value: '20.00'
            currency: EUR
    CheckCashingValidateChecksRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbCheckCashing
          operation: validateChecks
        payload:
          consumerId: '7745'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          transactionId: DN200VPFS01110840011151162741
          targetAccount:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
          cashBackAmount:
            value: '150.00'
            currency: EUR
          checkAmount:
            value: '150.00'
            currency: EUR
          checks:
          - id: A90A87312EE34C8CAE77BB0AEAB826F7
            transactionId: DN200VPFS01110840011151162741
            checkActionCode: NONE
            deleted: false
            suspectedFraud: false
            micrReadIntegrity: GOOD
            micr: T123*****1390
            mediaState: OK
            date: '2024-04-17'
            score: 987
            checkNumber: '0'
            courtesyAmount:
              value: '150.00'
              currency: EUR
            checkState: OPEN
    TransferAuthorizeRequestWithFee:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbTransfer
          operation: authorize
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          amount:
            value: '20.00'
            currency: USD
          accountRefFrom:
            accountNumber: A0123456789
            accountType: CHECKING
            accountName: CHECKING account
            accountSubType: Checking account
          accountRefTo:
            accountNumber: B0123456789
            accountType: LOAN
            accountName: Mortgage Loan
            accountSubType: Loan account
          scheduledDate: '2019-09-23'
          fees:
          - name: Acquirer fee
            type: DIRECT_ACQUIRER_FEE
            amount:
              value: '1.00'
              currency: USD
            accountRef:
              accountNumber: C0123456789
              accountType: FEE_COLLECTION_ACCOUNT
              accountName: Fee account
              accountSubType: Fee account
            state: CONFIRMED
    DepositAuthorizeRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: authorize
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          targetAccount:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
    DepositFinishValidationRequestWithoutFee:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: finishValidation
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
            checkValidationTransactionId: '808123458'
            validatedAmount:
              value: '20.00'
              currency: USD
            accountingState: OK
    WithdrawalAuthorizeResponseWithFCCConfirmRequired:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          businessDate: '2024-04-15'
          emvResponse:
            tag: ISSUER_DATA
            value: 72629F18040*****0000005
          accountInformation:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          foreignCurrencyConversion:
            fccState: CONFIRM_REQUIRED
            amount:
              value: '20.00'
              currency: EUR
            amountInBaseCurrency:
              value: '25.00'
              currency: USD
            exchangeRate:
              baseCurrency: USD
              foreignCurrency: EUR
              directQuotation: false
              sell: true
              cash: true
              rate: 80
              decimals: 2
    TransferAuthorizeRequestWithoutFee:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbTransfer
          operation: authorize
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          amount:
            value: '20.00'
            currency: USD
          accountRefFrom:
            accountNumber: A0123456789
            accountType: CHECKING
            accountName: CHECKING account
            accountSubType: Checking account
          accountRefTo:
            accountNumber: B0123456789
            accountType: SAVINGS
            accountName: SAVING account
            accountSubType: SAVING account
    DepositFinishValidationResponseWithoutFee:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
    WithdrawalAuthorizeResponseWithoutFee:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          businessDate: '2024-04-15'
          emvResponse:
            tag: ISSUER_DATA
            value: 72629F18040*****0000005
          accountInformation:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
    DepositAuthorizeResponse:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          businessDate: '2024-04-15'
          emvResponse:
            tag: ISSUER_DATA
            value: 72629F18040*****0000005
          accountInformation:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          checkLimit:
            value: '1000.00'
            currency: USD
          cashInLimit:
            value: '1000.00'
            currency: USD
    CheckCashingFinalizeCashOutResponse:
      value:
        payload:
          confirmationNumber: '998087999'
          hostResponseData:
            hostResponseCode: '00000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: Success
          cardHandlingIndicator: OUT
          accountInformation:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            amounts:
            - amountType: AVAILABLE_BALANCE
              value: '100.50'
              currency: USD
        responseCode: OK
    TransferAuthorizeResponseWithFee:
      value:
        responseCode: OK
        payload:
          confirmationNumber: '99887999'
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: OK
          cardHandlingIndicator: CHAINING_ALLOWED
          businessDate: '2020-05-23'
          fees:
          - name: Acquirer fee
            type: DIRECT_ACQUIRER_FEE
            amount:
              value: '1.00'
              currency: USD
            accountRef:
              accountNumber: C0123456789
              accountType: FEE_COLLECTION_ACCOUNT
              accountName: Fee account
              accountSubType: Fee account
            state: CONF_REQUIRED
          emvResponse:
          - tag: ISSUER_DATA
            value: 72629F18040*****0000005
          accountRefFrom:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: CHECKING
            accountName: CHECKING account
            accountSubType: Checking account
            instituteName: Bank
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          accountRefTo:
            accountNumber: B0123456789
            accountCurrency: USD
            accountType: LOAN
            accountName: Mortgage Loan
            accountSubType: Loan account
            instituteName: Bank
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          amount:
            value: '20.00'
            currency: USD
          remark: Some remark.
          senderName: AC Corp.
          receiverName: XYZ Ltd.
          orderId: order Id
          changeId: change Id
          scheduledDate: '2019-09-23'
          creationDate: '2024-03-01'
          referenceNumber: AF249934
    TransferAuthorizeResponseWithoutFee:
      value:
        responseCode: OK
        payload:
          confirmationNumber: '99887999'
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: OK
          cardHandlingIndicator: CHAINING_ALLOWED
          businessDate: '2024-04-15'
          emvResponse:
          - tag: ISSUER_DATA
            value: 72629F18040*****0000005
          accountRefFrom:
            accountNumber: A0123456789
            accountCurrency: USD
            accountType: CHECKING
            accountName: Your checking account
            accountSubType: Checking account
            instituteName: Bank
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          accountRefTo:
            accountNumber: B0123456789
            accountCurrency: USD
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
            instituteName: Bank
            amounts:
            - amountType: LEDGER_BALANCE
              value: '52.20'
              currency: USD
            - amountType: AVAILABLE_BALANCE
              value: '52.20'
              currency: USD
          amount:
            value: '100.50'
            currency: USD
          remark: Some remark.
          senderName: ABC Corp.
          receiverName: XYZ Ltd.
          referenceNumber: AF249934
    LogoutResponse:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: OK
    AddCheckRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: addCheck
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          check:
            id: 6b836323d16c44a5b1dea08947d7d1e1
            transactionId: 110a0f87a53e466ebf40f5f470cb4121
            checkActionCode: NONE
            deleted: false
            suspectedFraud: false
            micrReadIntegrity: GOOD
            micr: T123*****1390
            mediaState: OK
            date: '2024-03-23'
            documentSequenceNumber: 1
            accountNumber: A0123456789
            checkNumber: '123456'
            courtesyAmount:
              value: '100.00'
              currency: USD
            micrAmount:
              value: '100.00'
              currency: USD
            userAmount:
              value: '100.00'
              currency: USD
            externalProcessingCode: '4'
            checkType: ON_US
            checkState: OPEN
            checkImageFront:
              image: SUkqAN*******AAAA
              imageType: TIFF
            checkImageBack:
              image: SUkqAN*******AAAA
              imageType: TIFF
    CheckCashingAuthorizeRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbCheckCashing
          operation: authorize
        payload:
          consumerId: '7745'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          pin:
            encryptedPin: B1D2AC6236D99348
            format: VISA_1
    CheckCashingAuthorizeResponse:
      value:
        payload:
          confirmationNumber: '998087999'
          hostResponseData:
            hostResponseCode: '00000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: Success
          cardHandlingIndicator: CHAINING_ALLOWED
          businessDate: '2024-04-15'
          emvResponse:
          - tag: ISSUER_DATA
            value: 72629F18040*****0000005
        responseCode: OK
    CheckCashingAuthorizeCashOutRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbCheckCashing
          operation: authorizeCashOut
        payload:
          consumerId: '7745'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          requestedAmount:
            value: '150.00'
            currency: EUR
          account:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
    WithdrawalAuthorizeRequestWithFeeConfirmed:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbWithdrawal
          operation: authorize
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          accountRef:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
          amount:
            value: '20.00'
            currency: USD
          fees:
          - name: Acquirer fee
            type: DIRECT_ACQUIRER_FEE
            amount:
              value: '1.00'
              currency: USD
            accountRef:
              accountNumber: C0123456789
              accountType: FEE_COLLECTION_ACCOUNT
              accountName: Fee account
              accountSubType: Fee account
            state: CONFIRMED
    CheckCashingProcessClearingResponse:
      value:
        payload:
          confirmationNumber: '998087999'
          hostResponseData:
            hostResponseCode: '00000'
            hostTransactionTime: 2024-03-15T11:00:00+0530
            hostMessage: Success
          cardHandlingIndicator: CHAINING_ALLOWED
          emvResponse:
          - tag: ISSUER_DATA
            value: 72629F18040*****0000005
          checks:
          - id: A90A87312EE34C8CAE77BB0AEAB826F7
            hostId: '1449501664206'
            printData: Dated March 23rd, 2024
            checkState: PROCESSED_OK
        responseCode: OK
    DepositValidateRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbDeposit
          operation: validateDeposit
        payload:
          consumerId: '123456'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          targetAccount:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
          checkAmount:
            currency: EUR
            value: '20.00'
          cashInAmounts:
          - currency: EUR
            value: '20.00'
    CheckCashingFinalizeCashOutRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbCheckCashing
          operation: finalizeCashOut
        payload:
          consumerId: '7745'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          dispensedAmount:
            value: '150.00'
            currency: EUR
          requestedAmount:
            value: '150.00'
            currency: EUR
          account:
            accountNumber: A0123456789
            accountType: SAVINGS
            accountName: Your Savings account
            accountSubType: Savings account
          cashOutItemMixUsed:
          - device:
              device: CASH_RECYCLING_CASSETTE_1_1
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 2
              dispensedToConsumerCount: 2
              remainingTotalCounter: 1013
          - device:
              device: CASH_RECYCLING_CASSETTE_1_2
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 1
              dispensedToConsumerCount: 1
              remainingTotalCounter: 999
          - device:
              device: CASH_RECYCLING_CASSETTE_1_3
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '2000'
              physicalType: NOTE
              dispensedCounter: 1
              dispensedToConsumerCount: 1
              remainingTotalCounter: 1006
          - device:
              device: CASH_RECYCLING_CASSETTE_1_4
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '5000'
              physicalType: NOTE
              dispensedCounter: 2
              dispensedToConsumerCount: 2
              remainingTotalCounter: 1004
          cashOutItemMixTotal:
          - device:
              device: CASHIN_CASSETTE_LEVEL2_1
              deviceState: OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
          - device:
              device: CASHOUT_RETRACT_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter: []
          - device:
              device: CASHIN_RETRACT_1
              deviceState: OPERATIONAL
            changeType: NO_SOP_OPERATED_CHANGE
            denomCounter: []
          - device:
              device: CASHOUT_REJECT_1
              deviceState: OPERATIONAL
            changeType: ''
            denomCounter:
            - rejectCounter: 1
          - device:
              device: CASH_RECYCLING_CASSETTE_1_1
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 14
              dispensedToConsumerCount: 14
              remainingTotalCounter: 1011
              level4Count: 1011
          - device:
              device: CASH_RECYCLING_CASSETTE_1_2
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '1000'
              physicalType: NOTE
              dispensedCounter: 2
              dispensedToConsumerCount: 2
              remainingTotalCounter: 998
              level4Count: 998
          - device:
              device: CASH_RECYCLING_CASSETTE_1_3
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '2000'
              physicalType: NOTE
              dispensedCounter: 7
              dispensedToConsumerCount: 6
              remainingTotalCounter: 1005
              level4Count: 1005
          - device:
              device: CASH_RECYCLING_CASSETTE_1_4
              deviceState: OPERATIONAL
            changeType: CASH_REMOVED
            denomCounter:
            - currency: EUR
              denomination: '5000'
              physicalType: NOTE
              dispensedCounter: 3
              dispensedToConsumerCount: 3
              remainingTotalCounter: 1002
              level4Count: 1002
          accountingState: OK
          mediaStates:
          - state: OK
            media: NOTE
    CurrencyExchangeRatesResponseSupportedCurrencies:
      value:
        responseCode: OK
        payload:
          exchangeRateDefs:
          - directQuotation: false
            baseCurrency: USD
            foreignCurrency: EUR
            rateSell: 84
            rateBuy: 82
            decimals: 2
            currencyExchangeRateCategory: CASH
    CheckCashingProcessClearingRequest:
      value:
        pointOfInteraction:
          clientId: '123'
          institutionId: '1234'
          branchCode: ''
          tellerId: ''
          clientTransactionDate: '0415'
          clientTransactionTime: '074133'
          channel: selfService
          address:
            street: Mainstreet
            streetno: '119'
            city: New York City
            zipcode: N5467
            countrycode: USA
            state: New York
            longitude: 0
            latitude: 0
        transaction:
          id: '212423521525'
          transactionTime: 2024-04-15T10:00:32+0000
          poiSettlementDate: '0415'
          businessCorrelationId: 0394757d955e4a6890bcc1f559936474
          type: sbCheckCashing
          operation: processClearing
        payload:
          consumerId: '7745'
          card:
            bestMatchedElement: TRACK_2
            pan: '4490739000000895'
            track2: 4490739000000895D161222366
            emvData:
            - tag: EMV_57
              value: 673336XXXXXXXXX1005D2005201XXXXXXXXXXF
            cardSequenceNumber: '05'
            expiryDate: '2407'
            consumerGroup: OnUsCard
          checkAmount:
            value: '150.00'
            currency: EUR
          checks:
          - id: A90A87312EE34C8CAE77BB0AEAB826F7
            hostId: 442347823ebfad58676644aaaa432323
            transactionId: DN200VPFS01110840011151162741
            checkActionCode: NONE
            deleted: false
            suspectedFraud: false
            micrReadIntegrity: GOOD
            micr: T123*****1390
            mediaState: OK
            printData: Dated March 23rd, 2024
            date: '2024-03-23'
            score: 987
            checkNumber: '0'
            courtesyAmount:
              value: '150.00'
              currency: EUR
            checkState: OPEN
    UpdateChecksResponse:
      value:
        responseCode: OK
        extendedResponse:
          code: OK
          message: OK
    DepositFinalizeResponse:
      value:
        responseCode: OK
        payload:
          confirmationNumber: 998a87999
          hostResponseData:
            hostResponseCode: '000'
            hostTransactionTime: 2024-04-15T10:00:32+0000
            hostMessage: ''
          cardHandlingIndicator: CHAINING_ALLOWED
          emvResponse:
            tag: ISSUER_DATA
            value: 72629F18040*****0000005
          deleteChecks: false
  parameters:
    timestamp:
      name: timestamp
      in: header
      description: timestamp of the transaction
      required: true
      schema:
        type: string
        format: yyyy-MM-dd'T'HH:mm:ssZ
        description: Timestamp
        example: 2020-09-01T16:40:52+0000
    initiatingPartyName:
      name: initiatingPartyName
      in: header
      description: The name of the initiating party.
      required: true
      schema:
        type: string
        minLength: 1
        example: DieboldNixdorf
    version:
      name: version
      in: header
      description: Version of DN Open Backend API being used.
      required: true
      schema:
        type: string
        minLength: 1
        example: 4.3.0
    referenceId:
      name: referenceId
      in: header
      description: Unique identifier for the transaction request.
      required: true
      schema:
        type: string
        example: A123F34
    productName:
      name: productName
      in: header
      description: The name of the product which is consuming the service (business product name).
      required: true
      schema:
        type: string
        minLength: 1
        example: Transaction Middleware
    authorization:
      name: Authorization
      in: header
      description: 'In case the Authentication type is BASIC_AUTH, Authorization will contain base 64 encoded userName:password string using HTTP Basic Authentication.<br> In case the Authentication Type is JWE/TOKEN, Authorization will contain token received using getToken request as Bearer Token. '
      schema:
        type: string
        example: Basic afae1wad213da OR Bearer T2131241
    initiatingPartyId:
      name: initiatingPartyId
      in: header
      description: Identifier of the party that has initiated this transaction, in this case Diebold Nixdorf's ID.
      required: true
      schema:
        type: string
        minLength: 1
        example: DieboldNixdorf
  securitySchemes:
    basic:
      type: http
      description: Authorization will contain base 64 encoded userName:password string
      scheme: basic
    bearer:
      type: http
      description: Authorization will contain token received using getToken request as Bearer Token
      scheme: bearer
      bearerFormat: Any string
    jweBearer:
      type: http
      description: Authorization will contain Bearer encryptedJWT. JWT will be encrypted with backend endpoint public key
      scheme: bearer
      bearerFormat: Any string
externalDocs:
  url: /docs
  description: Find more information here