openapi: 3.2.0
info:
  title: Citi Payments API
  x-refined-note:
  - x-ibm-name differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged Payments across 4 of this provider''s published API definitions: citi-payment-reconfirmation-openapi.yaml, citi-paymentcancellation-json-openapi.yaml, express_payments_api.yaml, ukraine_payment_service_initiation_api.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://tts.apib2b.citi.com/citiconnect/prod/paymentservices/v3
  description: production gateway URL
- url: https://tts.apib2b.citi.com/citiconnect/sb/paymentservices/v3
  description: sandbox URL
- url: https://b2b.api.icg.citi.com/citiconnect/prod
  description: production gateway url
- url: https://sandbox.b2b.api.icg.citi.com/citiconnect/sb
  description: 'sbox url '
- url: https://b2b.tts.icgservices.citi.com/citiconnect/openbanking/ukr/paymentconsentservices/v1
  description: production gateway url
- url: https://sanbox.tts.icgservices.citi.com/citiconnect/openbanking/ukr/paymentconsentservices/v1
  description: sbox url
tags:
- name: Payments
paths:
  /payments/reconfirmations:
    post:
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fi_response'
            application/xml:
              schema:
                $ref: '#/components/schemas/fi_response'
              example: <?xml version="1.0" encoding="UTF-8"?><TxInfAndSts><TxSts>RJCT</TxSts><AddtlInf>Transaction Not Found</AddtlInf></TxInfAndSts>
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                errors:
                - action: Please provide valid value for either uetr or (citi_reference/instruction_id with interbank_settlement_date).
                  issue: uetr/citi_reference/instruction_id cannot be null or empty.
                http_code: 400
                status: FAILED
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                errors:
                - action: Please try again with valid credentials.
                  issue: Authorization failed.
                http_code: 401
                status: FAILED
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                errors:
                - action: Please use valid Http Verb.
                  issue: Method not allowed.
                http_code: 405
                status: FAILED
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                errors:
                - action: Resend request in valid format.
                  issue: provided content-type of the request is not valid.
                http_code: 415
                status: FAILED
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                errors:
                - action: Please try again after sometime.
                  issue: unable to process your request at this moment.
                http_code: 500
                status: FAILED
      parameters:
      - description: This field used to identify request is for reconfirm/reject (Example - RECNFRM / RJCTCNFRM) FI Payments.
        in: header
        name: request_type
        required: true
        schema:
          type: string
          maxLength: 12
      - description: Unique reference which was shared during CitiConnect API on-boarding(client_id which used during oauth token generation)
        in: query
        name: client_id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/fi_reconfirmation_request'
          application/xml:
            schema:
              $ref: '#/components/schemas/fi_reconfirmation_request'
            example: <?xml version="1.0" encoding="UTF-8"?><TransacService><InstrId>2009360588</InstrId><ReqdExctnDt>2020-09-25</ReqdExctnDt><Rsn>DUPL</Rsn></TransacService>
        required: true
      operationId: fiPaymentReconfirmation
      summary: Payment Reconfirmation
      description: This API allows you to initiate reconfirm/reject FI payments in JSON and XML format.
      tags:
      - Payments
      security:
      - clientCredentials: []
        Client ID: []
    servers:
    - url: https://tts.apib2b.citi.com/citiconnect/prod/paymentservices/v3
      description: production gateway URL
    - url: https://tts.apib2b.citi.com/citiconnect/sb/paymentservices/v3
      description: sandbox URL
  /payments/stops:
    post:
      summary: Payment Cancellation
      description: 'This API specification document provides descriptions of the request and response parameters for JSON content.


        The FI cancellation API lets you stop or recall payment requests against FI payments in payment insight. It supports custom JSON & ISO XML (camt.056.001.09) format. Initiating an FI Cancellation API using the CitiConnect API requires a well-defined POST request where you can specify the endpoint URL to call the API. Additionally, you need to specify the values for input parameters in the body of your JSON/XML document. Finally, you will encrypt the payload, place it in your request and send it via your application.'
      operationId: FICancellationAPI
      parameters:
      - name: client_id
        in: query
        required: true
        description: This is your unique identifier shared during your CitiConnect API onboarding. This is the same `client_id` used for OAuth token generation
        schema:
          type: string
      - name: Content-type
        in: header
        description: Supports \"application/json\".
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        description: The OAuth Token prefixed with "Bearer" and space in between.
        required: true
        schema:
          type: string
      - name: request_type
        description: Operation name. The possible value for this header is STOP_REQUEST.
        in: header
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK > Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fi_cancellation_response'
              example:
                transaction_status:
                  status: ACCP
                  type: Your request has been registered. We will notify you once the transaction is stopped/recalled.
        '400':
          description: BAD REQUEST
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_2'
              example:
                status: FAILED
                http_code: 400
                errors:
                - issue: uetr/citi_reference/instruction_id cannot be null or empty.
                  action: Please provide valid value for either UETR or (citi_reference/instruction_id with interbank_settlement_date).
        '401':
          description: UNAUTHORIZED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_2'
              example:
                status: FAILED
                http_code: 401
                errors:
                - issue: Authorization failed.
                  action: Please try again with valid credentials.
        '404':
          description: NOT FOUND
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_2'
              example:
                status: FAILED
                http_code: 404
                errors:
                - issue: Not found
                  action: Please check the URL and try again later.
        '405':
          description: METHOD NOT ALLOWED
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_2'
              example:
                status: FAILED
                http_code: 405
                errors:
                - issue: Method not allowed.
                  action: Please use valid HTTP supported verb only.
        '415':
          description: FORBIDDEN
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_2'
              example:
                status: FAILED
                http_code: 415
                errors:
                - issue: Provided content-type of the request is not valid.
                  action: Resend request in valid format.
        '500':
          description: INTERNAL SERVER ERROR
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response_2'
              example:
                status: FAILED
                http_code: 500
                errors:
                - issue: Unable to process your request at this moment.
                  action: Please try again after sometime.
      security:
      - clientCredentials: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/fi_cancellation_request'
        description: Describes the request body.
        required: true
      tags:
      - Payments
    servers:
    - url: https://tts.apib2b.citi.com/citiconnect/prod/paymentservices/v3
      description: production gateway URL
    - url: https://tts.apib2b.citi.com/citiconnect/sb/paymentservices/v3
      description: sandbox URL
  /paymentservices/v1/payments:
    post:
      tags:
      - Payments
      summary: Initiate an outgoing instant payment credit transfer
      description: This endpoint validates your request and synchronously responds with HTTP status 202 (accepted) after successful validation. If validation fails, the endpoint synchronously responds with error (HTTP status 4XX / 5XX and any applicable ISO 20022 reason code), indicating Citi couldn't accept your transaction initiation request.
      operationId: expressPaymentInitiation
      parameters:
      - name: client_id
        in: query
        required: true
        schema:
          type: string
        description: Your unique identification, same as the identification you use for OAuth token generation, Citi shared with you during your CitiConnect API onboarding
        example: 6d3cf821-db6d-496d-bec0-064a362e9c31
      - name: Idempotency-Id
        in: header
        required: true
        schema:
          type: string
          maxLength: 128
        example: a44cbb606de4edb9a7a123414bba3bb
        description: "Your unique identification for a POST request \n - Maximum length is 128. \n-  CitiConnect API responds with an error (HTTP status 4XX) if your POST request idempotency identification value is a duplicate across a recent history of idempotency identifications in Citi's database. \n- If you don't receive any response (HTTP status 2XX, 4XX or 5XX) from Citi to your POST request and you wish to retry, reinitiate your request with the same idempotency identification to prevent accidental duplicate payment."
      requestBody:
        required: true
        description: This endpoint validates your request and synchronously responds with HTTP status 202 (accepted) after successful validation. If validation fails, the endpoint synchronously responds with error (HTTP status 4XX / 5XX and any applicable ISO 20022 reason code), indicating Citi couldn't accept your transaction initiation request.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Payment-Initiation-Request'
            examples:
              TH Proxy Credit Transfer:
                $ref: '#/components/examples/Th-Proxy-Payment-Initiation-Request-Example'
              TH Account Credit Transfer:
                $ref: '#/components/examples/Th-Account-Payment-Initiation-Request-Example'
              US Credit Transfer:
                $ref: '#/components/examples/Us-Payment-Initiation-Request-Example'
              IN IMPS Credit Transfer:
                $ref: '#/components/examples/In-Imps-Payment-Initiation-Request-Example'
              IN IMPS FIR Credit Transfer:
                $ref: '#/components/examples/In-Imps-Fir-Payment-Initiation-Request-Example'
              UK FPS Credit Transfer:
                $ref: '#/components/examples/Uk-Payment-Initiation-Request-Example'
              IN UPI Credit Transfer:
                $ref: '#/components/examples/In-Upi-Payment-Initiation-Request-Example'
              IN NEFT Credit Transfer:
                $ref: '#/components/examples/In-Neft-Payment-Initiation-Request-Example'
              US Wire Credit Transfer:
                $ref: '#/components/examples/Us-Wire-Payment-Initiation-Request-Example'
              US ACH CCD/PPD Credit Transfer:
                $ref: '#/components/examples/Us-Ach-Ccd-Payment-Initiation-Request-Example'
              US ACH IAT Credit Transfer:
                $ref: '#/components/examples/Us-Ach-Iat-Payment-Initiation-Request-Example'
              JP Credit Transfer:
                $ref: '#/components/examples/Jp-Payment-Initiation-Request-Example'
              SEPA Credit Transfer:
                $ref: '#/components/examples/SEPA-AllFields-Payment-Initiation-Request-Example'
              SEPA Credit Mandatory Transfer:
                $ref: '#/components/examples/SEPA-MandatoryFields-Payment-Initiation-Request-Example'
              AU Credit Transfer:
                $ref: '#/components/examples/AU-Payment-Initiation-Request-Example'
              MX DFT Credit Transfer:
                $ref: '#/components/examples/MX-DFT-Payment-Initiation-Request-Example'
              MX BKT Credit Transfer:
                $ref: '#/components/examples/MX-BKT-Payment-Initiation-Request-Example'
              AR IP Credit Transfer:
                $ref: '#/components/examples/AR-IP-Payment-Initiation-Request-Example'
              UK BACS Credit Transfer:
                $ref: '#/components/examples/UK-BACS-Initiation-Request-Example'
      security:
      - oAuth2:
        - paymentservices
      callbacks:
        Payment-Notification:
          $ref: '#/components/callbacks/Payment-Notification'
      responses:
        '202':
          description: Accepted
          headers:
            request_id:
              schema:
                type: string
              description: Citi's unique identification for your request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payments'
              examples:
                TH Credit Transfer Response:
                  $ref: '#/components/examples/Payment-Initiation-Response-Example'
                US Credit Transfer Response:
                  $ref: '#/components/examples/Us-Payment-Initiation-Response-Example'
                IN IMPS Credit Transfer Response:
                  $ref: '#/components/examples/In-Imps-Payment-Initiation-Response-Example'
                IN IMPS Fir Credit Transfer Response:
                  $ref: '#/components/examples/In-Imps-Fir-Payment-Initiation-Response-Example'
                UK FPS Credit Transfer Response:
                  $ref: '#/components/examples/Uk-Payment-Initiation-Response-Example'
                Proxy-Transaction-Post:
                  $ref: '#/components/examples/Proxy-Transaction-Post'
                IN UPI Credit Transfer Response:
                  $ref: '#/components/examples/In-Upi-Payment-Initiation-Response-Example'
                IN NEFT Credit Transfer Response:
                  $ref: '#/components/examples/In-Neft-Payment-Initiation-Response-Example'
                JP Credit Transfer Response:
                  $ref: '#/components/examples/Jp-Payment-Initiation-Response-Example'
                US Wire Credit Transfer Response:
                  $ref: '#/components/examples/Us-Wire-Payment-Initiation-Response-Example'
                US Ach Credit Transfer Response:
                  $ref: '#/components/examples/Us-Ach-Payment-Initiation-Response-Example'
                SEPA Credit Transfer Response:
                  $ref: '#/components/examples/SEPA-AllFields-Payment-Initiation-Response-Example'
                AU Credit Transfer Response:
                  $ref: '#/components/examples/AU-Payment-Initiation-Response-Example'
                MX DFT Credit Transfer Response:
                  $ref: '#/components/examples/MX-DFT-Payment-Initiation-Response-Example'
                MX BKT Credit Transfer Response:
                  $ref: '#/components/examples/MX-BKT-Payment-Initiation-Response-Example'
                AR IP Credit Transfer Response:
                  $ref: '#/components/examples/AR-IP-Payment-Initiation-Response-Example'
                UK BACS Credit Transfer Response:
                  $ref: '#/components/examples/UK-BACS-Initiation-Response-Example'
        '400':
          $ref: '#/components/responses/Bad-Request'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '409':
          $ref: '#/components/responses/Conflict'
        '415':
          $ref: '#/components/responses/Unsupported-Media-Type'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        default:
          $ref: '#/components/responses/Internal-Server-Error'
    get:
      tags:
      - Payments
      summary: Inquire for the latest status of transations matching additional parameters
      description: '-Get the latest statuses of payment transactions using matching criteria. Currently, you can get the latest transactions statuses up to 90 days from the payment initiation date. If the latest transactions statuses date is 90+ days old, the endpoint responds with HTTP status 404 (not found).

        -You can use this endpoint to pull the transactions of all payment methods that includes Wires, ACH, and IP. For ACH and Wires, use the end_to_end_id to pull the transactions.'
      operationId: findPayments
      parameters:
      - name: client_id
        in: query
        required: true
        schema:
          type: string
        description: Your unique identification, same as the identification you use for OAuth token generation, Citi shared with you during your CitiConnect API onboarding
        example: 6d3cf821-db6d-496d-bec0-064a362e9c31
      - name: encrypted-params
        in: header
        description: 'Encrypt the key values as below. Debtor account or creditor account is mandatory.



          * **debtor_account:** Your Citi account for instant payment (debit) / outgoing


          * **creditor_account:** Your Citi account for instant payment (credit) / incoming


          * **debtor_proxy_id:** Debtor proxy identification - For US RTP Instant Payment - debtor_proxy_id header param is not applicable


          * **creditor_proxy_id:** Creditor proxy identification - For US RTP Instant Payment - creditor_proxy_id header param is not applicable


          * **debtor_virtual_account:** Your Citi virtual account for instant payment (debit) / outgoing - For US RTP Instant Payment - debtor_virtual_account header param is not applicable


          * **creditor_virtual_account:** Your Citi virtual account for instant payment (credit) / incoming - For US RTP Instant Payment - creditor_virtual_account header param is not applicable


          ***Sample header before encryption:*** {"debtor_account":"3001386964","creditor_proxy_id":"a93d@gmail.com"}

          '
        schema:
          type: string
          pattern: \w*\W*
          example: eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.D4yD0xv7xuoy_YmFaz29dz85QejaLNI9EtlsiOIAP4v6v4hVFwHLx_Ad_pZoLNhc6lx_H2YPnxUcMem76UkO6kjQ849azAnC7WLAxlm_ytMCmuTsZTkhBoX3BHsgD4nmQ-6QhpklVmH8nz3czk6HVmJ5BYrtA6Q4N96bCaCCYkEDCrPLK6NHmTyBeKmRIe6LBzmia6Ct20ovHCU-juj_YPBsQGfqrMTrdSDInts_5DbmL49Q1eDRAeuU7vcSgl_ROJ54BHo-XwiZFuvUUXt5NIP4wxF0phoJ4oWk9VyFIgt29wG2Lht2WX5_0S8KIve9sBoOZIYHylK6YkUTk6FXMg.2hlCJTgnxZRsIqXwDhiMtg.X8HL_J5q9v7UQ-PX_JadGRte2grVQjbZ2Ep2k3kSKmjVuOam4OyZ8I429o-2xNHT9XrcH1RdNMfKC4QhfrtFXYlf39BzAmP89IWRilH_ez-HRy4CoainozRO0SjRzB2ZWgOQvr2J3UkvriHSLfYJEqA7reXcEWvifaISe-c_eh_zWaCqEOfe53oTPlcyjl9_lXGaIm07GMT-JQuPkYTDRVG2cV41bYAfrDjJFtbTwM7RAy0LAAtZxLCyRE5s8AHyFqsp6D_xtq5sjjy2UnfmMSp1sDwA0uwmAWNrH1orgr7JaPxzRa3zSIEeMoUN4SnAMwLPYhI65LnvdQjRo91M_ttqEr1CGJ1B_qkw9wSRV0rwe3Gmq12NmGLIe-khMPDXezI3toVY5urd8XeFMhqUeZBwzkR2NQvqTN3wOwgB_sMyG_Q27-LwwIXKDNxmGhZErLV73228dD2qSfiBwpGtEPz-keiN0cTFQJj4GM5ZrKNfx2Q_PDJZdP3eVDcUelpJooRiCl2DKWhNmBFQ4haGoVUSj6g88V_7_I6RQHC4s3EEG3rlVaoutzwyjrfp05vGg_8FiIcocGXnbUrBQa8-ZQ.K2RGIyBtuBoCfoDACIOYrA
      - name: end_to_end_id
        in: query
        description: Transaction identification provided by the debtor
        schema:
          $ref: '#/components/schemas/Restricted-Finx-Max-Text'
        examples:
          payment_transaction_details_1:
            value: 1L00IF2BCWUZF09
      - name: network_id
        in: query
        description: Transaction reference generated for or by a network (e.g., PromptPay)
        schema:
          type: string
          maxLength: 36
        examples:
          payment_transaction_details_1:
            value: '209323283934'
      - name: batch_id
        in: query
        description: Identification for your Citi account consolidated debit or credit posting for the transactions
        schema:
          type: string
          maxLength: 35
        examples:
          payment_transaction_details_1:
            value: '492084893'
      - name: creation_date_time_start
        in: query
        description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Start of date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Start of date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created"
        schema:
          $ref: '#/components/schemas/Iso-Normalised-Date-Time'
        examples:
          payment_transaction_details_1:
            value: '2022-09-13T08:23:49.114Z'
      - name: creation_date_time_end
        in: query
        description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - End of date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - End of date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created"
        schema:
          $ref: '#/components/schemas/Iso-Normalised-Date-Time'
        examples:
          payment_transaction_details_1:
            value: '2022-09-13T08:23:49.554Z'
      - name: instructed_amount
        in: query
        description: Instructed amount
        schema:
          type: number
          maximum: 1000000000000000
        examples:
          payment_transaction_details_1:
            value: 73945.27
      - name: settlement_amount
        in: query
        description: Settlement amount (e.g., after any currency exchange or charge on the instructed amount)
        schema:
          type: number
          maximum: 1000000000000000
        examples:
          payment_transaction_details_1:
            value: 50000.23
      - name: status_date_time_start
        in: query
        description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment - Start date time of the transaction status change (when CitiConnect API change the status of the transaction)"
        schema:
          $ref: '#/components/schemas/Iso-Normalised-Date-Time'
        examples:
          payment_transaction_details_1:
            value: '2022-09-13T08:23:49.224Z'
      - name: status_date_time_end
        in: query
        description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment - Start end time of the transaction status change (when CitiConnect API change the status of the transaction)"
        schema:
          $ref: '#/components/schemas/Iso-Normalised-Date-Time'
        examples:
          payment_transaction_details_1:
            value: '2022-09-13T08:23:49.331Z'
      - name: status_code
        in: query
        description: ISO 20022 transaction status code
        schema:
          type: string
          enum:
          - ACTC
          - PDNG
          - RJCT
          - ACCC
          - ACWP
        examples:
          payment_transaction_details_1:
            value: ACCC
      - name: debtor_account_last4
        in: query
        description: Last 4 digits of a debtor account in combination with your Citi creditor account
        examples:
          payment_transaction_details_1:
            value: '6373'
        schema:
          type: string
          pattern: ^[0-9]{4}$
      - name: creditor_account_last4
        in: query
        description: Last 4 digits of a creditor account number in combination with your Citi debtor account
        examples:
          payment_transaction_details_1:
            value: 0783
        schema:
          type: string
          pattern: ^[0-9]{4}$
      - $ref: '#/components/parameters/Off-Set-Param'
      - $ref: '#/components/parameters/Limit-Param'
      security:
      - oAuth2:
        - paymentservices
      responses:
        '200':
          description: Payment status
          headers:
            request_id:
              schema:
                type: string
              description: Citi's unique identification for your request
            result:
              schema:
                type: integer
                minimum: 1
                maximum: 1000
                default: 100
              description: Number of transaction status matching your request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payments-Response'
              examples:
                TH Status - Completed:
                  $ref: '#/components/examples/Ok-Response-Multiple'
                TH Status - Rejected:
                  $ref: '#/components/examples/Ok-Response-Failed-Multiple'
                US Status - Completed:
                  $ref: '#/components/examples/Us-Ok-Response-Multiple'
                US Status - Rejected:
                  $ref: '#/components/examples/Us-Ok-Response-Failed-Multiple'
                IN Status - Completed:
                  $ref: '#/components/examples/In-Ok-Response-Multiple'
                IN Status - Rejected:
                  $ref: '#/components/examples/In-Ok-Response-Failed-Multiple'
                IN UPI Status - Completed:
                  $ref: '#/components/examples/In-Upi-Ok-Response-Multiple'
                IN UPI Status - Rejected:
                  $ref: '#/components/examples/In-Upi-Ok-Response-Multiple-Failed'
                IN IMPS Fir Status - Completed:
                  $ref: '#/components/examples/In-Imps-Fir-Ok-Response-Multiple'
                IN IMPS Fir Status - Rejected:
                  $ref: '#/components/examples/In-Imps-Fir-Ok-Response-Multiple-Failed'
                UK FPS Status - Completed:
                  $ref: '#/components/examples/Uk-Ok-Response-Multiple'
                Uk FPS Status - Rejected:
                  $ref: '#/components/examples/Uk-Ok-Response-Failed-Multiple'
                JP Status - Completed:
                  $ref: '#/components/examples/Jp-Ok-Response-Multiple'
                JP Status - Rejected:
                  $ref: '#/components/examples/Jp-Ok-Response-Failed-Multiple'
                US WIRE Status - Completed:
                  $ref: '#/components/examples/US-WIRE-Ok-Response-Multiple'
                US WIRE Status - Rejected:
                  $ref: '#/components/examples/US-WIRE-Ok-Response-Multiple-Failed'
                US ACH Status - Completed:
                  $ref: '#/components/examples/Us-Ach-Ok-Response-Multiple'
                US ACH Status - Rejected:
                  $ref: '#/components/examples/Us-Ach-Ok-Response-Multiple-Failed'
                Payer-Id-Transaction-Get:
                  $ref: '#/components/examples/Payer-Id-Transaction-Get-Multiple'
                QR_account_transaction_GET:
                  $ref: '#/components/examples/Qr-Transaction-Get-Multiple'
                Proxy-Transaction-Get:
                  $ref: '#/components/examples/Proxy-Transaction-Get-Multiple'
                SEPA IDP Pending:
                  $ref: '#/components/examples/SEPA-IDP-Pending'
                SEPA IDP Completed:
                  $ref: '#/components/examples/SEPA-IDP-Completed'
                SEPA Status - Rejected:
                  $ref: '#/components/examples/SEPA-Ok-Reject'
                SEPA Status - Completed:
                  $ref: '#/components/examples/SEPA-Ok-Completed'
                IN NEFT Status - Completed:
                  $ref: '#/components/examples/In-Neft-Ok-Response-Multiple'
                IN NEFT Status - Rejected:
                  $ref: '#/components/examples/In-Neft-Ok-Response-Multiple-Failed'
                IN IMPS Get Status - Completed:
                  $ref: '#/components/examples/In-IMPS-Get-Response-Completed'
                IN IMPS Get Status - Rejected:
                  $ref: '#/components/examples/In-IMPS-Get-Response-Rejected'
                SEPA VoP Status - Completed:
                  $ref: '#/components/examples/SEPA-VoP-Ok-Completed'
                SEPA VoP Status - Rejected:
                  $ref: '#/components/examples/SEPA-VoP-Nok-Completed'
                AU Status - Completed:
                  $ref: '#/components/examples/AU-Ok-Completed-Status'
                AU Status - Rejected:
                  $ref: '#/components/examples/AU-Nok-Rejected'
                MX DFT Status - Completed:
                  $ref: '#/components/examples/MX-DFT-Status-Get-Response-Completed'
                MX DFT Status - Rejected:
                  $ref: '#/components/examples/MX-DFT-Status-Get-Response-Rejected'
                MX BKT Status - Completed:
                  $ref: '#/components/examples/MX-BKT-Status-Get-Response-Completed'
                MX BKT Status - Rejected:
                  $ref: '#/components/examples/MX-BKT-Status-Get-Response-Rejected'
                AR IP Status - Completed:
                  $ref: '#/components/examples/AR-IP-Status-Get-Response-Completed'
                AR IP Status - Rejected:
                  $ref: '#/components/examples/AR-IP-Status-Get-Response-Rejected'
                UK BACS Status - Rejected:
                  $ref: '#/components/examples/UK-BACS-Reject-Example'
        '400':
          $ref: '#/components/responses/Bad-Request'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        default:
          $ref: '#/components/responses/Internal-Server-Error'
    servers:
    - url: https://b2b.api.icg.citi.com/citiconnect/prod
      description: production gateway url
    - url: https://sandbox.b2b.api.icg.citi.com/citiconnect/sb
      description: 'sbox url '
  /paymentservices/v1/payments/{uetr}:
    get:
      tags:
      - Payments
      summary: Inquire for the latest status of a transaction using UETR
      description: Get the latest status of a payment transaction using unique end-to-end transaction reference (UETR). Currently, you can get the latest transaction status up to 90 days from the payment initiation date. If the latest transaction status date is 90+ days old, the endpoint responds with HTTP status 404 (not found).
      operationId: findPaymentByUetr
      parameters:
      - name: client_id
        in: query
        required: true
        schema:
          type: string
        description: Your unique identification, same as the identification you use for OAuth token generation, Citi shared with you during your CitiConnect API onboarding
        example: 6d3cf821-db6d-496d-bec0-064a362e9c31
      - name: uetr
        in: path
        description: Unique end-to-end transaction reference
        required: true
        schema:
          type: string
          pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
        examples:
          payment_transaction_details_1:
            value: 0c4fb98b-d77a-4468-96bb-0c88b3b8f75a
      security:
      - oAuth2:
        - paymentservices
      responses:
        '200':
          description: OK
          headers:
            request_id:
              schema:
                type: string
              description: Citi's unique identification for your request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payments'
              examples:
                TH Status - Completed:
                  $ref: '#/components/examples/Ok-Response'
                TH Status - Rejected:
                  $ref: '#/components/examples/Ok-Response-Failed'
                US Status - Completed:
                  $ref: '#/components/examples/Us-Ok-Response'
                US Status - Rejected:
                  $ref: '#/components/examples/Us-Ok-Response-Failed'
                UK Status - Completed:
                  $ref: '#/components/examples/Uk-Ok-Response'
                UK Status - Rejected:
                  $ref: '#/components/examples/Uk-Ok-Response-Failed'
                IN Status - Completed:
                  $ref: '#/components/examples/In-Ok-Response'
                IN Status - Rejected:
                  $ref: '#/components/examples/In-Ok-Response-Failed'
                IN UPI Status - Completed:
                  $ref: '#/components/examples/In-Upi-Ok-Response'
                IN UPI Status - Rejected:
                  $ref: '#/components/examples/In-Upi-Ok-Response-Failed'
                IN IMPS Fir Status - Completed:
                  $ref: '#/components/examples/In-Imps-Fir-Ok-Response'
                IN IMPS Fir Status - Rejected:
                  $ref: '#/components/examples/In-Imps-Fir-Ok-Response-Failed'
                JP Status - Completed:
                  $ref: '#/components/examples/Jp-Ok-Response'
                JP Status - Rejected:
                  $ref: '#/components/examples/Jp-Ok-Response-Failed'
                US WIRE Status - Completed:
                  $ref: '#/components/examples/US-WIRE-Ok-Response'
                US WIRE Status - Rejected:
                  $ref: '#/components/examples/US-WIRE-Ok-Response-Failed'
                US ACH Status - Completed:
                  $ref: '#/components/examples/Us-Ach-Ok-Response'
                US ACH Status - Rejected:
                  $ref: '#/components/examples/Us-Ach-Ok-Response-Failed'
                Payer-Id-Transaction-Get:
                  $ref: '#/components/examples/Payer-Id-Transaction-Get'
                Qr-Transaction-Get:
                  $ref: '#/components/examples/Qr-Transaction-Get'
                Proxy-Transaction-Get:
                  $ref: '#/components/examples/Proxy-Transaction-Get'
                SEPA IDP Pending:
                  $ref: '#/components/examples/SEPA-IDP-Pending-Status'
                SEPA IDP Completed:
                  $ref: '#/components/examples/SEPA-IDP-Completed-Status'
                SEPA Status - Rejected:
                  $ref: '#/components/examples/SEPA-Ok-Reject-Status'
                SEPA Status - Completed:
                  $ref: '#/components/examples/SEPA-Ok-Completed-Status'
                IN NEFT Status - Completed:
                  $ref: '#/components/examples/In-Neft-Ok-Response'
                IN NEFT Status - Rejected:
                  $ref: '#/components/examples/In-Neft-Ok-Response-Failed'
                SEPA VoP Status - Completed:
                  $ref: '#/components/examples/SEPA-VoP-Ok-Completed-Status'
                SEPA VoP Status - Rejected:
                  $ref: '#/components/examples/SEPA-VoP-Nok-Completed-Status'
                AU Status - Completed:
                  $ref: '#/components/examples/AU-Ok-Completed'
                AU Status - Rejected:
                  $ref: '#/components/examples/AU-Nok-Rejected-status'
                MX DFT Status - Completed:
                  $ref: '#/components/examples/MX-DFT-Status-Single-Get-Response-Completed'
                MX DFT Status - Rejected:
                  $ref: '#/components/examples/MX-DFT-Status-Single-Get-Response-Rejected'
                MX BKT Status - Completed:
                  $ref: '#/components/examples/MX-BKT-Status-Single-Get-Response-Completed'
                MX BKT Status - Rejected:
                  $ref: '#/components/examples/MX-BKT-Status-Single-Get-Response-Rejected'
        '400':
          $ref: '#/components/responses/Bad-Request'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/Not-Found'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed'
        '500':
          $ref: '#/components/responses/Internal-Server-Error'
        default:
          $ref: '#/components/responses/Internal-Server-Error'
    servers:
    - url: https://b2b.api.icg.citi.com/citiconnect/prod
      description: production gateway url
    - url: https://sandbox.b2b.api.icg.citi.com/citiconnect/sb
      description: 'sbox url '
  /payments:
    post:
      tags:
      - Payments
      summary: Make a payment
      description: Initiate payments, manage payment consents, retrieve payment status, and perform secure open banking inquiries.
      servers:
      - url: https://b2b.tts.icgservices.citi.com/citiconnect/openbanking/ukr/paymentconsentservices/v1
      operationId: makePayment
      parameters:
      - $ref: '#/components/parameters/Consent-Id'
      - $ref: '#/components/parameters/Request-ID'
      - $ref: '#/components/parameters/PSU-IP-Address'
      - $ref: '#/components/parameters/TPP-Code'
      - $ref: '#/components/parameters/Date'
      requestBody:
        description: Payment instruction payload to initiate a payment.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PaymentPostRequest'
      responses:
        '201':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalPaymentIdResponse'
        '400':
          $ref: '#/components/responses/Bad-Request_2'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found_2'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed_2'
        '409':
          $ref: '#/components/responses/Conflict_2'
        '415':
          $ref: '#/components/responses/Unsupported-Media-Type_2'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error_2'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
        '504':
          $ref: '#/components/responses/Gateway-Timeout'
      security:
      - oAuth:
        - authenticationservices/v1
    servers:
    - url: https://b2b.tts.icgservices.citi.com/citiconnect/openbanking/ukr/paymentconsentservices/v1
      description: production gateway url
    - url: https://sanbox.tts.icgservices.citi.com/citiconnect/openbanking/ukr/paymentconsentservices/v1
      description: sbox url
  /payments/{payment-Id}:
    get:
      operationId: getPayment
      tags:
      - Payments
      summary: Get a payment
      description: TPP can call this API from Financial Institutions to retrieve complete details, latest processing state, and status history for a previously submitted payment instruction using the unique payment identifier.
      servers:
      - url: https://b2b.tts.icgservices.citi.com/citiconnect/openbanking/ukr/paymentconsentservices/v1
      parameters:
      - $ref: '#/components/parameters/Consent-Id'
      - $ref: '#/components/parameters/Request-ID'
      - $ref: '#/components/parameters/PSU-IP-Address'
      - $ref: '#/components/parameters/TPP-Code'
      - $ref: '#/components/parameters/Payment-Id'
      - $ref: '#/components/parameters/Date'
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalPaymentIdResponse'
        '400':
          $ref: '#/components/responses/Bad-Request_2'
        '401':
          $ref: '#/components/responses/Unauthorized_2'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/Not-Found_2'
        '405':
          $ref: '#/components/responses/Method-Not-Allowed_2'
        '409':
          $ref: '#/components/responses/Conflict_2'
        '415':
          $ref: '#/components/responses/Unsupported-Media-Type_2'
        '429':
          $ref: '#/components/responses/Too-Many-Requests'
        '500':
          $ref: '#/components/responses/Internal-Server-Error_2'
        '503':
          $ref: '#/components/responses/Service-Unavailable'
        '504':
          $ref: '#/components/responses/Gateway-Timeout'
      security:
      - oAuth:
        - authenticationservices/v1
    servers:
    - url: https://b2b.tts.icgservices.citi.com/citiconnect/openbanking/ukr/paymentconsentservices/v1
      description: production gateway url
    - url: https://sanbox.tts.icgservices.citi.com/citiconnect/openbanking/ukr/paymentconsentservices/v1
      description: sbox url
components:
  schemas:
    transaction_status_detail:
      properties:
        status:
          description: This field  indicates the status of the reconfirm/reject or cancel/recall request with set of values. for example- ACCP for Accepted or RJCT for Rejected
          maxLength: 4
          type: string
          xml:
            name: TxSts
        type:
          description: This field provides additional information of the transaction when it is rejected/accepted.
          maxLength: 500
          type: string
          xml:
            name: AddtlInf
      type: object
      xml:
        name: TxInfAndSts
    fi_response:
      properties:
        transaction_status:
          $ref: '#/components/schemas/transaction_status_detail'
      type: object
    fi_reconfirmation_request:
      properties:
        citi_reference:
          description: This field specifies the Product processor Reference Number for the transaction that needs to be reconfirm/reject. UETR or citi_reference with interbank_settlement_date or instruction_id with interbank_settlement_date is mandatory.
          maxLength: 32
          type: string
          xml:
            name: ClrSysRef
        instruction_id:
          description: This is a unique instrution id that identifies a transaction that needs to be reconfirm/reject. UETR or citi_reference with interbank_settlement_date or instruction_id with interbank_settlement_date is mandatory.
          maxLength: 35
          type: string
          xml:
            name: InstrId
        interbank_settlement_date:
          description: This field specifies the value date (yyyy-MM-dd) of the original transaction that needs to be reconfirm/reject (the date on which funds were credited to the account).
          format: date
          type: string
          xml:
            name: ReqdExctnDt
        reason:
          description: This is the five digits reconfirm/reject code (Example DUPL) which is specified by the  customer to request to reconfirm/reject the transaction
          maxLength: 5
          type: string
          xml:
            name: Rsn
        uetr:
          description: Unique End-to-end Transaction Reference (UETR) relating to a payment has been identified as being associated with a Request for reconfirm/reject. It should follow UUID version 4 format. UETR or citi_reference with interbank_settlement_date or instruction_id with interbank_settlement_date is mandatory.
          type: string
          xml:
            name: UETR
      required:
      - reason
      type: object
      xml:
        name: TransacService
    error_response:
      properties:
        errors:
          description: Indicates actual error details with issues and corresponding actions to resolve the issue
          items:
            $ref: '#/components/schemas/ErrorDetail'
          xml:
            wrapped: true
        http_code:
          description: Indicates http status code to specify http response status
          format: int32
          pattern: ^[0-9]{3}$
          type: integer
        status:
          description: This field  indicates the status of the reconfirm/reject or cancel/recall request with set of values. for example- FAILED
          maxLength: 6
          type: string
      type: object
    ErrorDetail:
      properties:
        action:
          description: corrective action to be taken to resolve above issue
          maxLength: 350
          type: string
        issue:
          description: more details about the  issue
          maxLength: 200
          type: string
      type: object
      xml:
        name: error
    transaction_status_detail_2:
      type: object
      properties:
        status:
          type: string
          description: This parameter indicates the status of the cancel/recall request with set of values. for example - ACCP for Accepted or RJCT for Rejected.
          maxLength: 4
        type:
          type: string
          description: This parameter provides additional information of the transaction when it is rejected/accepted.
          maxLength: 500
    error_response_2:
      type: object
      description: Error response body.
      properties:
        status:
          type: string
          description: This parameter indicates the status of the reconfirm/reject or cancel/recall request with set of values. for example- FAILED.
          maxLength: 6
        http_code:
          type: integer
          description: Indicates http status code to specify http response. status
          format: int32
          pattern: ^[0-9]{3}$
        errors:
          type: array
          description: Indicates actual error details with issues and corresponding actions to resolve the issue.
          items:
            $ref: '#/components/schemas/ErrorDetail_2'
          xml:
            wrapped: true
    fi_cancellation_response:
      type: object
      description: Describes the response body in custom JSON format.
      properties:
        transaction_status:
          $ref: '#/components/schemas/transaction_status_detail_2'
    fi_cancellation_request:
      type: object
      properties:
        uetr:
          type: string
          format: uuid
          description: Unique End-to-end Transaction Reference (UETR) relating to a payment has been identified as being associated with a Request for Cancellation. It should follow UUID version 4 format. UETR or citi_reference with interbank_settlement_date or end_to_end_id / instruction_id with interbank_settlement_date is mandatory.
          minLength: 1
          maxLength: 32
        citi_reference:
          type: string
          description: This parameter specifies the product processor reference number for the transaction that needs to be cancelled or recalled. UETR or citi_reference with interbank_settlement_date or end_to_end_id / instruction_id with interbank_settlement_date is mandatory.
          maxLength: 32
        end_to_end_id:
          type: string
          description: This is a unique end-to-end reference number that identifies a transaction that needs to be cancelled. UETR or citi_reference with interbank_settlement_date or end_to_end_id / instruction_id with interbank_settlement_date is mandatory.
          maxLength: 16
        instruction_id:
          type: string
          description: This is a unique end-to-end instruction id that identifies a transaction that needs to be cancelled. UETR or citi_reference with interbank_settlement_date or end_to_end_id / instruction_id with interbank_settlement_date is mandatory.
          maxLength: 16
        interbank_settlement_date:
          type: string
          description: This parameter specifies the value date (yyyy-MM-dd) of the original transaction that needs to be cancelled or recalled (the date on which funds were credited to the account).
          format: date
        reason:
          type: string
          description: This is the four digits cancellation code (Example - DUPL) which is specified by the customer to request to cancel the transaction.
          maxLength: 4
        reason_description:
          type: string
          description: Further details on the request reason. Required for CUST and MS03 reason codes applicable to Stop services.
          maxLength: 150
      required:
      - reason
    ErrorDetail_2:
      type: object
      properties:
        issue:
          type: string
          description: More details about the issue.
          maxLength: 200
        action:
          type: string
          description: Corrective action to be taken to resolve above issue.
          maxLength: 350
      xml:
        name: error
    Method-Initiation:
      type: object
      title: MethodInitiation
      required:
      - country
      - instructed_currency
      - method
      properties:
        country:
          description: ISO 3166 Alpha-2 code for the transaction country
          type: string
          enum:
          - TH
          - US
          - IN
          - GB
          - JP
          - IE
          - DE
          - AT
          - BE
          - FI
          - FR
          - GR
          - IT
          - LU
          - NL
          - PT
          - ES
          - SK
          - AU
          - MX
          - AR
          - BR
          - HK
          - BG
          title: country
        instructed_currency:
          description: ISO 4217 code for the transaction instructed amount currency
          type: string
          enum:
          - THB
          - USD
          - INR
          - GBP
          - JPY
          - EUR
          - AUD
          - MXN
          - ARS
          - BRL
          - HKD
          - CNY
          title: instructed_currency
        method:
          description: "Method specified by the debtor for the transaction \n- Provide IP for instant payment \n- For India provide either IMPS or UPI \n - Provide WIRE for US Wire  payment \n - Provide ACH for US ACH payment \n- Provide NEFT for india NEFT payment"
          type: string
          enum:
          - IP
          - IMPS
          - UPI
          - WIRE
          - ACH
          - NEFT
          - BKT
          title: method
        network:
          type: string
          enum:
          - RTP
          - FDN
          - AUNPP
          description: Financial market infrastructure or clearing system (e.g., RTP Network in the United States)
          title: network
    Proxy-Id:
      maxLength: 255
      type: string
      description: "Specifies a character string with a maximum length of 128 characters.\n - For TH Instant payment debtor.proxy_id is optional \n - For US Instant payment debtor.proxy_id is not applicable \n - For IN IMPS debtor.proxy_id is not applicable \n - For UK FPS Instant payment debtor.proxy_id is not applicable \n - For JP Instant payment debtor.proxy_id is not applicable \n - For IN UPI Instant payment debtor.proxy_id is mandatory, applicable value VPA ID \n - For US Wire and ACH CCD/PPD/IAT debtor.proxy_id is not applicable \n - For SEPA IDP payment debtor.proxy_id is optional \n - For SEPA, debtor.proxy_id is optional \n - For Japan Instant payment debtor.proxy_id is not applicable"
      title: Proxy-Id
    Reasons:
      type: array
      readOnly: false
      items:
        $ref: '#/components/schemas/Reason'
    tax-information:
      type: object
      title: tax_information
      properties:
        creditor_vat_branch_code:
          type: string
          maxLength: 5
          minLength: 1
          description: Code identifying the VAT branch of the receiver for this specific tax record.
          title: creditor_vat_branch_code
        income_type:
          type: string
          maxLength: 3
          minLength: 1
          description: Code categorizing the type of income as defined by the Revenue Department.
          title: income_type
        vat_amount:
          type: number
          minimum: 0.01
          maximum: 100000000000000000000
          description: The VAT amount for this particular taxable income set
          title: vat_amount
        taxable_amount:
          type: number
          minimum: 0.01
          maximum: 100000000000000000000
          description: The amount of income that is subject to tax for this specific set.
          title: taxable_amount
        wht_tax_amount:
          type: number
          minimum: 0.01
          maximum: 100000000000000000000
          description: The Withholding Tax amount for this particular taxable income set.
          title: wht_tax_amount
        wht_description:
          type: string
          maxLength: 1
          minLength: 1
          description: The condition or type of eWHT applicable to this record (e.g., R, A, O).
          title: wht_description
        debtor_vat_branch_code:
          type: string
          maxLength: 5
          minLength: 1
          description: Code identifying the VAT branch of the sender for this specific tax record.
          title: debtor_vat_branch_code
    Error-Response:
      type: object
      title: ErrorResponse
      xml:
        name: ErrorResponse
      properties:
        ref_id:
          type: string
          maxLength: 60
          description: Unique ID for the Transaction
          title: ref_id
          xml:
            name: RefId
        error_details:
          type: array
          items:
            $ref: '#/components/schemas/Error-Detail'
          title: error_details
          xml:
            name: Errordetails
    Instructed-Agent-Status:
      type: object
      title: InstructedAgent
      properties:
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Instructed Agent/creditor Agent member Identification ID or BIC of a clearing system. \n - For TH Instant payment instructed_agent.bank_id field is not applicable \n - For US Instant payment instructed_agent.bank_id field is not applicable \n - For IN IMPS Instant payment instructed_agent.bank_id field is not applicable  \n - For UK FPS Instant payment instructed_agent.bank_id field is not applicable \n - For IN UPI Instant payment instructed_agent.bank_id field is not applicable \n - For US Wire, instructed_agent.bank_id is not applicable \n - For US ACH CCD/PPD payment, instructed_agent.bank_id is not applicable \n - For US ACH IAT payment, instructed_agent.bank_id is not applicable \n - For SEPA IDP instructed_agent.bank_id field is mandatory with max length 11 \n - For Japan Instant payment instructed_agent.bank_id field is not applicable \n - For SEPA, instructed_agent.bank_id field is mandatory with max length 11"
          title: bank_id
    Restricted-Finx-Max-Text:
      maxLength: 35
      minLength: 1
      pattern: ^(?!\s*$).+
      type: string
      description: "Specifies a character string with a maximum length of 35 characters limited to character set X, that is, a-z A-Z / - ? : ( ) . , ‘ + .  \n- If client_id + end_to_end_id combination is duplicate within 90 days, payment will be rejected \n - Thailand Max length 12 \n - United State Max length 35 \n - IN IMPS Max length 16 \n - UK FPS Max length is 18 \n - Brazil Max length is 35 \n - IN UPI Max length 16 \n - For US WIRE/ACH, Max length is 16 and allowed value is AlphaNumeric (A-Z and 0-9) \n - For SEPA and SEPA IDP Max length is 35 \n - Japan Max length 35. It allows only upper alphabet characters A-Z and accepts special characters as follows . , () -"
      title: Restricted-Finx-Max-Text
    Creditor-Status:
      type: object
      title: CreditorStatus
      properties:
        proxy_id:
          maxLength: 255
          minLength: 1
          type: string
          description: "Creditor's proxy identification (e.g., email address) \n- Thailand PromptPay - If you don't provide account, proxy_id is required. \n - For US Instant payment creditor.proxy_id field is not applicable \n - For IN IMPS creditor.proxy_id field is not applicable \n - For UK FPS Instant payment creditor.proxy_id field is not applicable \n - For IN UPI Instant payment creditor.proxy_id is mandatory and applicable value VPA ID, if creditor.account and creditor.bank_id is not provided by client \n - For US Wire, creditor.proxy_id field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.proxy_id is not applicable \n - For SEPA, creditor.proxy_id is optional \n - For Japan Instant payment creditor.proxy_id field is not applicable"
          title: proxy_id
        payer_id:
          maxLength: 40
          minLength: 1
          type: string
          description: "Creditor's Payer ID \n- For SEPA, creditor.payer_id is optional and maxLength is 40 \n- Thailand PromptPay creditor.payer_id field is not applicable \n - For US Instant payment creditor.payer_id field is not applicable \n - For IN IMPS creditor.payer_id field is not applicable \n - For UK FPS Instant payment creditor.payer_id field is not applicable \n - For IN UPI Instant payment creditor.payer_id is not applicable \n - For US Wire, creditor.payer_id field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.payer_id is not applicable \n - For Japan Instant payment creditor.payer_id field is not applicable"
          title: payer_id
        proxy_type:
          type: string
          enum:
          - BIID
          - EMAL
          - EWAL
          - MBNO
          - NIDN
          - COTS
          - IBAN
          - PAYR
          - SVID
          description: "Creditor's proxy type (BIID for bill identification, EMAL for email address, EWAL for electronic wallet identification, MBNO for mobile number, NIDN for national identification, COTS for tax identification, IBAN for internetational bank account number and PAYR for payer identification) \n- Thailand PromptPay - if you provide proxy_id, proxy_type is required.If creditor proxy_type is 'BIID', require client to mandatorily provide 'bill_id_1' value. \n - For US Instant payment creditor.proxy_type field is not applicable \n - For IN IMPS creditor.proxy_type field is not applicable \n - For UK FPS Instant payment creditor.proxy_type field is not applicable \n - For IN UPI creditor.proxy_type field is not applicable \n - For US Wire, creditor.proxy_type field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.proxy_type is not applicable \n- For SEPA IDP, creditor.proxy_type is optional \n - For Japan Instant payment creditor.proxy_type field is not applicable \n- For SEPA, creditor.proxy_type is optional"
          title: proxy_type
        tax_id:
          maxLength: 128
          minLength: 1
          type: string
          description: "Creditor's tax identification \n - For TH Instant payment creditor.tax_id field is optional \n - For US Instant payment creditor.tax_id field is not applicable \n - For IN IMPS creditor.tax_id field is not applicable \n - For UK FPS Instant payment creditor.tax_id field is not applicable \n - For JP Instant payment creditor.tax_id field is not applicable  \n - For IN UPI creditor.tax_id field is not applicable \n - For US Wire, creditor.tax_id is not appliable \n - For US ACH CCD/PPD/IAT payment, creditor.tax_id is not applicable \n- For SEPA IDP, this field is not applicable \n- For SEPA, this field is not applicable"
          title: tax_id
        account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Creditor's bank account \n- Thailand PromptPay - If you don't provide proxy_id, account and bank_id is required \n - For US Instant payment creditor.account field is mandatory \n - For IN IMPS creditor.account field is mandatory with max length 34 \n - For UK FPS Instant payment creditor.account field is mandatory and allowed max length is 34, Client can pass either account number or IBAN/BBAN number \n - For IN UPI creditor.account field is mandatory with max length 34, if creditor.proxy_id is not provided by client \n - For US Wire, creditor.account is a mandatory field with max length is 34 and allowed value is Virtual account number. \n - For US ACH CCD/PPD/IAT payment, creditor.account is a mandatory field with max length is 34 and allowed value is Virtual account number. \n - For SEPA IDP creditor.account field is mandatory with max length 34 \n - For Japan Instant payment creditor.proxy_type field is mandatory and allowed max length is 7 \n - For SEPA, creditor.account field is mandatory with max length 34"
          title: account
        virtual_account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Creditor's virtual account (also kown as PAYER ID) \n - For TH Instant payment creditor.virtual_account field is optional \n - For US Instant payment creditor.virtual_account field is not applicable \n - For IN IMPS creditor.virtual_account field is not applicable \n - For UK FPS Instant payment creditor.virtual_account field is not applicable \n - For JP Instant payment creditor.virtual_account field is applicable \n - For IN UPI creditor.virtual_account field is not applicable \n - For US Wire, creditor.virtual_account is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.virtual_account is not applicable \n- For SEPA IDP, this field is not applicable \n- For SEPA, this field is not applicable"
          title: virtual_account
        name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Creditor's name \n- Thailand PromptPay - Maximum length is 50. \n- For US Instant payment creditor.name is manadtory - Maximum length is 140 \n- For IN IMPS  creditor.name is mandatory - Maximum length is 50 \n- For UK FPS Instant payment creditor.name field is mandatory - Maximum length is 40 \n- For IN UPI creditor.name is mandatory - Maximum length is 99 \n - For-US Wire, creditor.name is a mandatory field with max length 35 \n - For US ACH CCD/PPD payment, creditor.name is a mandatory field with max length is 22 \n - For US ACH IAT payment, creditor.name is a mandatory field with max length is 35 \n - For SEPA IDP creditor.name is mandatory with max length 70 \n - For Japan Instant payment creditor.name field is mandatory \n - For SEPA, creditor.name is mandatory with max length 70"
          title: name
        address_lines:
          type: array
          description: "Creditor's address_lines \n - For TH Instant payment creditor.address_lines is not applicable \n - For US Instant payment creditor.address_lines is optional \n - For IN IMPS creditor.address_lines field is optional and allowed  seven instance with each line max length of 70 \n - For UK FPS Instant payment creditor.address_lines field is optional and allowed only four instance with each line max length of 35 \n - For IN UPI creditor.address_lines field is optional and allowed  seven instance with each line max length of 70 \n - For US Wire payment, creditor.address_lines field is conditional and upto 3 lines of min 1 and max 35 characters are allowed. Partial addresses will not be accepted, Street name, city and country should present in address_line. address_lines should present only if structured address tags (street name, building number, city, state and postal code) are not present \n - For US ACH CCD/PPD/IAT payment, creditor.address_lines is mandatory when structured address lines fields are not provided and allowed three instance with each line max length of 35, Address Line 1 should have Building info followed by asterik, Street Address ends with a single backslash \n Address Line 2 and then application to check  Address Line2 should have City followed by asterik, State ends with a single backslash Address Line 3 should have Zip Code followed by asterik, Country Code ends with a single backslash For example Zip code*US\\ \n - For SEPA IDP creditor.address_lines is optional \n - For Japan Instant payment creditor.address_lines field is not applicable \n - For SEPA, creditor.address_lines is optional and maxLength is 70"
          items:
            $ref: '#/components/schemas/Address'
          title: address_lines
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Creditor's street_name \n - For TH Instant payment creditor.street_name is not applicable \n - For US Instant payment creditor.street_name is optional \n - For IN IMPS creditor.street_name is optional \n - For UK FPS Instant payment creditor.street_name field is not applicable \n - For IN UPI creditor.street_name is optional \n - For US Wire, creditor.street_name field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.street_name field is mandatory when creditor.address_lines field is not provided and allowed max length is 18 \n- For SEPA IDP, creditor.street_name is optional with max length 70 \n - For Japan Instant payment creditor.street_name field is not applicable \n- For SEPA, creditor.street_name is optional with max length 70"
          title: street_name
        building_number:
          maxLength: 16
          minLength: 1
          type: string
          description: "Creditor's building_number \n - For TH Instant payment creditor.building_number is not applicable \n - For US Instant payment creditor.building_number field is optional \n - For IN IMPS creditor.building_number field is optional \n - For UK FPS Instant payment creditor.building_number field is not applicable \n - For IN UPI creditor.building_number field is optional \n - For US Wire payment, creditor.building_number field is conditional with max length 16. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.building_number field is mandatory when creditor.address_lines field is not provided and allowed max length is 16 \n- For SEPA IDP, creditor.building_number is optional with max length 16 \n - For Japan Instant payment creditor.building_number field is not applicable \n- For SEPA IDP, creditor.building_number is optional with max length 16 \n- For SEPA, creditor.building_number is optional with max length 16"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Creditor's postal_code \n - For TH Instant payment creditor.postal_code is not applicable \n - For US Instant payment creditor.postal_code field is optional \n - For IN IMPS creditor.postal_code field is optional \n - For UK FPS Instant payment creditor.postal_code field is not applicable \n - For IN UPI creditor.postal_code field is optional \n - For US Wire, creditor.postal_code field is conditional with max length 16. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.postal_code field is mandatory when creditor.address_lines field is not provided and allowed max length is 16 \n- For SEPA IDP, creditor.postal_code is optional with max length 16 \n - For Japan Instant payment creditor.postal_code field is not applicable \n- For SEPA, creditor.postal_code is optional with max length 16"
          title: postal_code
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's city \n - For TH Instant payment creditor.city is not applicable \n - For US Instant payment creditor.city field is optional \n - For IN IMPS creditor.city field is optional \n - For UK FPS Instant payment creditor.city field is not applicable \n - For IN UPI creditor.city field is optionaloptional \n - For US Wire, creditor.city field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.city field is mandatory when creditor.address_lines field is not provided and allowed max length is 32 \n - For SEPA IDP creditor.city field is optional \n - For Japan Instant payment creditor.city field is not applicable \n - For SEPA, creditor.city field is optional and maxLength is 35"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's state \n - For TH Instant payment creditor.state is not applicable \n - For US Instant payment creditor.state field is optional \n - For IN IMPS creditor.state field is optional \n - For UK FPS Instant payment creditor.state is not applicable \n - For IN UPI creditor.state field is optional \n - For US Wire, creditor.state field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.state field is mandatory when creditor.address_lines field is not provided and allowed max length is 2 \n - For SEPA IDP creditor.state field is optional with max length 35 \n - For Japan Instant payment creditor.state field is not applicable \n - For SEPA, creditor.state field is optional with max length 35"
          title: state
        country:
          type: string
          description: "Creditor's country \n - For TH Instant payment creditor.country is not applicable \n - For US Instant payment creditor.country field is optional \n - For IN IMPS creditor.country field is optional \n - For UK FPS Instant payment creditor.country field is mandatory, if creditor.address_line is provided by client \n - For IN UPI creditor.country field is optional \n - For US Wire, creditor.country field is mandatory with max length 2 \n - For US ACH CCD/PPD/IAT payment, creditor.country field is mandatory when creditor.address_lines field is not provided and allowed max length is 2 \n - For SEPA IDP creditor.country field is optional \n - For Japan Instant payment creditor.country field is not applicable \n - For SEPA, creditor.country field is optional"
          pattern: ^[A-Z]{2,2}$
          title: country
        org_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's org_id \n - For TH Instant payment creditor.org_id is not applicable \n - For US Instant payment creditor.org_id field is optional.Pattern should be followed [A-Z0-9]{18,18}[0-9]{2,2} where first 18 characters can be uppercase or numbers and the last two characters must be numeric \n - For IN IMPS creditor.org_id is not applicable \n - For UK FPS Instant payment creditor.org_id field is not applicable \n - For IN UPI creditor.org_id is not applicable \n - For US Wire, creditor.org_id is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.org_id is not applicable \n - For SEPA IDP creditor.org_id field is optional with max length 35 \n - For Japan Instant payment creditor.org_id field is not applicable \n - For SEPA, creditor.org_id field is optional with max length 35"
          title: org_id
        prvt_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's prvt_id \n - For TH Instant payment creditor.prvt_id field is not applicable \n - For US Instant payment creditor.prvt_id field is optional with max length 35.Either org_id or prvt_id or none of them should be passed by client \n - For IN IMPS creditor.prvt_id field is not applicable \n - For UK FPS Instant payment creditor.prvt_id field is optional, Additional identification of Beneficiary Customer’s account with the receiving organisation. \n - For IN UPI creditor.prvt_id field is not applicable \n - For US Wire, creditor.prvt_id is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.prvt_id is not applicable \n - For SEPA IDP creditor.prvt_id field is optional with max length 35 \n - For Japan Instant payment creditor.prvt_id field is not applicable \n - For SEPA, creditor.prvt_id field is optional with max length 35"
          title: prvt_id
        birth_date:
          type: string
          format: date
          description: "ISO 8601 (YYYY-MM-DD), Creditor's birth_date \n - For TH Instant payment creditor.birth_date is not applicable \n - For US Instant payment creditor.birth_date field is optional \n - For IN IMPS creditor.birth_date is not applicable \n - For UK FPS Instant payment creditor.birth_date field is optional  \n - For IN UPI creditor.birth_date is not applicable \n - For US Wire, creditor.birth_date field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.birth_date is not applicable \n - For SEPA IDP creditor.birth_date field is optional \n - For Japan Instant payment creditor.birth_date field is not applicable \n - For SEPA, creditor.birth_date field is optional"
          title: birth_date
        birth_city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's birth_city \n - For TH Instant payment creditor.birth_city is not applicable \n - For US Instant payment creditor.birth_city field is optional \n - For IN IMPS creditor.birth_city is not applicable \n - For UK FPS Instant payment creditor.birth_city is not applicable \n - For IN UPI creditor.birth_city is not applicable \n - For US Wire, creditor.birth_city field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.birth_city is not applicable \n - For SEPA IDP creditor.birth_city field is optional \n - For Japan Instant payment creditor.birth_city field is not applicable \n - For SEPA, creditor.birth_city field is optional"
          title: birth_city
        birth_country:
          type: string
          description: "Creditor's birth_country \n - For TH Instant payment creditor.birth_country is not applicable \n - For US Instant payment creditor.birth_country field is optional \n - For IN IMPS  creditor.birth_country is not applicable \n - For UK FPS Instant payment creditor.birth_country is not applicable \n - For IN UPI  creditor.birth_country is not applicable \n - For US Wire, creditor.birth_country field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.birth_country is not applicable \n - For SEPA IDP creditor.birth_country field is optional \n - For Japan Instant payment creditor.birth_country field is not applicable \n - For SEPA, creditor.birth_country field is optional"
          pattern: ^[A-Z]{2,2}$
          title: birth_country
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor bank's network identification (e.g., routing number in the United States) \n - For TH Instant payment creditor.bank_id field is optional and allowed maxlength is 3 \n - For US Instant payment creditor.bank_id field is mandatory \n - For IN IMPS Instant payment creditor.bank_id field is mandatory and client should pass IFSC code (including branch code)  \n - For UK FPS Instant payment creditor.bank_id field is mandatory, if creditor.account field is pouplated with account number. For sort code mininum and maximum length is 6 Digits and for BIC Code allowed number of charcters are 8 or 11 \n - For IN UPI Instant payment creditor.bank_id field is mandatory with max length 11, if creditor.proxy_id is not provided by client \n - For US Wire, creditor.bank_id field is optional. It is mandatory only for 2 credit party, either BIC or MmbId must be provided. If the input is BIC, min and max length should be 8 and 11 and should adhere to pattern [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}. If the input is routing code, min and max length is 1 and 11. Note: 1. Target / Beneficiary bank SWIFT code. Applicable only for 2 credit party payments. If it is routing code, min and max length is 9 \n - For US ACH CCD/PPD payment, creditor.bank_id is mandatory field with max length is 9 \n - For US ACH IAT payment, creditor.bank_id is mandatory field with max length is 34 \n - For SEPA IDP creditor.bank_id field is mandatory with max length 11 \n - For Japan Instant payment creditor.bank_id field is mandatory and allowed max length is 7 \n - For SEPA, creditor.bank_id field is mandatory with max length 11"
          title: bank_id
        bank_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Creditor's bank name \n- For Thailand PromptPay creditor.bank_name field is not applicable \n- For United States creditor.bank_name field is not applicble \n- For IN IMPS creditor.bank_name field is not applicable \n- For UK FPS Instant payment creditor.bank_name field is not applicable \n- For IN UPI creditor.bank_name field is not applicable \n - For US Wire, creditor.bank_name is optional field with max length 35 \n - For US ACH CCD/PPD/IAT payment, creditor.bank_name field is optional and allowed maxlength is 35 characters. \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment creditor.bank_name field is not applicable \n- For SEPA, this field is not applicable"
          title: bank_name
        bank_address_lines:
          type: array
          description: "Creditor's bank address_lines \n- For Thailand PromptPay creditor.bank_address_lines field is not applicable \n- For United States creditor.bank_address_lines field is not applicble \n- For IN IMPS creditor.bank_address_lines field is not applicable \n- For UK FPS Instant payment creditor.bank_address_lines field is not applicable \n- For IN UPI creditor.bank_address_lines field is not applicable \n - For US Wire payment, creditor.bank_address_lines field is optional and upto 3 lines of min 1 and max 35 characters are allowed. \n - For US ACH CCD/PPD/IAT payment, creditor.bank_address_lines is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment creditor.bank_address_lines field is not applicable \n- For SEPA, this field is not applicable"
          items:
            $ref: '#/components/schemas/Address'
          title: bank_address_lines
        account_type:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor Account Type \n - For TH Instant payment creditor.account_type field is not applicable \n - For US Instant payment creditor.account_type field is not applicable \n - For IN IMPS creditor.account_type field is not applicable \n - For UK FPS Instant payment creditor.account_type field is not applicable  \n - For IN UPI creditor.account_type field is mandatory and possible values are 01 for Current,02 for Savings,04 for Cash Credit \n - For US Wire, creditor.account_type is an optional field and possible values are CACC for Current and SVGS for Savings \n - For US ACH CCD/PPD/IAT payment, creditor.account_type field is mandatory and possible values are CACC for Current and SVGS for Savings \n- For SEPA IDP, this field is not applicable \n- For JP Instant payment creditor.account_type field is not applicable \n- For SEPA, this field is not applicable"
          title: account_type
        redirect_account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Redirected Beneficiary Account Number \n - For TH creditor.redirect_account field is not applicable \n - For US creditor.redirect_account field is not applicable \n - For IN IMPS creditor.redirect_account field is not applicable \n - For UK creditor.redirect_account field is optional and max Field length is 34 \n - For JP Instant payment creditor.redirect_account field is not applicable \n - For IN UPI creditor.redirect_account field is not applicable \n - For US Wire, creditor.redirect_account field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.redirect_account is not applicable \n- For SEPA IDP, this field is not applicable \n- For SEPA, this field is not applicable"
          title: redirect_account
        redirect_bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Redirected Beneficiary Sort Code \n - For TH creditor.redirect_bank_id field is not applicable \n - For US creditor.redirect_bank_id field is not applicable \n - For IN IMPS creditor.redirect_bank_id field is not applicable \n - For UK creditor.redirect_bank_id field is optional and max Field length is 6 \n - For UK FPS Instant payment creditor.redirect_bank_id field is not applicable \n - For IN UPI creditor.redirect_bank_id field is not applicable \n - For US Wire, creditor.redirect_bank_id field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.redirect_bank_id is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment creditor.redirect_bank_id field is not applicable \n- For SEPA, this field is not applicable"
          title: redirect_bank_id
        account_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Creditor account name \n- For Thailand PromptPay creditor.account_name field is not applicable \n- For United States creditor.account_name field is optional \n- For IN IMPS creditor.account_name field is not applicable \n- For UK FPS Instant payment creditor.account_name field is not applicable \n- For IN UPI creditor.account_name field is not applicable \n - For US Wire, creditor.account_name is an optional field with max length 35.Provide only if it is different than Beneficiary name \n - For US ACH CCD/PPD/IAT payment, creditor.account_name is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment creditor.account_name field is not applicable \n- For SEPA, this field is not applicable"
          title: account_name
        bank_instructions:
          maxLength: 140
          minLength: 1
          type: string
          description: "Instructions for creditor agent \n- For Thailand PromptPay creditor.bank_instructions field is not applicable \n- For United States creditor.bank_instructions field is not applicble \n- For IN IMPS creditor.bank_instructions field is not applicable \n- For UK FPS Instant payment creditor.bank_instructions field is not applicable \n- For IN UPI creditor.bank_instructions field is not applicable \n - For US Wire, creditor.bank_instructions is an optional field with min 1 and max 36. if It is code, the max length is 4. codes: CHQB - PayCreditorByCheque, HOLD - HoldCashForCreditor, PHOB- PhoneBeneficiary, TELB- Telecom \n - For US ACH CCD/PPD/IAT payment, creditor.bank_instructions field is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment creditor.bank_instructions field is not applicable \n- For SEPA, this field is not applicable"
          title: bank_instructions
        department:
          maxLength: 70
          minLength: 1
          type: string
          description: "creditor Address Department \n - For TH Instant payment creditor.department is not applicable \n - For US Instant payment creditor.department is not applicable \n - For IN IMPS creditor.department is not applicable \n - For UK FPS Instant payment creditor.department is not applicable \n - For IN UPI creditor.department is not applicable \n - For US Wire, creditor.department is not applicable \n - For US ACH CCD/PPD payment, creditor.department is not applicable \n - For US ACH IAT payment, creditor.department is not applicable \n - For US ACH IAT payment, creditor.department is not applicable \n- For SEPA IDP, creditor.department is optional with max length 70 \n - For Japan Instant payment creditor.department field is not applicable \n- For SEPA, creditor.department is optional with max length 70"
          title: department
        sub_department:
          maxLength: 70
          minLength: 1
          type: string
          description: "creditor Address Sub-Department \n - For TH Instant payment creditor.sub_department is not applicable \n - For US Instant payment creditor.sub_department is not applicable \n - For IN IMPS creditor.sub_department is not applicable \n - For UK FPS Instant payment creditor.sub_department is not applicable \n - For IN UPI creditor.sub_department is not applicable \n - For US Wire, creditor.sub_department is not applicable \n - For US ACH CCD/PPD payment, creditor.sub_department is not applicable \n - For US ACH IAT payment, creditor.sub_department is not applicable \n - For US ACH IAT payment, creditor.sub_department is not applicable \n- For SEPA IDP, creditor.sub_department is optional with max length 70 \n - For Japan Instant payment creditor.sub_department field is not applicable \n- For SEPA, creditor.sub_department is optional with max length 70"
          title: sub_department
        building_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor building name \n - For TH Instant payment creditor.building_name is not applicable \n - For US Instant payment creditor.building_name is not applicable \n - For IN IMPS creditor.building_name is not applicable \n - For UK FPS Instant payment creditor.building_name is not applicable \n - For IN UPI creditor.building_name is not applicable \n - For US Wire, creditor.building_name is not applicable \n - For US ACH CCD/PPD payment, creditor.building_name is not applicable \n - For US ACH IAT payment, creditor.building_name is not applicable \n - For US ACH IAT payment, creditor.building_name is not applicable \n- For SEPA IDP, creditor.building_name is optional with max length 35 \n - For Japan Instant payment creditor.building_name field is not applicable \n- For SEPA, creditor.building_name is optional with max length 35"
          title: building_name
        floor:
          maxLength: 70
          minLength: 1
          type: string
          description: "creditor address floor \n - For TH Instant payment creditor.floor is not applicable \n - For US Instant payment creditor.floor is not applicable \n - For IN IMPS creditor.floor is not applicable \n - For UK FPS Instant payment creditor.floor is not applicable \n - For IN UPI creditor.floor is not applicable \n - For US Wire, creditor.floor is not applicable \n - For US ACH CCD/PPD payment, creditor.floor is not applicable \n - For US ACH IAT payment, creditor.floor is not applicable \n - For US ACH IAT payment, creditor.floor is not applicable \n- For SEPA IDP, creditor.floor is optional with max length 70 \n - For Japan Instant payment creditor.floor field is not applicable \n- For SEPA, creditor.floor is optional with max length 70"
          title: floor
        post_box:
          maxLength: 16
          minLength: 1
          type: string
          description: "creditor address post box \n - For TH Instant payment creditor.post_box is not applicable \n - For US Instant payment creditor.post_box is not applicable \n - For IN IMPS creditor.post_box is not applicable \n - For UK FPS Instant payment creditor.post_box is not applicable \n - For IN UPI creditor.post_box is not applicable \n - For US Wire, creditor.post_box is not applicable \n - For US ACH CCD/PPD payment, creditor.post_box is not applicable \n - For US ACH IAT payment, creditor.post_box is not applicable \n - For US ACH IAT payment, creditor.post_box is not applicable \n- For SEPA IDP, creditor.post_box is optional with max length 16 \n - For Japan Instant payment creditor.post_box field is not applicable \n- For SEPA, creditor.post_box is optional with max length 16"
          title: post_box
        room:
          maxLength: 70
          minLength: 1
          type: string
          description: "creditor address room \n - For TH Instant payment creditor.room is not applicable \n - For US Instant payment creditor.room is not applicable \n - For IN IMPS creditor.room is not applicable \n - For UK FPS Instant payment creditor.room is not applicable \n - For IN UPI creditor.room is not applicable \n - For US Wire, creditor.room is not applicable \n - For US ACH CCD/PPD payment, creditor.room is not applicable \n - For US ACH IAT payment, creditor.room is not applicable \n - For US ACH IAT payment, creditor.room is not applicable \n- For SEPA IDP, creditor.room is optional with max length 70 \n - For Japan Instant payment creditor.room field is not applicable \n- For SEPA, creditor.room is optional with max length 70"
          title: room
        town_location_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor address town location name \n - For TH Instant payment creditor.town_location_name is not applicable \n - For US Instant payment creditor.town_location_name is not applicable \n - For IN IMPS creditor.town_location_name is not applicable \n - For UK FPS Instant payment creditor.town_location_name is not applicable \n - For IN UPI creditor.town_location_name is not applicable \n - For US Wire, creditor.town_location_name is not applicable \n - For US ACH CCD/PPD payment, creditor.town_location_name is not applicable \n - For US ACH IAT payment, creditor.town_location_name is not applicable \n - For US ACH IAT payment, creditor.town_location_name is not applicable \n- For SEPA IDP, creditor.town_location_name is optional with max length 35 \n - For Japan Instant payment creditor.town_location_name field is not applicable \n- For SEPA, creditor.town_location_name is optional with max length 35"
          title: town_location_name
        district_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor address district_name \n - For TH Instant payment creditor.district_name is not applicable \n - For US Instant payment creditor.district_name is not applicable \n - For IN IMPS creditor.district_name is not applicable \n - For UK FPS Instant payment creditor.district_name is not applicable \n - For IN UPI creditor.district_name is not applicable \n - For US Wire, creditor.district_name is not applicable \n - For US ACH CCD/PPD payment, creditor.district_name is not applicable \n - For US ACH IAT payment, creditor.district_name is not applicable \n - For US ACH IAT payment, creditor.district_name is not applicable \n- For SEPA IDP, creditor.district_name is optional with max length 35 \n - For Japan Instant payment creditor.district_name field is not applicable \n- For SEPA, creditor.district_name is optional with max length 35"
          title: district_name
        anybic:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor BIC \n - For TH Instant payment creditor.anybic is not applicable \n - For US Instant payment creditor.anybic is not applicable \n - For IN IMPS creditor.anybic is not applicable \n - For UK FPS Instant payment creditor.anybic is not applicable \n - For IN UPI creditor.anybic is not applicable \n - For US Wire, creditor.anybic is not applicable \n - For US ACH CCD/PPD payment, creditor.anybic is not applicable \n - For US ACH IAT payment, creditor.anybic is not applicable \n - For US ACH IAT payment, creditor.anybic is not applicable \n- For SEPA IDP, creditor.anybic is optional with max length 11 \n - For Japan Instant payment creditor.anybic field is not applicable \n- For SEPA, creditor.anybic is optional with max length 11"
          title: anybic
        lei:
          maxLength: 35
          minLength: 1
          type: string
          description: "Unique global identifier for legal entities participating in financial transactions \n - For TH Instant payment creditor.lei is not applicable \n - For US Instant payment creditor.lei is not applicable \n - For IN IMPS creditor.lei is not applicable \n - For UK FPS Instant payment creditor.lei is not applicable \n - For IN UPI creditor.lei is not applicable \n - For US Wire, creditor.lei is not applicable \n - For US ACH CCD/PPD payment, creditor.lei is not applicable \n - For US ACH IAT payment, creditor.lei is not applicable \n - For US ACH IAT payment, creditor.lei is not applicable \n- For SEPA IDP, creditor.lei is optional with max length 20 \n - For Japan Instant payment creditor.lei field is not applicable \n- For SEPA, creditor.lei is optional with max length 20"
          title: lei
        issuer:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor name that identifies an issuer \n - For TH Instant payment creditor.issuer is not applicable \n - For US Instant payment creditor.issuer is not applicable \n - For IN IMPS creditor.issuer is not applicable \n - For UK FPS Instant payment creditor.issuer is not applicable \n - For IN UPI creditor.issuer is not applicable \n - For US Wire, creditor.issuer is not applicable \n - For US ACH CCD/PPD payment, creditor.issuer is not applicable \n - For US ACH IAT payment, creditor.issuer is not applicable \n - For US ACH IAT payment, creditor.issuer is not applicable \n- For SEPA IDP, creditor.issuer is optional with max length 35 \n - For Japan Instant payment creditor.issuer field is not applicable \n- For SEPA, creditor.issuer is optional with max length 35"
          title: issuer
        birth_province:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor Province Of Birth \n - For TH Instant payment creditor.birth_province is not applicable \n - For US Instant payment creditor.birth_province is not applicable \n - For IN IMPS creditor.birth_province is not applicable \n - For UK FPS Instant payment creditor.birth_province is not applicable \n - For IN UPI creditor.birth_province is not applicable \n - For US Wire, creditor.birth_province is not applicable \n - For US ACH CCD/PPD payment, creditor.birth_province is not applicable \n - For US ACH IAT payment, creditor.birth_province is not applicable \n - For US ACH IAT payment, creditor.birth_province is not applicable \n- For SEPA IDP, creditor.birth_province is optional with max length 35 \n - For Japan Instant payment creditor.birth_province field is not applicable \n- For SEPA, creditor.birth_province is optional with max length 35"
          title: birth_province
        bank_branch_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor bank's branch network identification \n - For TH Instant payment creditor.bank_branch_id field is applicable \n - For US Instant payment creditor.bank_branch_id field is not applicable \n - For UK Instant payment creditor.bank_branch_id field is not applicable \n - For JP Instant payment creditor.bank_branch_id is not applicable \n - For IN IMPS Instant payment creditor.bank_branch_id field is not applicable \n - For IN UPI Instant payment creditor.bank_branch_id field is not applicable \n - For US Wire, creditor.bank_branch_id is not applicable \n - For Stripe_US ACH CCD/PPD/IAT payment, creditor.bank_branch_id is not applicable \n- For SEPA IDP, this field is not applicable \n- For SEPA, this field is not applicable"
          title: bank_branch_id
        name_conversion_flag:
          type: string
          enum:
          - Y
          - N
          description: "Creditor's name conversion flag \n- For TH Instant payment creditor.name_conversion_flag field is not applicable \n - For US Instant payment creditor.name_conversion_flag field is not applicable \n - For IN IMPS creditor.name_conversion_flag field is not applicable \n - For UK FPS Instant payment creditor.name_conversion_flag field is not applicable \n - For IN UPI creditor.name_conversion_flag field is not applicable \n - For US Wire, creditor.name_conversion_flag field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.name_conversion_flag is not applicable \n - For Japan Instant payment creditor.name_conversion_flag field is optional \n- For SEPA, creditor.name_conversion_flag field is not applicable"
          title: name_conversion_flag
        advice_mobile:
          maxLength: 34
          type: string
          pattern: ^[+][0-9]{1,3}[-\ ][0-9()+\-]{1,30}$
          description: "Creditor's mobile number \n - For TH,US,UK FPS, IN UPI, Stripe US Wire, US ACH CCD/PPD/IAT, Japan, SEPA Instant payment creditor.advice_mobile field is not applicable \n - For India FIR IMPS payment creditor.advice_email field is optional"
          title: advice_mobile
        advice_email:
          type: string
          maxLength: 2048
          minLength: 1
          description: "Creditor's email address \n- For US,UK FPS,IN UPI ,US Wire,US ACH CCD/PPD/IAT payment, Japan, SEPA, this field is not applicable \n- For India FIR IMPS payment creditor.advice_email field is optional"
          title: advice_email
        resolved_name:
          type: string
          description: "Creditor name sent in beneficiary validation response.\n - For SEPA VoP this field is optional"
          minLength: 1
          maxLength: 140
          title: resolved_name
        scheme_name:
          maxLength: 128
          minLength: 1
          type: string
          description: Creditor's scheme name
          title: scheme_name
        contact_details:
          $ref: '#/components/schemas/contact-details'
      additionalProperties: false
      description: Object representing the receiver of a transaction.
    Intermediary-Details-Status:
      type: object
      title: IntermediaryDetailsStatus
      properties:
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "intermediary agent identifier (e.g., routing number in the United States) \n - For TH Instant payment Intermediary.bank_id field is not applicable \n - For US Instant payment Intermediary.bank_id field is not applicable \n - For IN IMPS Instant payment Intermediary.bank_id field is not applicable \n - For UK FPS Instant payment Intermediary.bank_id field is not applicable \n - For IN UPI Instant payment Intermediary.bank_id field is not applicable \n - For US Wire, intermediary.bank_id field is optional. Applicable to 3 credit party payments only, either BIC or MmbId should be provided. If the input is BIC, min and max length should be 8 and 11 and should adhere to pattern [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}. If the input is routing code, min and max length is 1 and 11. Note: 1. First Intermediary bank SWIFT Code (BIC) is applicable to 3 credit party payments only. 2. Second Intermediary bank SWIFT Code is applicable to 3 credit party payments only \n - For US ACH CCD/PPD payment, Intermediary.bank_id is not applicable \n - For US ACH IAT payment, Intermediary.bank_id is mandatory and allowed max length is 11 \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment Intermediary.bank_id field is not applicable"
          title: bank_id
        bank_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "intermediary agent name \n - For TH Instant payment Intermediary.bank_name is not applicable \n - For US Instant payment Intermediary.bank_name is not applicable \n - For IN IMPS Instant payment Intermediary.bank_name is not applicable \n - For UK FPS Instant payment Intermediary.bank_name is not applicable \n - For IN UPI Instant payment Intermediary.bank_name is not applicable \n - For US Wire, Intermediary.bank_name field is conditional with max length 35. Mandaotry if payment is 3 and 4 credit party payment \n - For US ACH CCD/PPD payment, Intermediary.bank_name is not applicable \n - For US ACH IAT payment, Intermediary.bank_name is optional and allowed max length is 35 \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment Intermediary.bank_name field is not applicable"
          title: name
        bank_country:
          type: string
          description: "intermediary agent Country \n - For TH Instant payment intermediary.bank_country is not applicable \n - For US Instant payment intermediary.bank_country is not applicable \n - For IN IMPS intermediary.bank_country is not applicable \n - For UK FPS Instant payment intermediary.bank_country is not applicable \n - For IN UPI intermediary.bank_country is not applicable \n - For US Wire, intermediary.bank_country field is mandatory with max length 2. \n - For US ACH CCD/PPD payment, Intermediary.bank_country is not applicable \n - For US ACH IAT payment, Intermediary.bank_country is mandatory \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment Intermediary.bank_country field is not applicable"
          pattern: ^[A-Z]{2,2}$
          title: country
        bank_address_lines:
          type: array
          description: "intermediary agent address_lines \n - For TH Instant payment intermediary.bank_address_lines is not applicable \n - For US Instant payment intermediary.bank_address_lines is not applicable \n - For IN IMPS intermediary.bank_address_lines is not applicable \n - For UK FPS Instant payment intermediary.bank_address_lines is not applicable \n - For IN UPI intermediary.bank_address_lines is not applicable \n - For US Wire payment, intermediary.bank_.address_lines field is optional and upto 3 lines of min 1 and max 35 characters are allowed. \n - For US ACH CCD/PPD/IAT payment, Intermediary.bank_address_lines is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment Intermediary.bank_address_lines field is not applicable"
          items:
            $ref: '#/components/schemas/Address'
          title: bank_address_lines
        bank_account_id:
          maxLength: 34
          minLength: 1
          type: string
          description: "intermediary agent account id \n - For TH Instant payment intermediary.bank_account_id is not applicable \n - For US Instant payment intermediary.bank_account_id is not applicable \n - For IN IMPS intermediary.bank_account_id is not applicable \n - For UK FPS Instant payment intermediary.bank_account_id is not applicable \n - For IN UPI intermediary.bank_account_id is not applicable \n - For US Wire, intermediary.bank_account_id is an optional field with max length is 34 \n - For US ACH CCD/PPD/IAT payment, Intermediary.bank_account_id is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment Intermediary.bank_account_id field is not applicable"
          title: account
      additionalProperties: false
      description: 'iintermediary agents information. Note: 1st occurance of intermediary set will be used intermediary agent 1 information. 2nd occurance of intermediary set will be used for intermediary agent 2'
    structured-remittance-info:
      type: object
      title: structured_remittance_info
      properties:
        creditor_reference_information_code:
          maxLength: 35
          minLength: 1
          type: string
          description: "Structured Creditor Reference Information Code \n - For TH Instant payment  transaction.structured_remittance_info.creditor_reference_information_code is not applicable \n - For US Instant payment  transaction.structured_remittance_info.creditor_reference_information_code field is not applicable \n - For IN IMPS  transaction.structured_remittance_info.creditor_reference_information_code is not applicable \n - For UK FPS Instant payment  transaction.structured_remittance_info.creditor_reference_information_code is not applicable \n - For JP Instant payment  transaction.structured_remittance_info.creditor_reference_information_code is not applicable \n - For IN UPI  transaction.structured_remittance_info.creditor_reference_information_code is not applicable \n - For US WIRE, transaction.structured_remittance_info.creditor_reference_information_code field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.structured_remittance_info.creditor_reference_information_code field is not applicable \n - For SEPA IDP  transaction.structured_remittance_info.creditor_reference_information_code field is optional with max length 4  \n - For Japan Instant payment transaction.structured_remittance_info.creditor_reference_information_code field is not applicable \n - For SEPA, transaction.structured_remittance_info.creditor_reference_information_code field is conditional mandatory with maxLength is 4"
          title: creditor_reference_information_code
        creditor_reference_issuer:
          maxLength: 35
          minLength: 1
          type: string
          description: "Structured Creditor Reference Issuer \n - For TH Instant payment transaction.structured_remittance_info.creditor_reference_issuer  is not applicable \n - For US Instant payment transaction.structured_remittance_info.creditor_reference_issuer field is not applicable \n - For IN IMPS transaction.structured_remittance_info.creditor_reference_issuer  is not applicable \n - For UK FPS Instant payment transaction.structured_remittance_info.creditor_reference_issuer  is not applicable \n - For JP Instant payment transaction.structured_remittance_info.creditor_reference_issuer  is not applicable \n - For IN UPI transaction.structured_remittance_info.creditor_reference_issuer  is not applicable \n - For US WIRE,transaction.structured_remittance_info.creditor_reference_issuer field is not applicable \n - For US ACH CCD/PPD/IAT payment,transaction.structured_remittance_info.creditor_reference_issuer field is not applicable \n - For SEPA IDP transaction.structured_remittance_info.creditor_reference_issuer field is optional with max length 35 \n - For Japan Instant payment transaction.structured_remittance_info.creditor_reference_issuer field is not applicable \n - For SEPA, transaction.structured_remittance_info.creditor_reference_issuer field is optional field and allowed maxLength is 35"
          title: creditor_reference_issuer
        creditor_reference:
          maxLength: 35
          minLength: 1
          type: string
          description: "Structured Creditor Reference \n - For TH Instant payment transaction.structured_remittance_info.creditor_reference  is not applicable \n - For US Instant payment transaction.structured_remittance_info.creditor_reference  field is not applicable \n - For IN IMPS transaction.structured_remittance_info.creditor_reference  is not applicable \n - For UK FPS Instant payment transaction.structured_remittance_info.creditor_reference  is not applicable \n - For JP Instant payment transaction.structured_remittance_info.creditor_reference  is not applicable \n - For IN UPI transaction.structured_remittance_info.creditor_reference  is not applicable \n - For US WIRE,transaction.structured_remittance_info.creditor_reference  field is not applicable \n - For US ACH CCD/PPD/IAT payment,transaction.structured_remittance_info.creditor_reference  field is not applicable \n - For SEPA IDP transaction.structured_remittance_info.creditor_reference  field is optional with max length 35 \n - For Japan Instant payment transaction.structured_remittance_info.creditor_reference field is not applicable \n - For SEPA, transaction.structured_remittance_info.creditor_reference field is optional and allowed maxLength is 35"
          title: creditor_reference
    Intermediary-Initiation:
      title: IntermediaryInitiation
      description: Intermediary agent information
      type: array
      maxItems: 3
      items:
        $ref: '#/components/schemas/Intermediary-Details'
    Transaction-Initiation:
      type: object
      title: TransactionInitiation
      required:
      - instructed_amount
      - end_to_end_id
      properties:
        end_to_end_id:
          $ref: '#/components/schemas/Restricted-Finx-Max-Text'
        instruction_id:
          type: string
          description: "Instruction ID of the payment \n- For Thailand PromptPay transaction.instruction_id field is not applicable \n- For United States transaction.instruction_id field is optional \n- For IN IMPS transaction.instruction_id field is not applicable \n- For UK FPS Instant payment transaction.instruction_id field is not applicable \n- For IN UPI transaction.instruction_id field is not applicable \n - For US WIRE, transaction.instruction_id field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.instruction_id field is not applicable \n - For Japan Instant payment transaction.instruction_id field is not applicable \n - For SEPA, transaction.instruction_id is optional field with maxLength as 35"
          minLength: 1
          maxLength: 35
          title: instruction_id
        uetr:
          type: string
          pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
          description: UUID v4 format unique end-to-end transaction reference
          title: uetr
        reference:
          maxLength: 140
          minLength: 1
          type: string
          description: "Electronic Data Interchange It works like a referece for clients to look for additional information in EDI system for Invoice & purchase data. \n - For SEPA, TH Instant payment transaction.reference is not applicable \n - For US Instant payment transaction.reference field is not applicable \n - For IN IMPS transaction.reference is not applicable \n - For UK FPS Instant payment transaction.reference is not applicable \n - For JP Instant payment transaction.reference is optional. It allows zengin characters ｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜｦﾝ , upper character alphabets A-Z, numeric characters 0 to 9 and special characters as follows . , () - \n - For IN UPI transaction.reference is not applicable \n - For US WIRE, transaction.reference field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.reference field is not applicable"
          title: reference
        bill_id_1:
          maxLength: 128
          pattern: ^[0-9A-Z]{1,128}$
          type: string
          description: "Bill identification \n- Thailand PromptPay - Maximum length is 20. \n - For SEPA, US Instant payment transaction.bill_id_1 field is not applicable \n - For IN IMPS transaction.bill_id_1 field is not applicable \n - For UK FPS Instant payment transaction.bill_id_1 field is not applicable  \n - For IN UPI transaction.bill_id_1 field is not applicable  \n - For US Wire, transaction.bill_id_1 field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.bill_id_1 field is not applicable \n - For Japan Instant payment transaction.bill_id_1 field is not applicable"
          title: bill_id_1
        bill_id_2:
          maxLength: 128
          pattern: ^[0-9A-Z]{1,128}$
          type: string
          description: "Bill identification \n- Thailand PromptPay - Maximum length is 20. \n - For SEPA, US Instant payment transaction.bill_id_2 field is not applicable \n - For IN IMPS transaction.bill_id_2 field is not applicable \n - For UK FPS Instant payment transaction.bill_id_2 field is not applicable \n - For IN UPI transaction.bill_id_2 field is not applicable \n - For US Wire, transaction.bill_id_2 field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.bill_id_2 field is not applicable \n - For Japan Instant payment transaction.bill_id_2 field is not applicable"
          title: bill_id_2
        bill_id_3:
          maxLength: 128
          pattern: ^[0-9A-Z]{1,128}$
          type: string
          description: "Bill identification \n- Thailand PromptPay - Maximum length is 20. \n - For SEPA, US Instant payment transaction.bill_id_3 field is not applicable \n - For IN IMPS transaction.bill_id_3 field is not applicable \n - For UK FPS Instant payment transaction.bill_id_3 field is not applicable \n - For IN UPI transaction.bill_id_3 field is not applicable \n - For US Wire, transaction.bill_id_3 field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.bill_id_3 field is not applicable \n - For Japan Instant payment transaction.bill_id_3 field is not applicable"
          title: bill_id_3
        purpose:
          type: string
          minLength: 1
          maxLength: 6
          description: "Purpose of a transaction \n- For Thailand PromptPay transaction.purpose field is optional \n- For US Instant payment transaction.purpose field is optional \n- For IN IMPS transaction.purpose field is optional \n- UK FPS Instant payment transaction.purpose field is optional \n- For IN UPI transaction.purpose field is optional \n- For India FIR IMPS Instant payment transaction.purpose field is mandatory  \n- CASH for cash management \n- CNFL for confidential \n- COST for payment for business expenses  \n- GDSV for payment related to purchase or sale of goods and services \n- GP2P for person-to-person payment \n- OTHR for other, if your payment doesn't fit any of the specific purpose codes  \n- RCPT for payment of a receipt \n- SALA for salary payment  \n- SUPP for supplier payment \n- TREA for treasury payment \n- REFU for refund payment \n- CLPO for Claim Payouts \n- LODI for Loan Disbursals \n- TIPO for Tips Payout \n- GIEO for Gig economy \n- VEPO for Vendor Payouts \n- INPO for Incentive Payouts \n- ISPO for Insurance Payouts \n- MPPO for Merchant/Marketplace Payouts \n- TXPO for Tax Payments \n- RDPO for Rider payout \n- GDDS for payment related to purchase or sale of goods \n- SCVE for payment related to purchase or sale of services \n- PAYR for payroll payment \n- NOWS for Not Otherwise Specified \n- INVS for Invoice Signed \n- INSC for Payment Of Insurance Claim \n- INSM for Installment \n- PDEP for Property Deposit \n- UBIL for Utilities Subscription Identification \n- ACCT for Account Management \n- CBLK for Bulk card transactions \n- MP2P for Mobile P2P Payment \n - For US Wire, transaction.purpose field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.purpose field is not applicable \n - For Japan Instant payment transaction.purpose field is not applicable \n - For SEPA, transaction.purpose field is conditional mandatory if purpose of payment is SALA for Salary"
          title: purpose
        tax_code:
          type: number
          enum:
          - 0
          - 1
          - 2
          description: "Tax code \n- Thailand PromptPay - Provide 0 if transaction is without value-added tax or withholding tax. Provide 1 if transaction is with value-added tax or withholding tax. Provide 2 if transaction is with ewht\n - For US Instant payment transaction.tax_code field is not applicable \n - For IN IMPS transaction.tax_code field is not applicable \n - For UK FPS Instant payment transaction.tax_code field is not applicable \n - For IN UPI transaction.tax_code field is not applicable \n - For US Wire, transaction.tax_code field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.tax_code field is not applicable \n - For SEPA, Japan Instant payment transaction.tax_code field is not applicable"
          title: tax_code
        wht_code:
          type: string
          enum:
          - A
          - S
          - B
          description: "Withholding tax (WHT) code \n- Thailand PromptPay - If you provide tax_code 1, wht_code is required. Povide A for WHT always paid by the seller, S for WHT once paid by the seller or B for WHT paid by the buyer. \n - For US Instant payment transaction.wht_code field is not applicable \n - For IN IMPS transaction.wht_code field is not applicable \n - For UK FPS Instant payment transaction.wht_code field is not applicable \n - For IN UPI transaction.wht_code field is not applicable \n - For US Wire, transaction.wht_code field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.wht_code field is not applicable \n - For SEPA, Japan Instant payment transaction.wht_code field is not applicable"
          title: wht_code
        income_type:
          type: string
          pattern: ^(00[0-9]|01[0-2])$
          description: "Income type \n- Thailand PromptPay -  If you provide tax_code 1, income_type is required. Provide 001 for service and professional fee for a company with Thailand location, 002 for service and professional fee for a company without Thailand location, 003 for royalty, 004 for rent, 005 for ship rental fee, 006 for prize, 007 for promotion, 008 for actor fee, 009 advertising, 010 non-life insurance premium, 011 for  transportation cost and 012 for agricultural purchase. \n - For US Instant payment transaction.income_type field is not applicable \n - For IN IMPS transaction.income_type field is not applicable \n - For UK FPS Instant payment transaction.income_type field is not applicable \n - For IN UPI transaction.income_type field is not applicable  \n - For US Wire, transaction.income_type field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.income_type field is not applicable \n - For SEPA, Japan Instant payment transaction.income_type field is not applicable"
          title: income_type
        vat_rate:
          type: number
          minimum: 0
          description: "Value-added tax (VAT) rate \n - For TH Instant Payent Range is 0 - 99.99  \n - For US Instant payment transaction.vat_rate field is not applicable \n - For IN IMPS transaction.vat_rate field is not applicable \n - For UK FPS Instant payment transaction.vat_rate field is not applicable \n - For IN UPI transaction.vat_rate field is not applicable  \n - For US Wire, transaction.vat_rate field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.vat_rate field is not applicable \n - For SEPA, Japan Instant payment transaction.vat_rate field is not applicable"
          title: vat_rate
        vat_amount:
          type: number
          maximum: 1000000000000000
          description: "Value-added tax (VAT) amount \n - Thailand PromptPay - Maximum amount is 2000000.00. \n - For US Instant payment transaction.vat_amount field is not applicable \n - For IN IMPS transaction.vat_amount field is not applicable \n - For UK FPS Instant payment transaction.vat_amount field is not applicable \n - For IN UPI transaction.vat_amount field is not applicable \n - For US Wire, transaction.vat_amount field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.vat_amount field is not applicable \n - For SEPA, Japan Instant payment transaction.vat_amount field is not applicable"
          title: vat_amount
        wht_rate:
          type: number
          minimum: 0
          description: "Withholding tax (WHT) rate (0 - 99.99) \n - Thailand PromptPay - Maximum rate is 5.00. \n - For US Instant payment transaction.wht_rate field is not applicable  \n - For IN IMPS transaction.wht_rate field is not applicable \n - For UK FPS Instant payment transaction.wht_rate field is not applicable \n - For IN UPI transaction.wht_rate field is not applicable \n - For US Wire, transaction.wht_rate field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.wht_rate field is not applicable \n - For SEPA, Japan Instant payment transaction.wht_rate field is not applicable"
          title: wht_rate
        wht_amount:
          type: number
          maximum: 1000000000000000
          description: "Withholding tax (WHT) amount \n - Thailand PromptPay - Maximum amount is 2000000.00. \n - For US Instant payment transaction.wht_amount field is not applicable \n - For IN IMPS transaction.wht_amount field is not applicable \n - For UK FPS Instant payment transaction.wht_amount field is not applicable \n - For IN UPI transaction.wht_amount field is not applicable \n - For US Wire, transaction.wht_amount field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.wht_amount field is not applicable \n - For SEPA, Japan Instant payment transaction.wht_amount field is not applicable"
          title: wht_amount
        invoice_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: The total amount of the invoice, typically excluding WHT amounts.
          title: invoice_amount
        charges_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: Any additional charges passed on to the beneficiary.
          title: charges_amount
        bill_due_date:
          type: string
          format: date
          description: "ISO 8601 (YYYY-MM-DD) bill due date  \n - For TH Instant payment if client provides transaction.bill_id_1 value, require client to mandatorily provide bill_due_date value. \n - For US Instant payment transaction.bill_due_date field is not applicable \n - For IN IMPS transaction.bill_due_date field is not applicable \n - For UK FPS Instant payment transaction.bill_due_date field is not applicable \n - For IN UPI transaction.bill_due_date field is not applicable \n - For US Wire, transaction.bill_due_date field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.bill_due_date field is not applicable \n - For SEPA, Japan Instant payment transaction.bill_due_date field is not applicable"
          title: bill_due_date
        value_date:
          type: string
          format: date
          description: "YYYY-MM-DD Date in local time zone (e.g., EST for a United States RTP network transaction IST for IN IMPS) when Citi's transaction processing application starts processing a transaction \n - For UK Instant payment transaction.value_date field is mandatory, for SIP transaction value Date should be current calender date or current calender date +1 or current calender date -1, for FDP transaction value Date should be current calender date +2 till current calender date +30 \n - For US Wire, transaction.value_date is a mandatory field \n - For US ACH CCD/PPD/IAT payment, transaction.value_date field is mandatory \n - For Japan Instant payment transaction.value_date field is mandatory, value date should be current calender date or current calender date -7 \n - For SEPA, transaction.value_date is a mandatory field, value date should be current calender date or future calender date till 180 days or current calender date -7 \n - For TH Instant payment, transaction.value_date is a optional field, value date can be current calender date or future calender date till 180 days or current calender date -7"
          title: value_date
        instructed_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: "Instructed amount \n - Thailand PromptPay - Maximum amount is 2000000.00 \n - US RTP - Maximum amount is 1000000.00 \n - IN IMPS - Maximum amount is 500000.00 \n - UK FPS Instant Payment - Maximum amount is 1000000.00 and allowed only Maximum of Two digits after decimal \n - IN UPI - Maximum amount is 200000.00 \n - For US Wire, transaction.instructed_amount is a mandatory field. Maximum amount is $9999999999.99 \n - IN Japan - Maximum amount is 99,999,999 \n - For SEPA, transaction.instructed_amount field is mandatory and instructed_amount should always need to be greater than 0"
          title: instructed_amount
        additional_info:
          type: string
          maxLength: 140
          minLength: 1
          description: "Additional or remittance information \n- Thailand PromptPay - Maximum length is 40. \n - For US Instant payment transaction.additional_info field is not applicable \n - For IN IMPS transaction.additional_info field is not applicable \n - For UK FPS Instant payment transaction.additional_info field is optional and allowed max length is 105 \n - For IN UPI transaction.additional_info field is not applicable  \n - For US Wire, transaction.additional_info field is not applicable \n - For US ACH CCD/PPD payments, transaction.additional_info field is optional. If the client want to verify the beneficiary/Creditor account then value should be /MICE/ACCTVERIFY and transaction amount can not exceed $0.99 \n - For US ACH IAT payment, transaction.additional_info field is not applicable \n - For SEPA, Japan Instant payment transaction.additional_info field is not applicable"
          title: additional_info
        unstructured_remittance_info:
          type: array
          description: "Unstructured remitance information \n - For TH Instant payment transaction.unstructured_remittance_info field is not applicable \n - For US Instant payment transaction.unstructured_remittance_info field is optional - Maximum length is 140 and Single instance is allowed \n- For IN IMPS transaction.unstructured_remittance_info field is optional where two lines at max allowed. 1st line to have max 35 chars, 2nd line to have a max of 15 chars. Max length for this tag is 50 chars \n - For UK FPS Instant payment transaction.unstructured_remittance_info is optional and allowed only four instance with each line max length of 35 \n- For IN UPI transaction.unstructured_remittance_info field is optional where two lines at max allowed. 1st line to have max 35 chars, 2nd line to have a max of 15 chars. Max length for this tag is 50 chars /n - For US Wire, transaction.unstructured_remittance_info is an optional field, Upto 4*35 Char can be provided . Payment Detail lines should not exceed 35 characters per line \n- For US ACH CCD/PPD/IAT payment, transaction.unstructured_remittance_info field is optional where two lines at max allowed. 1st line to have max 70 chars, 2nd line to have a max of 10 chars \n - For Japan Instant payment transaction.unstructured_remittance_info field is not applicable \n - For SEPA, transaction.unstructured_remittance_info field is optional and Maximum length is 140 and 1 instance is allowed \n- For SEPA VoP Opt Out case, package id should be passed in this field starting with 'PID ,for instance 'PID6782512314'"
          title: unstructured_remittance_info
          items:
            $ref: '#/components/schemas/Unstructured'
        advice_type:
          type: string
          description: "Beneficiary advice type \n- EMAL - EMail, FAXI - Fax, SMSM - SMS Phone Number, URID - UniformResourceIdentifier \n- For TH Instant payment transaction.advice_type field is not applicable \n- For US Instant payment transaction.advice_type field is not applicable \n- For IN IMPS transaction.advice_type field is optional with max length 4 \n- For UK FPS Instant payment transaction.advice_type field is not applicable \n- For IN UPI transaction.advice_type field is optional, applicable values are SMSM or EMAL \n - For US Wire, transaction.advice_type field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.advice_type field is not applicable \n - For SEPA, Japan Instant payment transaction.advice_type field is not applicable \n- For India FIR IMPS payment transaction.advice_type field is optional with max length 4"
          title: advice_type
          enum:
          - EMAL
          - FAXI
          - SMSM
          - URID
        advice_address:
          type: string
          maxLength: 2048
          minLength: 1
          description: "Used by ISOXML Format for Internet Address \n- For SEPA, TH Instant payment transaction.advice_address field is not applicable \n- For US Instant payment transaction.advice_address field is not applicable \n- For IN IMPS transaction.advice_address field is optional \n- For UK FPS Instant payment transaction.advice_address field is not applicable \n- For IN UPI transaction.advice_address field is mandatory, if transaction.advice_type is EMAL \n - For US Wire, transaction.advice_address field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.advice_address field is not applicable \n - For Japan Instant payment transaction.advice_address field is not applicable"
          title: advice_address
        category:
          type: string
          description: "Specifies the high level purpose of the instruction \n- For SEPA, Thailand PromptPay transaction.category field is not applicable \n- For United States transaction.category field is optional \n- For IN IMPS transaction.category field is not applicable \n- For UK FPS Instant payment transaction.category field is not applicable \n- For IN UPI transaction.category field is not applicable \n - For US Wire, transaction.category field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.category field is mandatory and allowed value is CCD, PPD and IAT \n - For Japan Instant payment transaction.category field is not applicable \n - For India FIR IMPS payment transaction.category field is applicable and allowed value is FIR and FDL"
          enum:
          - CONSUMER
          - BUSINESS
          - CCD
          - PPD
          - IAT
          - FIR
          - FDL
          - BIZZ
          - CONS
          - GOVT
          title: category
        priority:
          type: string
          description: "Indicator of the urgency of the payment to instructed party. \n- For SEPA, Thailand PromptPay transaction.priority field is not applicable \n- For United States transaction.priority field is not applicble \n- For IN IMPS transaction.priority field is not applicable \n- For UK FPS Instant payment transaction.priority field is not applicable \n- For IN UPI transaction.priority field is not applicable \n - For US Wire, transaction.priority is an optional field \n - For US ACH CCD/PPD/IAT payment, transaction.priority field is not applicable \n - For Japan Instant payment transaction.category field is not applicable"
          enum:
          - HIGH
          - NORM
          title: priority
        charges_paid_by:
          type: string
          maxLength: 128
          minLength: 1
          description: "Indicator of the charges of the payment. \n- For Thailand PromptPay transaction.charges_paid_by field is not applicable \n- For United States transaction.charges_paid_by field is not applicble \n- For IN IMPS transaction.charges_paid_by field is not applicable \n- For UK FPS Instant payment transaction.charges_paid_by field is not applicable \n - For US Wire, transaction.charges_paid_by is an optional field with allowed values CRED,DEBT,SHAR \n - For US ACH CCD/PPD/IAT payment, transaction.charges_paid_by field is not applicable \n - For Japan Instant payment transaction.charges_paid_by field is not applicable \n - For SEPA, transaction.charges_paid_by field is not applicable"
          title: charges_paid_by
        payment_information_id:
          type: string
          maxLength: 35
          minLength: 1
          description: "Payment Information ID for payment \n- For SEPA, Thailand PromptPay transaction.payment_information_id field is not applicable \n- For United States transaction.payment_information_id field is not applicable \n- For IN IMPS transaction.payment_information_id field is not applicable \n- For UK FPS Instant payment transaction.payment_information_id field is not applicable \n - For US Wire, transaction.payment_information_id is an mandatory field and allowed max length is 34 Numeric (0-9). \n - For US ACH CCD/PPD/IAT payment, transaction.payment_information_id field is mandatory and allowed max length is 10 Numeric (0-9). \n - For Japan Instant payment transaction.payment_information_id field is not applicable"
          title: payment_information_id
        category_purpose:
          type: string
          maxLength: 128
          minLength: 1
          description: "category_purpose field contains purpose of the payments \n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments transaction.category_purpose is not applicable \n - For SEPA, transaction.category_purpose is optional field and allows max length as 35"
          title: category_purpose
        regulatory_reporting:
          $ref: '#/components/schemas/regulatory-reporting'
        structured_remittance_info:
          $ref: '#/components/schemas/structured-remittance-info'
        tax_information:
          type: array
          minItems: 1
          maxItems: 3
          description: tax_information
          items:
            $ref: '#/components/schemas/tax-information'
          title: tax_information
    Debtor-Initiation:
      type: object
      title: DebtorInitiation
      required:
      - account
      properties:
        proxy_id:
          maxLength: 255
          minLength: 1
          type: string
          description: "Debtor's proxy identification (e.g., email address) \n - For TH Instant payment debtor.proxy_id is optional \n - For US Instant payment debtor.proxy_id is not applicable \n - For IN IMPS debtor.proxy_id is not applicable \n - For UK FPS Instant payment debtor.proxy_id is not applicable \n - For IN UPI Instant payment debtor.proxy_id is mandatory, applicable value VPA ID \n - For US Wire payment, debtor.proxy_id field is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.proxy_id field is not applicable \n - For Japan Instant payment, debtor.proxy_id field is not applicable \n - For SEPA, debtor.proxy_id is optional"
          title: proxy_id
        proxy_type:
          type: string
          enum:
          - BIID
          - EMAL
          - EWAL
          - MBNO
          - NIDN
          description: "Debtor's proxy type (BIID for bill identification, EMAL for email address, EWAL for electronic wallet identification, MBNO for mobile number and NIDN for national identification)\n - For TH Instant payment debtor.proxy_type is optional \n - For US Instant payment debtor.proxy_type is not applicable \n - For IN IMPS debtor.proxy_type is not applicable \n - For UK FPS Instant payment debtor.proxy_type is not applicable \n - For IN UPI Instant payment debtor.proxy_type is not applicable \n - For US Wire payment, proxy_type field is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.proxy_type field is not applicable \n - For Japan Instant payment, debtor.proxy_type field is not applicable \n - For SEPA, debtor.proxy_type field is optional"
          title: proxy_type
        account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Debtor's bank account  \n - For IN IMPS, debtor.account max length is 34 \n - For UK FPS Instant payment debtor.account field allowed max length is 34 and either account number or IBAN/BBAN number can be passed \n - For IN UPI Instant payment debtor.account field allowed max length is 34 \n- For US Instant payment, debtor.account is a mandatory field with max length 34 and allowed value is Virtual account number and DDA. \n - For US Wire payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. \n - For US ACH CCD/PPD payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. \n - For US ACH IAT payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. \n - For Japan Instant payment debtor.account field is mandatory and allowed max length is 34 \n - For SEPA, debtor.account is mandatory and allowed max length is 34"
          title: account
        name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Debtor's bank account name \n - For TH Instant payment debtor.name is not applicable \n - For US Instant payment debtor.name is mandatory \n - For IN IMPS Instant payment debtor.name is mandatory with max length 99 \n - For UK FPS Instant payment debtor.name field is optional with max length 40 \n - For IN UPI Instant payment debtor.name is mandatory with max length 99 \n - For US Wire payment, debtor.name field is mandatory with max length 35. Name cannot contains only NUMERIC values \n - For US ACH CCD/PPD payment, debtor.name field is mandatory with max length 16 \n - For US ACH IAT payment, debtor.name field is mandatory with max length 35 \n - For Japan Instant payment debtor.name field is optional. It allows zengin characters ｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜｦﾝ , upper character alphabets A-Z, numeric characters 0 to 9 and special characters as follows . , () - \n - For SEPA, debtor.name is mandatory and should not be more than 70 characters"
          title: name
        address_lines:
          type: array
          description: "Debtor's address_lines \n - For TH Instant payment debtor.address_lines is not applicable \n - For US Instant payment debtor.address_lines is optional \n - For IN IMPS debtor.address_lines is optional and allowed seven instance with each line max length of 70 \n - For UK FPS Instant payment debtor.address_lines is optional and allowed only four instance with each line max length of 35 \n - For IN UPI debtor.address_lines is optional and allowed seven instance with each line max length of 70 \n - For US Wire payment, debtor.address_lines field is conditional and upto 3 lines of min 1 and max 35 characters are allowed. Partial addresses will not be accepted, Street name, city and country should present in address_line. address_lines should present only if structured address tags (street name, building number, city, state and postal code) are not present \n - For US ACH CCD/PPD/IAT payment, debtor.address_lines is mandatory when structured address lines fields are not provided and allowed three instance with each line max length of 35, Address Line 1 should have Building info followed by asterik, Street Address ends with a single backslash \n Address Line 2 and then application to check  Address Line2 should have City followed by asterik, State ends with a single backslash Address Line 3 should have Zip Code followed by asterik, Country Code ends with a single backslash For example Zip code*US\\ \n - For Japan Instant payment debtor.address_lines is not applicable \n - For SEPA, debtor.address_lines is optional and each Line contains max 70 characters with 2 occurrences"
          items:
            $ref: '#/components/schemas/Address'
          title: address_lines
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Debtor's street_name \n - For TH Instant payment debtor.street_name is not applicable \n - For US Instant payment debtor.street_name is optional \n - For IN IMPS, SEPA debtor.street_name is optional and max length is 70 \n - For UK FPS Instant payment debtor.street_name is not applicable \n - For IN UPI debtor.street_name is optional \n - For US Wire, debtor.street_name field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required \n - For US ACH CCD/PPD/IAT payment, debtor.street_name field is mandatory when debtor.address_lines field is not provided and allowed max length is 18 \n - For Japan Instant payment debtor.street_name is not applicable \n - For SEPA, debtor.street_name is optional with MaxLength as 70"
          title: street_name
        building_number:
          maxLength: 16
          minLength: 1
          type: string
          description: "Debtor's building_number \n - For TH Instant payment debtor.building_number is not applicable \n - For US Instant payment debtor.building_number field is optional \n - For IN IMPS debtor.building_number field is optional \n - For UK FPS Instant payment debtor.building_number is not applicable \n - For IN UPI debtor.building_number field is optional \n - For US Wire payment, debtor.building_number field is conditional with max length 16. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, debtor.building_number field is mandatory when debtor.address_lines field is not provided and allowed max length is 16 \n - For Japan Instant payment debtor.building_number is not applicable \n - For SEPA, debtor.building_number is optional and max length is 16"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Debtor's postal_code \n - For TH Instant payment debtor.postal_code is not applicable \n - For US Instant payment debtor.postal_code field is optional \n - For IN IMPS debtor.postal_code is optional \n - For UK FPS Instant payment debtor.postal_code is not applicable \n - For IN UPI debtor.postal_code is optional \n - For US Wire, debtor.postal_code field is conditional with max length 16. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, debtor.postal_code field is mandatory when debtor.address_lines field is not provided and allowed max length is 16 \n - For Japan Instant payment debtor.postal_code is not applicable \n - For SEPA, debtor.postal_code is optional with Max length 16"
          title: postal_code
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's city \n - For TH Instant payment city is not applicable \n - For US Instant payment city field is optional \n - For IN IMPS debtor.city is optional \n - For UK FPS Instant payment debtor.city is not applicable \n - For IN UPI debtor.city is optional \n - For US Wire, debtor.city field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, debtor.city field is mandatory when debtor.address_lines field is not provided and allowed max length is 32 \n - For Japan Instant payment debtor.city is not applicable \n - For SEPA, debtor.city is optional with max length 35"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's State \n - For TH Instant payment debtor.state is not applicable \n - For US Instant payment debtor.state field is optional \n - For IN IMPS debtor.state is optional \n - For UK FPS Instant payment debtor.state is not applicable \n - For IN UPI debtor.state is optional  \n - For US Wire, debtor.state field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, debtor.state field is mandatory when debtor.address_lines field is not provided and allowed max length is 2 \n - For Japan Instant payment debtor.state is not applicable \n - For SEPA, debtor.state is optional and allowed max length is 35"
          title: state
        country:
          type: string
          description: "Debtor's Country \n - For TH Instant payment debtor.country is not applicable \n - For US Instant payment debtor.country field is optional \n - For IN IMPS debtor.country is optional \n - For UK FPS Instant payment debtor.country field is mandatory, if debtor.address_line is provided by client \n - For IN UPI debtor.country is optional \n - For US Wire, debtor.country field is mandatory with max length 2. \n - For US ACH CCD/PPD/IAT payment, debtor.country field is mandatory when debtor.address_lines field is not provided and allowed max length is 2 \n - For Japan Instant payment debtor.country is not applicable \n - For SEPA, debtor.country is optional and allowed max length is 2"
          pattern: ^[A-Z]{2,2}$
          title: country
        org_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's org_id \n - For TH Instant payment debtor.org_id is not applicable \n - For US Instant payment debtor.org_id field is optional. Pattern should be followed [A-Z0-9]{18,18}[0-9]{2,2} where first 18 characters can be uppercase or numbers and the last two characters must be numeric \n - For IN IMPS debtor.org_id is not applicable \n - For UK FPS Instant payment debtor.org_id is not applicable \n - For IN UPI debtor.org_id is not applicable \n - For US Wire, debtor.org_id is not applicable \n - For US ACH CCD/PPD/IAT payments, debtor.org_id field is optional \n - For Japan Instant payment debtor.org_id is not applicable \n - For SEPA, debtor.org_id field is conditional optional with either debtor.org_id or debtor.prvt_id or combination of debtor.birth_date/birth_city/birth_country should be populated"
          title: org_id
        birth_date:
          type: string
          format: date
          description: "ISO 8601 (YYYY-MM-DD), Debtor's birth_date \n - For TH Instant payment debtor.birth_date is not applicable \n - For US Instant payment debtor.birth_date field is optional \n - For IN IMPS debtor.birth_date is not applicable \n - For UK FPS Instant payment debtor.birth_date is not applicable \n - For IN UPI debtor.birth_date is not applicable  \n - For Stripe_US Wire, debtor.birth_date is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.birth_date field is not applicable \n - For Japan Instant payment debtor.birth_date is not applicable \n - For SEPA IDP, debtor.birth_date is optional \n - For SEPA, debtor.birth_date is optional"
          title: birth_date
        birth_city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's birth_city \n - For TH Instant payment debtor.birth_city is not applicable \n - For US Instant payment debtor.birth_city field is optional \n - For IN IMPS debtor.birth_city is not applicable \n - For UK FPS Instant payment debtor.birth_city is not applicable \n - For IN UPI debtor.birth_city is not applicable  \n - For Stripe_US Wire, debtor.birth_city is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.birth_city field is not applicable \n - For Japan Instant payment debtor.birth_city is not applicable \n - For SEPA, debtor.birth_city is conditional mandatory with city in which the person is born"
          title: birth_city
        birth_country:
          type: string
          description: "Debtor's birth_country \n - For TH Instant payment debtor.birth_country is not applicable \n - For US Instant payment debtor.birth_country field is optional \n - For IN IMPS debtor.birth_country is not applicable \n - For UK FPS Instant payment debtor.birth_country is not applicable \n - For IN UPI debtor.birth_country is not applicable \n - For Stripe_US Wire, debtor.birth_country is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.birth_country field is not applicable \n - For Japan Instant payment debtor.birth_country is not applicable \n - For SEPA, debtor.birth_country is conditional mandatory with country in which person is born"
          pattern: ^[A-Z]{2,2}$
          title: birth_country
        birth_province:
          maxLength: 35
          minLength: 1
          type: string
          description: " Debtor Province Of Birth \n - For TH Instant payment debtor.birth_province is not applicable \n - For US Instant payment debtor.birth_province is not applicable \n - For IN IMPS debtor.birth_province is not applicable \n - For UK FPS Instant payment debtor.birth_province is not applicable \n - For IN UPI debtor.birth_province is not applicable \n - For US Wire, debtor.birth_province is not applicable \n - For US ACH CCD/PPD payment, debtor.birth_province is not applicable \n - For US ACH IAT payment, debtor.birth_province is not applicable \n - For US ACH IAT payment, debtor.birth_province is not applicable \n- For SEPA, debtor.birth_province is optional with max length 35 \n - For Japan Instant payment debtor.birth_province is not applicable"
          title: birth_province
        virtual_account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Debtor's virtual account (also kown as PAYER ID) \n - For TH Instant payment debtor.virtual_account field is optional \n - For US Instant payment debtor.virtual_account field is not applicable \n - For IN IMPS debtor.virtual_account field is not applicable \n - For UK FPS Instant payment debtor.virtual_account is not applicable \n - For IN UPI debtor.virtual_account field is not applicable  \n - For Stripe_US Wire, debtor.vitual_account is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.virtual_account field is not applicable \n - For Japan Instant payment debtor.virtual_account is not applicable \n - For SEPA, debtor.virtual_account is not applicable"
          title: virtual_account
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor bank's network identification (e.g., routing number in the United States) \n - For TH Instant payment debtor.bank_id field is optional and allowed maxlength is 3 \n - For US Instant payment debtor.bank_id field is mandatory \n - For IN IMPS Instant payment debtor.bank_id field is mandatory and client should pass IFSC code (including branch code)  \n - For UK FPS Instant payment debtor.bank_id field is optional and allowed maxlength is 11 \n - For IN UPI Instant payment debtor.bank_id field is mandatory with max length 11 \n - For US Wire, debtor.bank_id field is mandatory. Either BIC or MmbId must be provided. If the input is BIC, min and max length should be 8 and 11 and should adhere to pattern [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}. If it is routing code, min and max length is 9. BIC is mandatory if branch 915 used, routing code should not be used if branch 915 is used \n - For US ACH CCD/PPD/IAT payment, debtor.bank_id field is optional and allowed max length is 9  \n - For Japan Instant payment debtor.bank_id is optional \n - For SEPA, debtor.bank_id field is mandatory with max length as 11 and Debtor Agent BIC should be either 8 or 11 characters with Country code in the fifth and sixth characters, the optional characters 9-11 may be 'XXX'"
          title: bank_id
        mobile_number:
          maxLength: 34
          type: string
          pattern: ^[+]{1}[9]{1}[1]{1}[-][0-9]{10}$
          description: "Debtor's mobile number \n - For TH Instant payment debtor.mobile_number field is not applicable \n - For US Instant payment debtor.mobile_number field is not applicable \n - For IN IMPS debtor.mobile_number field is optional \n - For UK FPS Instant payment debtor.mobile_number is not applicable \n- For IN UPI debtor.mobile_number field is mandatory, if transaction.advice_type is SMSM \n - For Stripe_US Wire, debtor.mobile_number is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.mobile_number field is not applicable \n - For Japan Instant payment debtor.mobile_number is not applicable \n - For SEPA, debtor.mobile_number field is not applicable"
          title: mobile_number
        email_address:
          type: string
          maxLength: 2048
          minLength: 1
          description: Debtor's email address
          title: email_address
        prvt_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's private id \n - For TH Instant payment debtor.prvt_id is not applicable \n - For US Instant payment debtor.prvt_id field is optional with max length 35.Either org_id or prvt_id or none of them should be passed by client \n - For IN IMPS debtor.prvt_id is not applicable \n - For UK FPS Instant payment debtor.prvt_id is not applicable \n - For IN UPI debtor.prvt_id is not applicable \n - For Stripe_US Wire, debtor.prvt_id is not applicable \n - For US ACH CCD/PPD/IAT payments, debtor.prvt_id field is optional and applicable value is tax identification \n - For Japan Instant payment debtor.prvt_id is not applicable \n - For SEPA, debtor.prvt_id field is conditional optional with either debtor.org_id or debtor.prvt_id or combination of debtor.birth_date/birth_city/birth_country should be populated"
          title: prvt_id
        bank_instructions:
          maxLength: 140
          minLength: 1
          type: string
          description: "instruction for debtor agent Indicator of the urgency of the payment to instructed party. \n- For Thailand PromptPay debtor.bank_instructions field is not applicable \n- For United States debtor.bank_instructions field is not applicble \n- For IN IMPS debtor.bank_instructions field is not applicable \n- For UK FPS Instant payment debtor.bank_instructions field is not applicable \n- For IN UPI debtor.bank_instructions field is not applicable \n - For US Wire, debtor.bank_instructions is an optional field with min 1 and max 35 characters . This fields is used to provide Bank to Bank details in the multiple occurrences of this tag. Further information related to the processing of the payment instruction that may need to be acted upon by the debtor agent, depending on agreement between debtor and the debtor agent. The following instructions to Citibank are supported: - /PREFORMAT/code/group - preformat code and group - /CONFIDENTIAL/ - confidential indicator - /REC/info - information to Citigroup operations - information without code word is interpreted as /REC/ \n - For US ACH CCD/PPD/IAT payment, debtor.bank_instructions field is optional, client want to do confidential transaction then the value should be /CONFIDENTIAL/ and client want to do Preformat transaction then the value should be /PREFORMAT/CODE/GROUP. \n - For Japan Instant payment debtor.bank_instructions is not applicable \n - For SEPA, debtor.bank_instructions field is not applicable"
          title: bank_instructions
        bank_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Debtor's bank name \n - For TH Instant payment debtor.bank_name is not applicable \n - For US Instant payment debtor.bank_name is not applicable \n - For IN IMPS Instant payment debtor.bank_name is not applicable \n - For UK FPS Instant payment debtor.bank_name is not applicable \n - For IN UPI Instant payment debtor.bank_name is not applicable \n - For US Wire payment, debtor.bank_name is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.bank_name is optional with max length 35 \n - For Japan Instant payment debtor.bank_name is not applicable \n - For India FIR IMPS payment, debtor.bank_name is mandatory with max length 100 \n - For SEPA, debtor.bank_name field is not applicable"
          title: bank_name
        bank_account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Debtor's bank account number \n - For TH, US , IN IMPS, UK FPS, IN UPI, US Wire, US ACH CCD/PPD/IAT and JP payments debtor.bank_account is not applicable \n - For India FIR IMPS payment, debtor.bank_account field is mandatory \n - For SEPA, debtor.bank_account field is not applicable"
          title: bank_account
        scheme_name:
          maxLength: 128
          minLength: 1
          type: string
          description: "Debtor's scheme name \n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments debtor.scheme_name is not applicable \n - For SEPA, debtor.scheme_name field is optional with max length as 35"
          title: scheme_name
        department:
          maxLength: 70
          minLength: 1
          type: string
          description: "debtor Address Department \n - For TH Instant payment debtor.department is not applicable \n - For US Instant payment debtor.department is not applicable \n - For IN IMPS debtor.department is not applicable \n - For UK FPS Instant payment debtor.department is not applicable \n - For IN UPI debtor.department is not applicable \n - For US Wire, debtor.department is not applicable \n - For US ACH CCD/PPD payment, debtor.department is not applicable \n - For US ACH IAT payment, debtor.department is not applicable \n - For US ACH IAT payment, debtor.department is not applicable \n- For SEPA IDP, debtor.department is optional with max length 70 \n - For Japan Instant payment debtor.department field is not applicable \n- For SEPA, debtor.department is optional with max length 70"
          title: department
        sub_department:
          maxLength: 70
          minLength: 1
          type: string
          description: "debtor Address Sub-Department \n - For TH Instant payment debtor.sub_department is not applicable \n - For US Instant payment debtor.sub_department is not applicable \n - For IN IMPS debtor.sub_department is not applicable \n - For UK FPS Instant payment debtor.sub_department is not applicable \n - For IN UPI debtor.sub_department is not applicable \n - For US Wire, debtor.sub_department is not applicable \n - For US ACH CCD/PPD payment, debtor.sub_department is not applicable \n - For US ACH IAT payment, debtor.sub_department is not applicable \n - For US ACH IAT payment, debtor.sub_department is not applicable \n- For SEPA IDP, debtor.sub_department is optional with max length 70 \n - For Japan Instant payment debtor.sub_department field is not applicable \n- For SEPA, debtor.sub_department is optional with max length 70"
          title: sub_department
        building_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "debtor building name \n - For TH Instant payment debtor.building_name is not applicable \n - For US Instant payment debtor.building_name is not applicable \n - For IN IMPS debtor.building_name is not applicable \n - For UK FPS Instant payment debtor.building_name is not applicable \n - For IN UPI debtor.building_name is not applicable \n - For US Wire, debtor.building_name is not applicable \n - For US ACH CCD/PPD payment, debtor.building_name is not applicable \n - For US ACH IAT payment, debtor.building_name is not applicable \n - For US ACH IAT payment, debtor.building_name is not applicable \n- For SEPA IDP, debtor.building_name is optional with max length 35 \n - For Japan Instant payment debtor.building_name field is not applicable \n- For SEPA, debtor.building_name is optional with max length 35"
          title: building_name
        floor:
          maxLength: 70
          minLength: 1
          type: string
          description: "debtor address floor \n - For TH Instant payment debtor.floor is not applicable \n - For US Instant payment debtor.floor is not applicable \n - For IN IMPS debtor.floor is not applicable \n - For UK FPS Instant payment debtor.floor is not applicable \n - For IN UPI debtor.floor is not applicable \n - For US Wire, debtor.floor is not applicable \n - For US ACH CCD/PPD payment, debtor.floor is not applicable \n - For US ACH IAT payment, debtor.floor is not applicable \n - For US ACH IAT payment, debtor.floor is not applicable \n- For SEPA IDP, debtor.floor is optional with max length 70 \n - For Japan Instant payment debtor.floor field is not applicable \n- For SEPA, debtor.floor is optional with max length 70"
          title: floor
        post_box:
          maxLength: 16
          minLength: 1
          type: string
          description: "debtor address post box \n - For TH Instant payment debtor.post_box is not applicable \n - For US Instant payment debtor.post_box is not applicable \n - For IN IMPS debtor.post_box is not applicable \n - For UK FPS Instant payment debtor.post_box is not applicable \n - For IN UPI debtor.post_box is not applicable \n - For US Wire, debtor.post_box is not applicable \n - For US ACH CCD/PPD payment, debtor.post_box is not applicable \n - For US ACH IAT payment, debtor.post_box is not applicable \n - For US ACH IAT payment, debtor.post_box is not applicable \n- For SEPA IDP, debtor.post_box is optional with max length 16 \n - For Japan Instant payment debtor.post_box field is not applicable \n- For SEPA, debtor.post_box is optional with max length 16"
          title: post_box
        room:
          maxLength: 70
          minLength: 1
          type: string
          description: "debtor address room \n - For TH Instant payment debtor.room is not applicable \n - For US Instant payment debtor.room is not applicable \n - For IN IMPS debtor.room is not applicable \n - For UK FPS Instant payment debtor.room is not applicable \n - For IN UPI debtor.room is not applicable \n - For US Wire, debtor.room is not applicable \n - For US ACH CCD/PPD payment, debtor.room is not applicable \n - For US ACH IAT payment, debtor.room is not applicable \n - For US ACH IAT payment, debtor.room is not applicable \n- For SEPA IDP, debtor.room is optional with max length 70 \n - For Japan Instant payment debtor.room field is not applicable \n- For SEPA, debtor.room is optional with max length 70"
          title: room
        town_location_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "debtor address town location name \n - For TH Instant payment debtor.town_location_name is not applicable \n - For US Instant payment debtor.town_location_name is not applicable \n - For IN IMPS debtor.town_location_name is not applicable \n - For UK FPS Instant payment debtor.town_location_name is not applicable \n - For IN UPI debtor.town_location_name is not applicable \n - For US Wire, debtor.town_location_name is not applicable \n - For US ACH CCD/PPD payment, debtor.town_location_name is not applicable \n - For US ACH IAT payment, debtor.town_location_name is not applicable \n - For US ACH IAT payment, debtor.town_location_name is not applicable \n- For SEPA IDP, debtor.town_location_name is optional with max length 35 \n - For Japan Instant payment debtor.town_location_name field is not applicable \n- For SEPA, debtor.town_location_name is optional with max length 35"
          title: town_location_name
        district_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "debtor address district_name \n - For TH Instant payment debtor.district_name is not applicable \n - For US Instant payment debtor.district_name is not applicable \n - For IN IMPS debtor.district_name is not applicable \n - For UK FPS Instant payment debtor.district_name is not applicable \n - For IN UPI debtor.district_name is not applicable \n - For US Wire, debtor.district_name is not applicable \n - For US ACH CCD/PPD payment, debtor.district_name is not applicable \n - For US ACH IAT payment, debtor.district_name is not applicable \n - For US ACH IAT payment, debtor.district_name is not applicable \n- For SEPA IDP, debtor.district_name is optional with max length 35 \n - For Japan Instant payment debtor.district_name field is not applicable \n- For SEPA, debtor.district_name is optional with max length 35"
          title: district_name
        anybic:
          maxLength: 35
          minLength: 1
          type: string
          description: "debtor BIC \n - For TH Instant payment debtor.anybic is not applicable \n - For US Instant payment debtor.anybic is not applicable \n - For IN IMPS debtor.anybic is not applicable \n - For UK FPS Instant payment debtor.anybic is not applicable \n - For IN UPI debtor.anybic is not applicable \n - For US Wire, debtor.anybic is not applicable \n - For US ACH CCD/PPD payment, debtor.anybic is not applicable \n - For US ACH IAT payment, debtor.anybic is not applicable \n - For US ACH IAT payment, debtor.anybic is not applicable \n- For SEPA IDP, debtor.anybic is optional with max length 11 \n - For Japan Instant payment debtor.anybic field is not applicable \n- For SEPA, debtor.anybic is optional with max length 11"
          title: anybic
        lei:
          maxLength: 35
          minLength: 1
          type: string
          description: "Unique global identifier for legal entities participating in financial transactions \n - For TH Instant payment debtor.lei is not applicable \n - For US Instant payment debtor.lei is not applicable \n - For IN IMPS debtor.lei is not applicable \n - For UK FPS Instant payment debtor.lei is not applicable \n - For IN UPI debtor.lei is not applicable \n - For US Wire, debtor.lei is not applicable \n - For US ACH CCD/PPD payment, debtor.lei is not applicable \n - For US ACH IAT payment, debtor.lei is not applicable \n - For US ACH IAT payment, debtor.lei is not applicable \n- For SEPA IDP, debtor.lei is optional with max length 20 \n - For Japan Instant payment debtor.lei field is not applicable \n- For SEPA, debtor.lei is optional with max length 20"
          title: lei
        issuer:
          maxLength: 35
          minLength: 1
          type: string
          description: "debtor name that identifies an issuer \n - For TH Instant payment debtor.issuer is not applicable \n - For US Instant payment debtor.issuer is not applicable \n - For IN IMPS debtor.issuer is not applicable \n - For UK FPS Instant payment debtor.issuer is not applicable \n - For IN UPI debtor.issuer is not applicable \n - For US Wire, debtor.issuer is not applicable \n - For US ACH CCD/PPD payment, debtor.issuer is not applicable \n - For US ACH IAT payment, debtor.issuer is not applicable \n - For US ACH IAT payment, debtor.issuer is not applicable \n- For SEPA IDP, debtor.issuer is optional with max length 35 \n - For Japan Instant payment debtor.issuer field is not applicable \n- For SEPA, debtor.issuer is optional with max length 35"
          title: issuer
        bank_branch_id:
          maxLength: 35
          minLength: 1
          type: string
          description: Debtor bank's branch network identification
          title: bank_branch_id
      additionalProperties: false
      description: Debtor information
    Transaction-Status:
      type: object
      title: TransactionStatus
      required:
      - uetr
      - creation_date_time
      - status
      - end_to_end_id
      properties:
        end_to_end_id:
          $ref: '#/components/schemas/Restricted-Finx-Max-Text'
        instruction_id:
          type: string
          description: "Instruction ID of the payment \n- For Thailand PromptPay transaction.instruction_id field is not applicable \n- For United States transaction.instruction_id field is optional \n- For IN IMPS transaction.instruction_id field is not applicable \n- For UK FPS Instant payment transaction.instruction_id field is not applicable \n- For JP Instant payment transaction.instruction_id field is applicable \n- For IN UPI transaction.instruction_id field is not applicable \n- For US Wire, this field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.instruction_id field is not applicable \n- For SEPA IDP transaction.instruction_id field is optional with max length 35 \n - For Japan Instant payment transaction.instruction_id field is not applicable \n- For SEPA, transaction.instruction_id field is optional with max length 35"
          minLength: 1
          maxLength: 35
          title: instruction_id
        uetr:
          type: string
          pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
          description: UUID v4 format unique end-to-end transaction reference
          title: uetr
        network_id:
          maxLength: 128
          minLength: 1
          type: string
          description: "Transaction identification generated by the network (clearing) \n- For SEPA IDP, transaction id will be passed in transaction.network_id field \n- For SEPA, transaction id will be passed in transaction.network_id field"
          title: network_id
        local_reference:
          maxLength: 35
          minLength: 1
          type: string
          description: "This is a Citi generated payment reference which is included in the ‘Bank Reference’ field of bank statement posting for itemized transaction. \n- To utilize the field in production, please contact with implementation manager \n - For TH Instant payment transaction.local_reference is optional \n - For US Instant payment transaction.local_reference field is not applicable \n - For IN IMPS transaction.local_reference is optional \n - For UK FPS Instant payment transaction.local_reference is not applicable \n - For JP Instant payment transaction.local_reference field is applicable \n - For IN UPI transaction.local_reference is optional \n - For US WIRE, transaction.local_reference field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.local_reference field is not applicable \n - For SEPA IDP transaction.local_reference field is not applicable \n - For SEPA, transaction.local_reference field is not applicable"
          title: local_reference
        reference:
          maxLength: 140
          minLength: 1
          type: string
          description: "Electronic Data Interchange It works like a referece for clients to look for additional information in EDI system for Invoice & purchase data. \n - For TH Instant payment transaction.reference is not applicable \n - For US Instant payment transaction.reference field is not applicable \n - For IN IMPS transaction.reference is not applicable \n - For UK FPS Instant payment transaction.reference is not applicable \n - For JP Instant payment transaction.reference is optional \n - For IN UPI transaction.reference is not applicable \n - For US WIRE, transaction.reference field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.reference field is not applicable \n - For SEPA IDP transaction.reference field is not applicable \n - For SEPA, transaction.reference field is not applicable"
          title: reference
        processing_code:
          type: string
          description: "\n- For Thailand this field contains the reference of, Two Digit Process Code + Two Digit From Account + Two Digit To Account\nProcessing Code - Lookup and Account Verification 38 Credit Transfer(TO_ACCOUNT/EWALLET) 48 Bill Payment 55 Generic Inquiry 32 Request To Pay 33 Credit Notification 34 A two digit from account (00 for Default, 10 for Saving, 20 for Checking, 30 for Credit) A two digit to account (00 for Default, 10 for Saving, 20 for Checking, 30 for Credit). To utilize the field in production, please contact with implementation manager \n - For US Instant payment transaction.processing_code field is not applicable \n - For IN IMPS transaction.processing_code is not applicable \n - For UK FPS Instant payment transaction.processing_code is not applicable \n - For JP Instant payment transaction.processing_code is not applicable \n - For IN UPI transaction.processing_code is not applicable \n - For US WIRE, transaction.processing_code field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.processing_code field is not applicable \n - For SEPA IDP transaction.processing_code field is not applicable \n - For SEPA, transaction.processing_code field is not applicable"
          title: processing_code
        batch_id:
          maxLength: 35
          minLength: 1
          type: string
          description: Identification for your Citi account consolidated debit or credit posting including the transaction
          title: batch_id
        bill_id_1:
          maxLength: 128
          pattern: ^[0-9A-Z]{1,128}$
          type: string
          description: "Bill identification \n- Thailand PromptPay - Maximum length is 20. \n - For US Instant payment transaction.bill_id_1 field is not applicable \n - For IN IMPS transaction.bill_id_1 field is not applicable \n - For UK FPS Instant payment transaction.bill_id_1 field is not applicable  \n - For IN UPI transaction.bill_id_1 field is not applicable  \n - For US Wire, transaction.bill_id_1 field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.bill_id_1 field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.bill_id_1 field is not applicable \n- For SEPA, this field is not applicable"
          title: bill_id_1
        bill_id_2:
          maxLength: 128
          pattern: ^[0-9A-Z]{1,128}$
          type: string
          description: "Bill identification \n- Thailand PromptPay - Maximum length is 20. \n - For US Instant payment transaction.bill_id_2 field is not applicable \n - For IN IMPS transaction.bill_id_2 field is not applicable \n - For UK FPS Instant payment transaction.bill_id_2 field is not applicable \n - For IN UPI transaction.bill_id_2 field is not applicable \n - For US Wire, transaction.bill_id_2 field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.bill_id_2 field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.bill_id_2 field is not applicable \n- For SEPA, this field is not applicable"
          title: bill_id_2
        bill_id_3:
          maxLength: 128
          pattern: ^[0-9A-Z]{1,128}$
          type: string
          description: "Bill identification \n- Thailand PromptPay - Maximum length is 20. \n - For US Instant payment transaction.bill_id_3 field is not applicable \n - For IN IMPS transaction.bill_id_3 field is not applicable \n - For UK FPS Instant payment transaction.bill_id_3 field is not applicable \n - For IN UPI transaction.bill_id_3 field is not applicable \n - For US Wire, transaction.bill_id_3 field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.bill_id_3 field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.bill_id_3 field is not applicable \n- For SEPA, this field is not applicable"
          title: bill_id_3
        type:
          type: string
          enum:
          - credit
          - debit
          title: type
        purpose:
          type: string
          minLength: 1
          maxLength: 6
          description: "Purpose of a transaction \n- For Thailand PromptPay transaction.purpose field is optional \n- For US Instant payment transaction.purpose field is optional \n- For IN IMPS transaction.purpose field is optional \n- UK FPS Instant payment transaction.purpose field is optional \n- For IN UPI transaction.purpose field is optional \n- For India FIR IMPS Instant payment transaction.purpose field is mandatory \n- CASH for cash management \n- CNFL for confidential \n- COST for payment for business expenses  \n- GDSV for payment related to purchase or sale of goods and services \n- GP2P for person-to-person payment \n- OTHR for other, if your payment doesn't fit any of the specific purpose codes  \n- RCPT for payment of a receipt \n- SALA for salary payment  \n- SUPP for supplier payment \n- TREA for treasury payment \n- REFU for refund payment \n- CLPO for Claim Payouts \n- LODI for Loan Disbursals \n- TIPO for Tips Payout \n- GIEO for Gig economy \n- VEPO for Vendor Payouts \n- INPO for Incentive Payouts \n- ISPO for Insurance Payouts \n- MPPO for Merchant/Marketplace Payouts \n- TXPO for Tax Payments \n- RDPO for Rider payout \n- GDDS for payment related to purchase or sale of goods \n- SCVE for payment related to purchase or sale of services \n- PAYR for payroll payment \n- NOWS for Not Otherwise Specified \n- INVS for Invoice Signed \n- INSC for Payment Of Insurance Claim \n- INSM for Installment \n- PDEP for Property Deposit \n- UBIL for Utilities Subscription Identification \n- ACCT for Account Management \n- CBLK for Bulk card transactions \n- MP2P for Mobile P2P Payment \n - For US Wire, transaction.purpose field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.purpose field is not applicable \n- For SEPA IDP this field is optional \n - For Japan Instant payment transaction.purpose field is not applicable \n- For SEPA, this field is optional"
          title: purpose
        tax_code:
          type: number
          enum:
          - 0
          - 1
          - 2
          description: "Tax code \n- Thailand PromptPay - Provide 0 if transaction is without value-added tax or withholding tax. Provide 1 if transaction is with value-added tax or withholding tax. Provide 2 if transaction is with ewht \n - For US Instant payment transaction.tax_code field is not applicable \n - For IN IMPS transaction.tax_code field is not applicable \n - For UK FPS Instant payment transaction.tax_code field is not applicable \n - For IN UPI transaction.tax_code field is not applicable \n - For US Wire, transaction.tax_code field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.tax_code field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.tax_code field is not applicable \n- For SEPA, this field is not applicable"
          title: tax_code
        wht_code:
          type: string
          enum:
          - A
          - S
          - B
          description: "Withholding tax (WHT) code \n- Thailand PromptPay - If you provide tax_code 1, wht_code is required. Povide A for WHT always paid by the seller, S for WHT once paid by the seller or B for WHT paid by the buyer. \n - For US Instant payment transaction.wht_code field is not applicable \n - For IN IMPS transaction.wht_code field is not applicable \n - For UK FPS Instant payment transaction.wht_code field is not applicable \n - For IN UPI transaction.wht_code field is not applicable \n - For US Wire, transaction.wht_code field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.wht_code field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.wht_code field is not applicable \n- For SEPA, this field is not applicable"
          title: wht_code
        income_type:
          type: string
          pattern: ^(00[0-9]|01[0-2])$
          description: "Income type \n- Thailand PromptPay -  If you provide tax_code 1, income_type is required. Provide 001 for service and professional fee for a company with Thailand location, 002 for service and professional fee for a company without Thailand location, 003 for royalty, 004 for rent, 005 for ship rental fee, 006 for prize, 007 for promotion, 008 for actor fee, 009 advertising, 010 non-life insurance premium, 011 for  transportation cost and 012 for agricultural purchase. \n - For US Instant payment transaction.income_type field is not applicable \n - For IN IMPS transaction.income_type field is not applicable \n - For UK FPS Instant payment transaction.income_type field is not applicable \n - For IN UPI transaction.income_type field is not applicable  \n - For US Wire, transaction.income_type field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.income_type field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.income_type field is not applicable \n- For SEPA, this field is not applicable"
          title: income_type
        vat_rate:
          type: number
          minimum: 0
          description: "Value-added tax (VAT) rate \n - For TH Instant Payent Range is 0 - 99.99  \n - For US Instant payment transaction.vat_rate field is not applicable \n - For IN IMPS transaction.vat_rate field is not applicable \n - For UK FPS Instant payment transaction.vat_rate field is not applicable \n - For IN UPI transaction.vat_rate field is not applicable  \n - For US Wire, transaction.vat_rate field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.vat_rate field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.vat_rate field is not applicable \n- For SEPA, this field is not applicable"
          title: vat_rate
        vat_amount:
          type: number
          maximum: 1000000000000000
          description: "Value-added tax (VAT) amount \n - Thailand PromptPay - Maximum amount is 2000000.00. \n - For US Instant payment transaction.vat_amount field is not applicable \n - For IN IMPS transaction.vat_amount field is not applicable \n - For UK FPS Instant payment transaction.vat_amount field is not applicable \n - For IN UPI transaction.vat_amount field is not applicable \n - For US Wire, transaction.vat_amount field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.vat_amount field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.vat_amount field is not applicable \n- For SEPA, this field is not applicable"
          title: vat_amount
        wht_rate:
          type: number
          minimum: 0
          description: "Withholding tax (WHT) rate (0 - 99.99) \n - Thailand PromptPay - Maximum rate is 5.00. \n - For US Instant payment transaction.wht_rate field is not applicable  \n - For IN IMPS transaction.wht_rate field is not applicable \n - For UK FPS Instant payment transaction.wht_rate field is not applicable \n - For IN UPI transaction.wht_rate field is not applicable \n - For US Wire, transaction.wht_rate field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.wht_rate field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.wht_rate field is not applicable \n- For SEPA, this field is not applicable"
          title: wht_rate
        wht_amount:
          type: number
          maximum: 1000000000000000
          description: "Withholding tax (WHT) amount \n - Thailand PromptPay - Maximum amount is 2000000.00. \n - For US Instant payment transaction.wht_amount field is not applicable \n - For IN IMPS transaction.wht_amount field is not applicable \n - For UK FPS Instant payment transaction.wht_amount field is not applicable \n - For IN UPI transaction.wht_amount field is not applicable \n - For US Wire, transaction.wht_amount field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.wht_amount field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.wht_amount field is not applicable \n- For SEPA, this field is not applicable"
          title: wht_amount
        invoice_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: The total amount of the invoice, typically excluding WHT amounts.
          title: invoice_amount
        charges_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: Any additional charges passed on to the beneficiary.
          title: charges_amount
        bill_due_date:
          type: string
          format: date
          description: "ISO 8601 (YYYY-MM-DD) bill due date  \n - For TH Instant payment if client provides transaction.bill_id_1 value, require client to mandatorily provide bill_due_date value. \n - For US Instant payment transaction.bill_due_date field is not applicable \n - For IN IMPS transaction.bill_due_date field is not applicable \n - For UK FPS Instant payment transaction.bill_due_date field is not applicable \n - For IN UPI transaction.bill_due_date field is not applicable \n - For US Wire, transaction.bill_due_date field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.bill_due_date field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.bill_due_date field is not applicable \n- For SEPA, this field is not applicable"
          title: bill_due_date
        creation_date_time:
          type: string
          format: date-time
          description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation \n- Instant Payment (Credit) - Date time, either provided by the debtor bank or generated by Citi's transaction processing application, when a transaction was created"
          title: creation_date_time
        value_date:
          type: string
          format: date
          description: "YYYY-MM-DD Date in local time zone (e.g., EST for a United States RTP network transaction IST for IN IMPS) when Citi's transaction processing application starts processing a transaction \n - For UK Instant payment transaction.value_date field is mandatory, value Date should be current calender date or current calender date +1 or current calender date -1 \n- For US Wire, transaction.value_date is a mandatory field \n - For US ACH CCD/PPD/IAT payment, transaction.value_date field is mandatory \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.value_date field is mandatory, value date should be current calender date or current calender date -7 \n- For SEPA, value date should be current calender date or future calender date till 180 days or current calender date -7"
          title: value_date
        instructed_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: "Instructed amount \n - Thailand PromptPay - Maximum amount is 2000000.00 \n - US RTP - Maximum amount is 1000000.00 \n - IN IMPS - Maximum amount is 500000.00 \n - UK FPS Instant Payment - Maximum amount is 1000000.00 and allowed only Maximum of Two digits after decimal \n - IN UPI - Maximum amount is 200000.00 \n- For US Wire, transaction.instructed_amount is a mandatory field. Maximum amount is $9999999999.99 \n - Japan - Maximum amount is 99,999,999 \n - SEPA - No maximum amount cap"
          title: instructed_amount
        settlement_currency:
          maxLength: 3
          type: string
          description: ISO 4217 code for the transaction settlement amount currency
          title: settlement_currency
        settlement_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: Settlement amount (e.g., after any currency exchange or charge on the instructed amount)
          title: settlement_amount
        total_refunded_amount:
          type: number
          minimum: 0
          maximum: 1000000000000000
          description: Total refunded amount for original transaction. This field will be populated only for refund transactions.
          title: total_refunded_amount
        additional_info:
          type: string
          maxLength: 140
          minLength: 1
          description: "Additional or remittance information \n- Thailand PromptPay - Maximum length is 40. \n - For US Instant payment transaction.additional_info field is not applicable \n - For IN IMPS transaction.additional_info field is not applicable \n - For UK FPS Instant payment transaction.additional_info field is optional and allowed max length is 105 \n - For IN UPI transaction.additional_info field is not applicable  \n - For US Wire, transaction.additional_info field is not applicable\n - For US ACH CCD/PPD payments, transaction.additional_info field is optional. If the client want to verify the beneficiary/Creditor account then value should be /MICE/ACCTVERIFY and transaction amount can not exceed $0.99 \n - For US ACH IAT payment, transaction.additional_info field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.additional_info field is not applicable \n- For SEPA, this field is not applicable"
          title: additional_info
        unstructured_remittance_info:
          type: array
          description: "Unstructured remitance information \n - For TH Instant payment transaction.unstructured_remittance_info field is not applicable \n - For US Instant payment transaction.unstructured_remittance_info field is optional - Maximum length is 140 and Single instance is allowed \n- For IN IMPS transaction.unstructured_remittance_info field is optional where two lines at max allowed. 1st line to have max 35 chars, 2nd line to have a max of 15 chars. Max length for this tag is 50 chars \n - For UK FPS Instant payment transaction.unstructured_remittance_info is optional and allowed only four instance with each line max length of 35 \n- For IN UPI transaction.unstructured_remittance_info field is optional where two lines at max allowed. 1st line to have max 35 chars, 2nd line to have a max of 15 chars. Max length for this tag is 50 chars /n - For US Wire, transaction.unstructured_remittance_info is an optional field, Upto 4*35 Char can be provided . Payment Detail lines should not exceed 35 characters per line \n- For US ACH CCD/PPD/IAT payment, transaction.unstructured_remittance_info field is optional where two lines at max allowed. 1st line to have max 70 chars, 2nd line to have a max of 10 chars. \n - For SEPA and SEPA IDP transaction.unstructured_remittance_info field is optional with max length 140 and ten instances allowed \n - For Japan Instant payment transaction.unstructured_remittance_info field is applicable and Maximum length is 140 and four instance is allowed \n- For SEPA VoP Opt Out case, package id should be passed in this field starting with 'PID ,for instance 'PID6782512314'"
          title: unstructured_remittance_info
          items:
            $ref: '#/components/schemas/Unstructured'
        advice_type:
          type: string
          description: "Beneficiary advice type \n- EMAL - EMail, FAXI - Fax, SMSM - SMS Phone Number, URID - UniformResourceIdentifier \n- For TH Instant payment transaction.advice_type field is not applicable \n- For US Instant payment transaction.advice_type field is not applicable \n- For IN IMPS transaction.advice_type field is optional with max length 4 \n- For UK FPS Instant payment transaction.advice_type field is not applicable \n- For IN UPI transaction.advice_type field is optional, applicable values are SMSM or EMAL \n - For US Wire, transaction.advice_type field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.advice_type field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.advice_type field is not applicable \n- For SEPA, this field is not applicable"
          title: advice_type
          enum:
          - EMAL
          - FAXI
          - SMSM
          - URID
        advice_address:
          type: string
          maxLength: 2048
          minLength: 1
          description: "Used by ISOXML Format for Internet Address \n- For TH Instant payment transaction.advice_address field is not applicable \n- For US Instant payment transaction.advice_address field is not applicable \n- For IN IMPS transaction.advice_address field is optional \n- For UK FPS Instant payment transaction.advice_address field is not applicable \n- For IN UPI transaction.advice_address field is mandatory, if transaction.advice_type is EMAL \n - For US Wire, transaction.advice_address field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.advice_address field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.advice_address field is not applicable \n- For SEPA, this field is not applicable"
          title: advice_address
        category:
          type: string
          description: "Specifies the high level purpose of the instruction \n- For Thailand PromptPay transaction.category field is not applicable \n- For United States transaction.category field is optional \n- For IN IMPS transaction.category field is not applicable \n- For UK FPS Instant payment transaction.category field is not applicable \n- For IN UPI transaction.category field is not applicable \n - For US Wire, transaction.category field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.category field is mandatory and allowed value is CCD, PPD and IAT \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.category field is not applicable \n - For India FIR IMPS payment transaction.category field is applicable and allowed value is FIR and FDL\n- For SEPA, this field is not applicable"
          enum:
          - CONSUMER
          - BUSINESS
          - CCD
          - PPD
          - IAT
          - FIR
          - CONS
          - BIZZ
          - GOVT
          - FDL
          - DEFAULT
          title: category
        priority:
          type: string
          description: "Indicator of the urgency of the payment to instructed party. \n- For Thailand PromptPay transaction.priority field is not applicable \n- For United States transaction.priority field is not applicble \n- For IN IMPS transaction.priority field is not applicable \n- For UK FPS Instant payment transaction.priority field is not applicable \n- For IN UPI transaction.priority field is not applicable \n - For US Wire, transaction.priority is an optional field \n - For US ACH CCD/PPD/IAT payment, transaction.priority field is not applicable \n- For SEPA IDP this field is not applicable \n - For Japan Instant payment transaction.category field is not applicable \n- For SEPA, this field is not applicable"
          enum:
          - HIGH
          - NORM
          title: priority
        charges_paid_by:
          type: string
          maxLength: 128
          minLength: 1
          description: "Indicator of the charges of the payment. \n- For Thailand PromptPay transaction.charges_paid_by field is not applicable \n- For United States transaction.charges_paid_by field is not applicble \n- For IN IMPS transaction.charges_paid_by field is not applicable \n- For UK FPS Instant payment transaction.charges_paid_by field is not applicable \n - For US Wire, transaction.charges_paid_by is an optional field with allowed values CRED,DEBT,SHAR \n - For US ACH CCD/PPD/IAT payment, transaction.charges_paid_by field is not applicable \n- For SEPA IDP,transaction.charges_paid_by is optional with max length 4 \n - For Japan Instant payment transaction.charges_paid_by field is not applicable \n- For SEPA, transaction.charges_paid_by is optional with max length 4 and allowed value is 'SLEV' "
          title: charges_paid_by
        original_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: "Amount that was originally sent by our client. \n - For Thailand PromptPay transaction.original_amount field is not applicable \n- For United States transaction.original_amount field is optional \n- For IN IMPS transaction.original_amount field is not applicable \n- For UK FPS Instant payment transaction.original_amount field is not applicable \n- For JP Instant payment transaction.original_amount field is not applicable \n- For IN UPI transaction.original_amount field is not applicable \n - For US WIRE, transaction.original_amount field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.original_amount field is not applicable \n- For SEPA IDP this field is not applicable \n- For SEPA, this field is not applicable"
          title: original_amount
        full_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: "Amount that is the gross amount payable to our client. If populated, transaction.discount_amount must also be populated \n - For Thailand PromptPay transaction.full_amount field is not applicable \n- For United States transaction.full_amount field is optional \n- For IN IMPS transaction.full_amount field is not applicable \n- For UK FPS Instant payment transaction.full_amount field is not applicable \n- For JP Instant payment transaction.full_amount field is not applicable \n- For IN UPI transaction.full_amount field is not applicable \n - For US WIRE, transaction.full_amount field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.full_amount field is not applicable \n- For SEPA IDP this field is not applicable \n- For SEPA, this field is not applicable"
          title: full_amount
        discount_amount:
          type: number
          minimum: 0.01
          maximum: 1000000000000000
          description: "Amount that is the discount from the gross amount. If populated, transaction.full_amount must also be popluated \n - For Thailand PromptPay transaction.discount_amount field is not applicable \n- For United States transaction.discount_amount field is optional \n- For IN IMPS transaction.discount_amount field is not applicable \n- For UK FPS Instant payment transaction.discount_amount field is not applicable \n- For JP Instant payment transaction.discount_amount field is not applicable \n- For IN UPI transaction.discount_amount field is not applicable \n - For US WIRE, transaction.discount_amount field is not applicable \n - For US ACH CCD/PPD/IAT payment, transaction.discount_amount field is not applicable \n- For SEPA IDP this field is not applicable \n- For SEPA, this field is not applicable"
          title: discount_amount
        interbank_settlement_date:
          type: string
          format: date
          description: "YYYY-MM-DD Date Interbank settlement Date received from clearing  \n - For TH Instant payment transaction.interbank_settlement_date is not applicable \n - For US Instant payment transaction.interbank_settlement_date is optional \n - For IN IMPS transaction.interbank_settlement_date is not applicable \n - For UK FPS Instant payment transaction.interbank_settlement_date is not applicable \n - For IN UPI transaction.interbank_settlement_date is not applicable \n - For US Wire, transaction.interbank_settlement_date is not applicable \n - For US ACH CCD/PPD payment, transaction.interbank_settlement_date is not applicable \n - For US ACH IAT payment, transaction.interbank_settlement_date is not applicable \n - For US ACH IAT payment, transaction.interbank_settlement_date is not applicable \n- For SEPA IDP, transaction.interbank_settlement_date is mandatory \n - For Japan Instant payment transaction.interbank_settlement_date field is not applicable \n- For SEPA, transaction.interbank_settlement_date is mandatory"
          title: interbank_settlement_date
        category_purpose:
          type: string
          maxLength: 128
          minLength: 1
          description: "Category purpose usually contain the purpose of payments  \n - For TH Instant payment transaction.category_purpose is not applicable \n - For US Instant payment transaction.category_purpose is not applicable \n - For IN IMPS transaction.category_purpose is not applicable \n - For UK FPS Instant payment transaction.category_purpose is not applicable \n - For IN UPI transaction.category_purpose is not applicable \n - For US Wire, transaction.category_purpose is not applicable \n - For US ACH CCD/PPD payment, transaction.category_purpose is not applicable \n - For US ACH IAT payment, transaction.category_purpose is not applicable \n - For US ACH IAT payment, transaction.category_purpose is not applicable \n- For SEPA IDP, transaction.category_purpose is optional with max length 35 \n - For Japan Instant payment transaction.category_purpose field is not applicable \n- For SEPA, transaction.category_purpose is optional with max length 35"
          title: category_purpose
        acceptance_date_time:
          type: string
          format: date-time
          description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) Acceptance date time is the time inputted by ordering bank \n - For TH Instant payment transaction.acceptance_date_time is not applicable \n - For US Instant payment transaction.acceptance_date_time is not applicable \n - For IN IMPS transaction.acceptance_date_time is not applicable \n - For UK FPS Instant payment transaction.acceptance_date_time is not applicable \n - For IN UPI transaction.acceptance_date_time is not applicable \n - For US Wire, transaction.acceptance_date_time is not applicable \n - For US ACH CCD/PPD payment, transaction.acceptance_date_time is not applicable \n - For US ACH IAT payment, transaction.acceptance_date_time is not applicable \n - For US ACH IAT payment, transaction.acceptance_date_time is not applicable \n- For SEPA IDP, transaction.acceptance_date_time is optional \n - For Japan Instant payment transaction.acceptance_date_time field is not applicable \n- For SEPA, transaction.acceptance_date_time is optional"
          title: acceptance_date_time
        payment_information_id:
          type: string
          maxLength: 35
          minLength: 1
          description: Payment Information ID for payment
          title: payment_information_id
        regulatory_reporting:
          $ref: '#/components/schemas/regulatory-reporting'
        structured_remittance_info:
          $ref: '#/components/schemas/structured-remittance-info'
        status:
          $ref: '#/components/schemas/Status'
        reasons:
          $ref: '#/components/schemas/Reasons'
        regulatory_reportings:
          type: array
          minItems: 0
          description: regulatory_reportings
          items:
            $ref: '#/components/schemas/regulatory-reportings'
          title: Regulatory_reportings
        tax_information:
          type: array
          minItems: 1
          maxItems: 3
          description: tax_information
          items:
            $ref: '#/components/schemas/tax-information'
          title: tax_information
        exchange:
          $ref: '#/components/schemas/Exchange'
    Ultimate-Debtor-Initiation:
      type: object
      title: UltimateDebtorInitiation
      properties:
        name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Ultimate Debtor's bank account name \n - For SEPA, ultimate_debtor.name is optional and allowed max length is 70 \n - For TH Instant payment ultimate_debtor.name is not applicable \n - For US Instant payment ultimate_debtor.name is optional \n - For IN IMPS ultimate_debtor.name is not applicable \n - For UK FPS Instant payment ultimate_debtor.name is optional with max length 40 \n - For IN UPI ultimate_debtor.name is not applicable \n - For US Wire, ultimate_debtor name is a conditional field with min 1 and max 35 characters. It become mandatory if Ultimate Remitter is being used for POBO. \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.name field is mandatory and allowed max length is 16 \n - For Japan Instant payment ultimate_debtor.name field is optional. It allows zengin characters ｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜｦﾝ , upper character alphabets A-Z, numeric characters 0 to 9 and special characters as follows . , () - \n - For TH NRBA Instant remittances payment ultimate_debtor.name is mandatory \n - For India FIR IMPS payment, ultimate_debtor.name is mandatory with max length 50"
          title: name
        scheme_name:
          maxLength: 128
          minLength: 1
          type: string
          description: "Ultimate debtor's scheme name \n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_debtor.scheme_name is not applicable \n - For SEPA, ultimate_debtor.scheme_name field is optional with max length as 35"
          title: scheme_name
        address_lines:
          type: array
          description: "Ultimate Debtor's address_lines \n - For SEPA, ultimate_debtor.address_lines field is optional with maximum of 2 lines allowed and upto 70 chars each line \n - For TH Instant payment ultimate_debtor.address_lines is not applicable \n - For US Instant payment ultimate_debtor.address_lines is optional \n - For IN IMPS ultimate_debtor.address_lines is not applicable \n - For UK FPS Instant payment ultimate_debtor.address_lines is optional with max 4 instances allowed and each line max length 35 \n - For IN UPI ultimate_debtor.address_lines is not applicable \n - For US Wire payment, ultimate_debtor.address_lines field is conditional and upto 3 lines of min 1 and max 35 characters are allowed. Partial addresses will not be accepted, Street name, city and country should present in address_line. It become mandatory if Ultimate Remitter is being used for POBO \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.address_lines is mandatory when structured address lines fields are not provided and allowed three instance with each line max length of 35, Address Line 1 should have Building info followed by asterik, Street Address ends with a single backslash \n Address Line 2 and then application to check  Address Line2 should have City followed by asterik, State ends with a single backslash Address Line 3 should have Zip Code followed by asterik, Country Code ends with a single backslash For example Zip code*US\\ \n - For Japan Instant payment ultimate_debtor.address_lines is optional with max 7 instances allowed and each line max length 70 \n - For India FIR IMPS payment ultimate_debtor.address_lines is optional"
          items:
            $ref: '#/components/schemas/Address'
          title: address_lines
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Ultimate Debtor's street_name \n - For SEPA, ultimate_debtor.street_name field is not applicable \n - For TH Instant payment ultimate_debtor.street_name is not applicable \n - For US Instant payment ultimate_debtor.street_name is optional \n - For IN IMPS ultimate_debtor.street_name is not applicable \n - For UK FPS Instant payment ultimate_debtor.street_name is optional with max length 70 \n - For IN UPI ultimate_debtor.street_name is not applicable \n - For US Wire ultimate_debtor.street_name is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.street_name is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 18 \n - For Japan Instant payment ultimate_debtor.street_name field is optional \n - For India FIR IMPS payment, ultimate_debtor.street_name field is mandatory with max length 35"
          title: street_name
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's bank identification \n - For TH , US, IN IMPS, UK FPS, IN UPI, US Wire, SEPA, US ACH CCD/PPD/IAT and JP payment ultimate_debtor.bank_id is not applicable \n - For India FIR IMPS payment, ultimate_debtor.bank_id field is mandatory with max length 11"
          title: bank_id
        building_number:
          maxLength: 16
          minLength: 1
          type: string
          description: "Ultimate Debtor's building_number \n - For SEPA, TH Instant payment ultimate_debtor.building_number is not applicable \n - For US Instant payment ultimate_debtor.building_number field is optional \n - For IN IMPS ultimate_debtor.building_number is not applicable \n - For UK FPS Instant payment ultimate_debtor.building_number is optional with max length 16 \n - For IN UPI ultimate_debtor.building_number is not applicable \n - For US Wire ultimate_debtor.building_number is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.building_number is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 16  \n - For Japan Instant payment ultimate_debtor.building_number field is optional \n - For India FIR IMPS payment, ultimate_debtor.building_number field is mandatory with max length 16"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Ultimate Debtor's postal_code \n - For SEPA, TH Instant payment ultimate_debtor.postal_code is not applicable \n - For US Instant payment ultimate_debtor.postal_code field is optional \n - For IN IMPS ultimate_debtor.postal_code is not applicable \n - For UK FPS Instant payment ultimate_debtor.postal_code is optional with max length 16 \n - For IN UPI ultimate_debtor.postal_code is not applicable \n - For US Wire ultimate_debtor.postal_code is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.postal_code is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 16 \n - For Japan Instant payment ultimate_debtor.postal_code field is optional \n - For India FIR IMPS payment, ultimate_debtor.postal_code field is mandatory"
          title: postal_code
        town_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's town name \n - For TH, SEPA, US, IN IMPS, UK FPS, IN UPI, US Wire, US ACH, JP payments ultimate_debtor.town_name is not applicable \n - For TH NRBA Instant remittances payment ultimate_debtor.town_name field is mandatory, if client provided ultimate_debtor.country field"
          title: town_name
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's city \n - For SEPA, TH Instant payment ultimate_debtor.city is not applicable \n - For US Instant payment ultimate_debtor.city field is optional \n - For IN IMPS ultimate_debtor.city is not applicable \n - For UK FPS Instant payment ultimate_debtor.city is optional with max length 35 \n - For IN UPI ultimate_debtor.city is not applicable \n - For US Wire ultimate_debtor.city is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.city is is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 32 \n - For Japan Instant payment ultimate_debtor.city field is optional \n - For India FIR IMPS payment, ultimate_debtor.city field is mandatory"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's state \n - For SEPA, TH Instant payment ultimate_debtor.state is not applicable \n - For US Instant payment ultimate_debtor.state field is optional \n - For IN IMPS ultimate_debtor.state is not applicable \n - For UK FPS Instant payment ultimate_debtor.state is optional with max length 35  \n - For IN UPI ultimate_debtor.state is not applicable \n - For US Wire ultimate_debtor.state is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.state is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 2  \n - For Japan Instant payment ultimate_debtor.state field is optional \n - For India FIR IMPS payment, ultimate_debtor.state field is optional"
          title: state
        country:
          type: string
          description: "Ultimate Debtor's country \n - For TH Instant payment ultimate_debtor.country is not applicable \n - For US Instant payment ultimate_debtor.country field is optional \n - For IN IMPS ultimate_debtor.country is not applicable \n - For UK FPS Instant payment ultimate_debtor.country is conditional and becomes mandatory if ultimate_debtor.name is provided \n - For IN UPI ultimate_debtor.country is not applicable \n - For US Wire ultimate_debtor.country is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.country is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 2 \n - For TH NRBA Instant remittances payment ultimate_debtor.country field is mandatory, if client provided ultimate_debtor.town_name field \n - For India FIR IMPS payment, ultimate_debtor.country field is mandatory \n - For SEPA payment, ultimate_debtor.country field is conditional and becomes mandatory if ultimate_debtor.name is provided"
          pattern: ^[A-Z]{2,2}$
          title: country
        org_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's org_id \n - For TH Instant payment ultimate_debtor.org_id is not applicable \n - For US Instant payment ultimate_debtor.org_id field is optional with max length 20.Pattern should be followed [A-Z0-9]{18,18}[0-9]{2,2} where first 18 characters can be uppercase or numbers and the last two characters must be numeric \n - For IN IMPS ultimate_debtor.org_id is not applicable \n - For UK FPS Instant payment ultimate_debtor.org_id is optional with max length 35 \n - For IN UPI ultimate_debtor.org_id is not applicable \n - For US Wire, ultimate_debtor.org_id is conditionally optional field with max length 34. It become mandatory if POBO is being used. It is present only if prvt_id is not present \n - For US ACH CCD/PPD payment, ultimate_debtor.org_id field is mandatory and applicable value is Organisation TXID or CUST Identification values and value should prefix with /TXID/ or /CUST/, if ultimate_debtor.prvt_id field is not provided by client and allowed value max length is 10 without prefix (/TXID/ or /CUST/) \n - For US ACH IAT payment, ultimate_debtor.org_id is mandatory if ultimate_debtor.prvt_id is not provided and allowed max length is 10 \n - For Japan Instant payment ultimate_debtor.org_id field is optional \n - For India FIR IMPS payment, ultimate_debtor.org_id field is mandatory \n - For SEPA, ultimate_debtor.org_id field is conditional optional with either ultimate_debtor.org_id or ultimate_debtor.prvt_id or combination of ultimate_debtor.brith_date/birth_city/birth_country should be populated"
          title: org_id
        birth_date:
          type: string
          format: date
          description: "ISO 8601 (YYYY-MM-DD), ultimate debtor's birth date \n - For TH Instant payment ultimate_debtor.birth_date is not applicable \n - For US Instant payment ultimate_debtor.birth_date field is optional \n - For IN IMPS ultimate_debtor.birth_date is not applicable \n - For UK FPS Instant payment ultimate_debtor.birth_date field is optional \n - For IN UPI ultimate_debtor.birth_date is not applicable \n - For US Wire ultimate_debtor.birth_date is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_date is not applicable \n - For Japan Instant payment ultimate_debtor.birth_date field is not applicable \n - For SEPA, ultimate_debtor.birth_date field is conditional mandatory with date on which the person is born"
          title: birth_date
        birth_city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate debtor's birth city \n - For TH Instant payment ultimate_debtor.birth_city is not applicable \n - For US Instant payment ultimate_debtor.birth_city field is optional \n - For IN IMPS ultimate_debtor.birth_city is not applicable \n - For UK FPS Instant payment ultimate_debtor.birth_city is optional with max length 35  \n - For IN UPI ultimate_debtor.birth_city is not applicable \n - For US Wire ultimate_debtor.birth_city is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_city is not applicable \n - For Japan Instant payment ultimate_debtor.birth_city field is not applicable \n - For SEPA, ultimate_debtor.birth_city field is conditional mandatory with city in which the person is born"
          title: birth_city
        birth_country:
          type: string
          description: "Ultimate debtor's birth country \n - For TH Instant payment ultimate_debtor.birth_country is not applicable \n - For US Instant payment ultimate_debtor.birth_country field is optional \n - For IN IMPS  ultimate_debtor.birth_country is not applicable \n - For UK FPS Instant payment ultimate_debtor.birth_country is optional with max length 2 \n - For IN UPI ultimate_debtor.birth_country is not applicable \n - For US Wire ultimate_debtor.birth_country is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_country is not applicable \n - For Japan Instant payment ultimate_debtor.birth_country field is not applicable \n - For SEPA, ultimate_debtor.birth_country field is conditional mandatory with country in which the person is born"
          pattern: ^[A-Z]{2,2}$
          title: birth_country
        birth_province:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor  Province Of Birth \n - For TH Instant payment ultimate_debtor.birth_province is not applicable \n - For US Instant payment ultimate_debtor.birth_province is not applicable \n - For IN IMPS ultimate_debtor.birth_province is not applicable \n - For UK FPS Instant payment ultimate_debtor.birth_province is not applicable \n - For IN UPI ultimate_debtor.birth_province is not applicable \n - For US Wire, ultimate_debtor.birth_province is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.birth_province is not applicable \n - For US ACH IAT payment, ultimate_debtor.birth_province is not applicable \n - For US ACH IAT payment, ultimate_debtor.birth_province is not applicable \n- For SEPA IDP, ultimate_debtor.birth_province is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.birth_province field is not applicable \n- For SEPA, ultimate_debtor.birth_province is optional with max length 35"
          title: birth_province
        prvt_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's private id \n - For TH Instant payment ultimate_debtor.prvt_id is not applicable \n - For US Instant payment ultimate_debtor.prvt_id field is optional with max length 35.Either org_id or prvt_id or none of them should be passed by client \n - For IN IMPS ultimate_debtor.prvt_id is not applicable \n - For UK FPS Instant payment ultimate_debtor.prvt_id is not applicable \n - For IN UPI ultimate_debtor.prvt_id is not applicable \n - For US Wire, ultimate_debtor.prvt_id is conditionally optional field with max length 34. It become mandatory if POBO is being used. It is present only if org_id is not present \n - For US ACH CCD/PPD payment, ultimate_debtor.prvt_id field is mandatory and applicable value is Organisation TXID or CUST Identification  values and value should prefix with /TXID/ or /CUST/, if ultimate_debtor.org_id field is not provided by client and allowed max length is 10 \n - For US ACH IAT payment, ultimate_debtor.prvt_id is mandatory if ultimate_debtor.org_id is not provided and allowed max length is 10 \n - For Japan Instant payment ultimate_debtor.prvt_id field is not applicable \n - For SEPA, ultimate_debtor.prvt_id field is conditional optional with either ultimate_debtor.org_id or ultimate_debtor.prvt_id or combination of ultimate_debtor.birth_date/birth_city/birth_country should be populated"
          title: prvt_id
        department:
          maxLength: 70
          minLength: 1
          type: string
          description: "ultimate debtor's Department \n - For TH Instant payment ultimate_debtor.department is not applicable \n - For US Instant payment ultimate_debtor.department is not applicable \n - For IN IMPS ultimate_debtor.department is not applicable \n - For UK FPS Instant payment ultimate_debtor.department is not applicable \n - For IN UPI ultimate_debtor.department is not applicable \n - For US Wire, ultimate_debtor.department is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.department is not applicable \n - For US ACH IAT payment, ultimate_debtor.department is not applicable \n - For US ACH IAT payment, ultimate_debtor.department is not applicable \n- For SEPA IDP, ultimate_debtor.department is optional with max length 70 \n - For Japan Instant payment ultimate_debtor.department field is not applicable \n- For SEPA, ultimate_debtor.department is optional with max length 70"
          title: department
        sub_department:
          maxLength: 70
          minLength: 1
          type: string
          description: "ultimate debtor's Sub-Department \n - For TH Instant payment ultimate_debtor.sub_department is not applicable \n - For US Instant payment ultimate_debtor.sub_department is not applicable \n - For IN IMPS ultimate_debtor.sub_department is not applicable \n - For UK FPS Instant payment ultimate_debtor.sub_department is not applicable \n - For IN UPI ultimate_debtor.sub_department is not applicable \n - For US Wire, ultimate_debtor.sub_department is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.sub_department is not applicable \n - For US ACH IAT payment, ultimate_debtor.sub_department is not applicable \n - For US ACH IAT payment, ultimate_debtor.sub_department is not applicable \n- For SEPA IDP, ultimate_debtor.sub_department is optional with max length 70 \n - For Japan Instant payment ultimate_debtor.sub_department field is not applicable \n- For SEPA, ultimate_debtor.sub_department is optional with max length 70"
          title: sub_department
        building_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "ultimate debtor's building name \n - For TH Instant payment ultimate_debtor.building_name is not applicable \n - For US Instant payment ultimate_debtor.building_name is not applicable \n - For IN IMPS ultimate_debtor.building_name is not applicable \n - For UK FPS Instant payment ultimate_debtor.building_name is not applicable \n - For IN UPI ultimate_debtor.building_name is not applicable \n - For US Wire, ultimate_debtor.building_name is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.building_name is not applicable \n - For US ACH IAT payment, ultimate_debtor.building_name is not applicable \n - For US ACH IAT payment, ultimate_debtor.building_name is not applicable \n- For SEPA IDP, ultimate_debtor.building_name is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.building_name field is not applicable \n- For SEPA, ultimate_debtor.building_name is optional with max length 35"
          title: building_name
        floor:
          maxLength: 70
          minLength: 1
          type: string
          description: "ultimate debtor's address floor \n - For TH Instant payment ultimate_debtor.floor is not applicable \n - For US Instant payment ultimate_debtor.floor is not applicable \n - For IN IMPS ultimate_debtor.floor is not applicable \n - For UK FPS Instant payment ultimate_debtor.floor is not applicable \n - For IN UPI ultimate_debtor.floor is not applicable \n - For US Wire, ultimate_debtor.floor is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.floor is not applicable \n - For US ACH IAT payment, ultimate_debtor.floor is not applicable \n - For US ACH IAT payment, ultimate_debtor.floor is not applicable \n- For SEPA IDP, ultimate_debtor.floor is optional with max length 70 \n - For Japan Instant payment ultimate_debtor.floor field is not applicable \n- For SEPA, ultimate_debtor.floor is optional with max length 70"
          title: floor
        post_box:
          maxLength: 16
          minLength: 1
          type: string
          description: "ultimate debtor's address post box \n - For TH Instant payment ultimate_debtor.post_box is not applicable \n - For US Instant payment ultimate_debtor.post_box is not applicable \n - For IN IMPS ultimate_debtor.post_box is not applicable \n - For UK FPS Instant payment ultimate_debtor.post_box is not applicable \n - For IN UPI ultimate_debtor.post_box is not applicable \n - For US Wire, ultimate_debtor.post_box is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.post_box is not applicable \n - For US ACH IAT payment, ultimate_debtor.post_box is not applicable \n - For US ACH IAT payment, ultimate_debtor.post_box is not applicable \n- For SEPA IDP, ultimate_debtor.post_box is optional with max length 16 \n - For Japan Instant payment ultimate_debtor.post_box field is not applicable \n- For SEPA, ultimate_debtor.post_box is optional with max length 16"
          title: post_box
        room:
          maxLength: 70
          minLength: 1
          type: string
          description: "ultimate debtor's address room \n - For TH Instant payment ultimate_debtor.room is not applicable \n - For US Instant payment ultimate_debtor.room is not applicable \n - For IN IMPS ultimate_debtor.room is not applicable \n - For UK FPS Instant payment ultimate_debtor.room is not applicable \n - For IN UPI ultimate_debtor.room is not applicable \n - For US Wire, ultimate_debtor.room is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.room is not applicable \n - For US ACH IAT payment, ultimate_debtor.room is not applicable \n - For US ACH IAT payment, ultimate_debtor.room is not applicable \n- For SEPA IDP, ultimate_debtor.room is optional with max length 70 \n - For Japan Instant payment ultimate_debtor.room field is not applicable \n- For SEPA, ultimate_debtor.room is optional with max length 70"
          title: room
        town_location_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "ultimate_debtor address town location name \n - For TH Instant payment ultimate_debtor.town_location_name is not applicable \n - For US Instant payment ultimate_debtor.town_location_name is not applicable \n - For IN IMPS ultimate_debtor.town_location_name is not applicable \n - For UK FPS Instant payment ultimate_debtor.town_location_name is not applicable \n - For IN UPI ultimate_debtor.town_location_name is not applicable \n - For US Wire, ultimate_debtor.town_location_name is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.town_location_name is not applicable \n - For US ACH IAT payment, ultimate_debtor.town_location_name is not applicable \n - For US ACH IAT payment, ultimate_debtor.town_location_name is not applicable \n- For SEPA IDP, ultimate_debtor.town_location_name is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.town_location_name field is not applicable \n- For SEPA, ultimate_debtor.town_location_name is optional with max length 35"
          title: town_location_name
        district_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "ultimate debtor's address district_name \n - For TH Instant payment ultimate_debtor.district_name is not applicable \n - For US Instant payment ultimate_debtor.district_name is not applicable \n - For IN IMPS ultimate_debtor.district_name is not applicable \n - For UK FPS Instant payment ultimate_debtor.district_name is not applicable \n - For IN UPI ultimate_debtor.district_name is not applicable \n - For US Wire, ultimate_debtor.district_name is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.district_name is not applicable \n - For US ACH IAT payment, ultimate_debtor.district_name is not applicable \n - For US ACH IAT payment, ultimate_debtor.district_name is not applicable \n- For SEPA IDP, ultimate_debtor.district_name is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.district_name field is not applicable \n- For SEPA, ultimate_debtor.district_name is optional with max length 35"
          title: district_name
        anybic:
          maxLength: 35
          minLength: 1
          type: string
          description: "ultimate debtor's BIC \n - For TH Instant payment ultimate_debtor.anybic is not applicable \n - For US Instant payment ultimate_debtor.anybic is not applicable \n - For IN IMPS ultimate_debtor.anybic is not applicable \n - For UK FPS Instant payment ultimate_debtor.anybic is not applicable \n - For IN UPI ultimate_debtor.anybic is not applicable \n - For US Wire, ultimate_debtor.anybic is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.anybic is not applicable \n - For US ACH IAT payment, ultimate_debtor.anybic is not applicable \n - For US ACH IAT payment, ultimate_debtor.anybic is not applicable \n- For SEPA IDP, ultimate_debtor.anybic is optional with max length 11 \n - For Japan Instant payment ultimate_debtor.anybic field is not applicable \n- For SEPA, ultimate_debtor.anybic is optional with max length 11"
          title: anybic
        lei:
          maxLength: 35
          minLength: 1
          type: string
          description: "Unique global identifier for legal entities participating in financial transactions \n - For TH Instant payment ultimate_debtor.lei is not applicable \n - For US Instant payment ultimate_debtor.lei is not applicable \n - For IN IMPS ultimate_debtor.lei is not applicable \n - For UK FPS Instant payment ultimate_debtor.lei is not applicable \n - For IN UPI ultimate_debtor.lei is not applicable \n - For US Wire, ultimate_debtor.lei is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.lei is not applicable \n - For US ACH IAT payment, ultimate_debtor.lei is not applicable \n - For US ACH IAT payment, ultimate_debtor.lei is not applicable \n- For SEPA IDP, ultimate_debtor.lei is optional with max length 20 \n - For Japan Instant payment ultimate_debtor.lei field is not applicable \n- For SEPA, ultimate_debtor.lei is optional with max length 20"
          title: lei
        issuer:
          maxLength: 35
          minLength: 1
          type: string
          description: "ultimate debtor's name that identifies an issuer \n - For TH Instant payment ultimate_debtor.issuer is not applicable \n - For US Instant payment ultimate_debtor.issuer is not applicable \n - For IN IMPS ultimate_debtor.issuer is not applicable \n - For UK FPS Instant payment ultimate_debtor.issuer is not applicable \n - For IN UPI ultimate_debtor.issuer is not applicable \n - For US Wire, ultimate_debtor.issuer is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.issuer is not applicable \n - For US ACH IAT payment, ultimate_debtor.issuer is not applicable \n - For US ACH IAT payment, ultimate_debtor.issuer is not applicable \n- For SEPA IDP, ultimate_debtor.issuer is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.issuer field is not applicable \n- For SEPA, ultimate_debtor.issuer is optional with max length 35"
          title: issuer
      additionalProperties: false
      description: Ultimate Debtor information
    Account-Validation-Status:
      type: object
      title: AccountValidationStatus
      properties:
        uetr:
          type: string
          pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
          description: UUID v4 format unique end-to-end transaction reference
          title: uetr
        status:
          type: object
          title: status
          properties:
            date_time:
              type: string
              format: date-time
              description: "UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Date time of transaction status"
              title: date_time
            code:
              type: string
              description: ISO 20022 acknowledegment status code
              enum:
              - ACCC
              - RJCT
              title: code
            description:
              type: string
              description: "Status code description \n- ACCC - Completed \n- RJCT - Rejected"
              title: description
        reasons:
          type: object
          title: reasons
          properties:
            code:
              type: string
              description: Reason code
              maxLength: 4
              title: code
            description:
              type: string
              description: Reason code description
              minLength: 1
              maxLength: 105
              title: description
        account:
          type: object
          title: account
          properties:
            number_validation:
              type: string
              description: "Account validation result \n - For SEPA VoP,this field is optional  \n- MATCH - Validation based on account is a match \n - MISMATCH - Validation based on account is a mismatch \n- NA - Account match did not happen"
              enum:
              - MATCH
              - MISMATCH
              - NA
              title: number_validation
            name_validation:
              type: string
              description: "Name validation result \n - For SEPA VoP,this field is optional  \n- MATCH - Validation based on name is a match \n - MISMATCH - Validation based on name is a mismatch \n - PARTIALMATCH - Validation based on name is a partial match \n- NOTCHECKED - Validation not checked \n- NA - Name match did not happen"
              enum:
              - MATCH
              - MISMATCH
              - PARTIALMATCH
              - NA
              title: name_validation
        unstructured_remittance_info:
          type: array
          description: "Unstructured remitance information  \n - For SEPA VoP this field is optional - Maximum length is 140 and single instance is allowed"
          items:
            $ref: '#/components/schemas/Unstructured'
          title: unstructured_remittance_info
    Instructing-Agent-Initiation:
      type: object
      title: InstructingAgent
      properties:
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Instructing Agent/Debtor Agent member Identification ID or BIC of a clearing system. \n - For TH Instant payment instructing_agent.bank_id field is not applicable \n - For US Instant payment instructing_agent.bank_id field is not applicable \n - For IN IMPS Instant payment instructing_agent.bank_id field is not applicable  \n - For UK FPS Instant payment instructing_agent.bank_id field is not applicable \n - For IN UPI Instant payment instructing_agent.bank_id field is not applicable \n - For US Wire, instructing_agent.bank_id is not applicable \n - For US ACH CCD/PPD payment, instructing_agent.bank_id is not applicable \n - For US ACH IAT payment, instructing_agent.bank_id is not applicable \n - For SEPA IDP instructing_agent.bank_id field is not applicable \n - For Japan Instant payment instructing_agent.bank_id field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.bank_id field is optional and allowed max length is 11"
          title: bank_id
        bank_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Instructing Agent name. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT and JP payment instructing_agent.bank_name field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.bank_name field is mandatory, if client provided instructing_agent.bank_id and allowed max length is 100"
          title: bank_name
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Instructing Agent street name. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT and JP payment instructing_agent.street_name field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.street_name field is mandatory, if client provided instructing_agent.bank_id and allowed max length is 35"
          title: street_name
        building_number:
          maxLength: 35
          minLength: 1
          type: string
          description: "Instructing Agent building number. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT and JP payment instructing_agent.building_number field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.building_number field is mandatory, if client provided instructing_agent.bank_id and allowed max length is 16"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Instructing Agent postal code. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT and JP payment instructing_agent.postal_code field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.postal_code field is mandatory, if client provided instructing_agent.bank_id"
          title: postal_code
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Instructing Agent city. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT and JP payment instructing_agent.city field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.city field is mandatory, if client provided instructing_agent.bank_id"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Instructing Agent state. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT and JP payment instructing_agent.state field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.state field is mandatory, if client provided instructing_agent.bank_id"
          title: state
        country:
          type: string
          description: "Instructing Agent country \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT and JP payment instructing_agent.country field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.country field is mandatory, if client provided instructing_agent.bank_id"
          pattern: ^[A-Z]{2,2}$
          title: country
    regulatory-reportings:
      type: object
      title: RegulatoryReportings
      properties:
        code:
          maxLength: 35
          minLength: 1
          type: string
          description: Regulatory Reporting details code
          title: code
        info:
          maxLength: 35
          minLength: 1
          type: string
          description: Regulatory Reporting details information
          title: info
    regulatory-reporting:
      type: object
      title: RegulatoryReporting
      properties:
        type:
          maxLength: 35
          minLength: 1
          type: string
          description: "Regulatory Reporting details type \n - For TH Instant payment transaction.regulatory_reporting.type  is not applicable \n - For US Instant payment transaction.regulatory_reporting.type  field is not applicable \n - For IN IMPS transaction.regulatory_reporting.type  is not applicable \n - For UK FPS Instant payment transaction.regulatory_reporting.type  is not applicable \n - For JP Instant payment transaction.regulatory_reporting.type  is not applicable \n - For IN UPI transaction.regulatory_reporting.type  is not applicable \n - For US WIRE,transaction.regulatory_reporting.type  field is not applicable \n - For US ACH CCD/PPD/IAT payment,transaction.regulatory_reporting.type  field is not applicable \n - For SEPA IDP transaction.regulatory_reporting.type  field is optional with max length 35 \n - For Japan Instant payment transaction.regulatory_reporting.type field is not applicable \n - For SEPA, transaction.regulatory_reporting.type field is optional and allowed maxLength is 35"
          title: type
        code:
          maxLength: 35
          minLength: 1
          type: string
          description: "Regulatory Reporting details code \n - For TH Instant payment transaction.regulatory_reporting.code  is not applicable \n - For US Instant payment transaction.regulatory_reporting.code  field is not applicable \n - For IN IMPS transaction.regulatory_reporting.code  is not applicable \n - For UK FPS Instant payment transaction.regulatory_reporting.code  is not applicable \n - For JP Instant payment transaction.regulatory_reporting.code  is not applicable \n - For IN UPI transaction.regulatory_reporting.code  is not applicable \n - For US WIRE,transaction.regulatory_reporting.code  field is not applicable \n - For US ACH CCD/PPD/IAT payment,transaction.regulatory_reporting.code  field is not applicable \n - For SEPA IDP transaction.regulatory_reporting.code  field is optional with max length 10 \n - For Japan Instant payment transaction.regulatory_reporting.code field is not applicable \n - For SEPA, transaction.regulatory_reporting.code field is optional and allowed maxLength is 35"
          title: code
    Original-Payment:
      type: object
      title: OriginalPayment
      description: Either populate uetr OR (end_to_end_id AND value_date) for the refund to be processed
      properties:
        end_to_end_id:
          $ref: '#/components/schemas/Restricted-Finx-Max-Text'
        uetr:
          type: string
          pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$
          description: UUID v4 format unique end-to-end transaction reference
          title: uetr
        value_date:
          type: string
          format: date
          description: Format YYYY-MM-DD Date in local time zone (e.g., EST for a United States RTP network transaction) when Citi's transaction processing application starts processing a transaction
          title: value_date
        instructed_amount:
          type: number
          readOnly: true
          minimum: 0.01
          maximum: 1000000000000000
          description: "Instructed amount \n - Thailand PromptPay - Maximum amount is 2000000.00 \n - United States - Maximum amount is 1000000.00 \n - SEPA - Maximum amount is 1000000.00"
          title: instructed_amount
        instructed_currency:
          description: ISO 4217 code for the transaction instructed amount currency
          type: string
          readOnly: true
          enum:
          - THB
          - USD
          - BRL
          - EUR
          - JPY
          title: instructed_currency
    Payments:
      type: object
      title: Payments
      required:
      - debtor
      - creditor
      - method
      - transaction
      properties:
        message_id:
          type: string
          description: "Message Identification \n- If transaction.status.code = ACCC/PDNG/RJCT/ACWP then this field may be present"
          maxLength: 35
          title: message_id
        debtor:
          $ref: '#/components/schemas/Debtor-Status'
        ultimate_debtor:
          $ref: '#/components/schemas/Ultimate-Debtor-Status'
        creditor:
          $ref: '#/components/schemas/Creditor-Status'
        ultimate_creditor:
          $ref: '#/components/schemas/Ultimate-Creditor-Status'
        intermediary:
          $ref: '#/components/schemas/Intermediary-Status'
        instructed_agent:
          $ref: '#/components/schemas/Instructed-Agent-Status'
        instructing_agent:
          $ref: '#/components/schemas/Instructing-Agent-Status'
        method:
          $ref: '#/components/schemas/Method-Status'
        transaction:
          $ref: '#/components/schemas/Transaction-Status'
        account_validation:
          $ref: '#/components/schemas/Account-Validation-Status'
        initiating_party:
          $ref: '#/components/schemas/Initiating-Party-Status'
        original_payment:
          $ref: '#/components/schemas/Original-Payment'
      description: Payment status notification / inquiry response
    Ultimate-Creditor-Status:
      type: object
      title: UltimateCreditorStatus
      properties:
        name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Ultimate Creditor's bank account name \n - For TH Instant payment ultimate_creditor.name is not applicable \n - For US Instant payment ultimate_creditor.name is optional \n - For IN IMPS ultimate_creditor.name is not applicable \n - For UK FPS Instant payment ultimate_creditor.name field is optional with max length 140 \n - For IN UPI ultimate_creditor.name is not applicable \n - US Wire, ultimate_creditor.name is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.name field is mandatory and allowed max length is 22 \n - For US ACH IAT payment, ultimate_creditor.name field is mandatory and allowed max length is 35 \n-  For SEPA IDP ultimate_creditor.name is optional \n - For Japan Instant payment ultimate_creditor.name field is not applicable \n-  For SEPA, ultimate_creditor.name is optional and maxLength is 70"
          title: name
        address_lines:
          type: array
          description: "Ultimate Creditor's address_lines \n - For TH Instant payment ultimate_creditor.address_lines is not applicable \n - For US Instant payment ultimate_creditor.address_lines is optional \n - For IN IMPS ultimate_creditor.address_lines is not applicable \n - For UK FPS Instant payment ultimate_creditor.address_lines field is optional \n - For IN UPI ultimate_creditor.address_lines is not applicable \n - For US Wire, ultimate_creditor.address_lines is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.address_lines field is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment ultimate_creditor.address_lines field is not applicable \n- For SEPA, this field is not applicable"
          items:
            $ref: '#/components/schemas/Address'
          title: address_lines
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Ultimate Creditor's street_name \n - For TH Instant payment ultimate_creditor.street_name is not applicable \n - For US Instant payment ultimate_creditor.street_name is optional \n - For IN IMPS ultimate_creditor.street_name is not applicable \n - For UK FPS Instant payment ultimate_creditor.street_name field is optional with max length 70 \n - For IN UPI ultimate_creditor.street_name is not applicable \n - For US Wire, ultimate_creditor.street_name is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.street_name field is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment ultimate_creditor.street_name field is not applicable \n- For SEPA, this field is not applicable"
          title: street_name
        building_number:
          maxLength: 16
          minLength: 1
          type: string
          description: "Ultimate Creditor's building_number \n - For TH Instant payment ultimate_creditor.building_number is not applicable \n - For US Instant payment ultimate_creditor.building_number field is optional \n - For IN IMPS ultimate_creditor.building_number is not applicable \n - For UK FPS Instant payment ultimate_creditor.building_number field is optional with max length 16 \n - For IN UPI ultimate_creditor.building_number is not applicable \n - For US Wire, ultimate_creditor.building_number is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.building_number field is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment ultimate_creditor.building_number field is not applicable \n- For SEPA, this field is not applicable"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Ultimate Creditor's postal_code \n - For TH Instant payment ultimate_creditor.postal_code is not applicable \n - For US Instant payment ultimate_creditor.postal_code field is optional \n - For IN IMPS ultimate_creditor.postal_code is not applicable \n - For UK FPS Instant payment ultimate_creditor.postal_code field is optional with max length 16 \n - For IN UPI ultimate_creditor.postal_code is not applicable \n - For US Wire, ultimate_creditor.postal_code is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.postal_code field is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment ultimate_creditor.postal_code field is not applicable \n- For SEPA, this field is not applicable"
          title: postal_code
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Creditor's city \n - For TH Instant payment ultimate_creditor.city is not applicable \n - For US Instant payment ultimate_creditor.city field is optional \n - For IN IMPS ultimate_creditor.city is not applicable \n - For UK FPS Instant payment ultimate_creditor.city field is optional with max length 35 \n - For IN UPI ultimate_creditor.city is not applicable \n - For US Wire, ultimate_creditor.city is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.city field is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment ultimate_creditor.city field is not applicable \n- For SEPA, this field is not applicable"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Creditor's state \n - For TH Instant payment ultimate_creditor.state is not applicable \n - For US Instant payment ultimate_creditor.state field is optional \n - For IN IMPS ultimate_creditor.state is not applicable  \n - For UK FPS Instant payment ultimate_creditor.state field is optional with max length 35 \n - For IN UPI ultimate_creditor.state is not applicable \n - For US Wire, ultimate_creditor.state is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.state field is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment ultimate_creditor.state field is not applicable \n- For SEPA, this field is not applicable"
          title: state
        country:
          type: string
          description: "Ultimate Creditor's country \n - For TH Instant payment ultimate_creditor.country is not applicable \n - For US Instant payment ultimate_creditor.country field is optional \n - For IN IMPS ultimate_creditor.country is not applicable \n - For UK FPS Instant payment ultimate_creditor.country field is optional\n - For IN UPI ultimate_creditor.country is not applicable \n - For US Wire, ultimate_creditor.country is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.country field is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment ultimate_creditor.country field is not applicable \n- For SEPA, this field is not applicable"
          pattern: ^[A-Z]{2,2}$
          title: country
        org_id:
          maxLength: 35
          minLength: 1
          type: string
          description: " Ultimate Creditor's org_id \n - For TH Instant payment ultimate_creditor.org_id is not applicable \n - For US Instant payment ultimate_creditor.org_id field is optional with max length 20.Pattern should be followed [A-Z0-9]{18,18}[0-9]{2,2} where first 18 characters can be uppercase or numbers and the last two characters must be numeric \n - For IN IMPS ultimate_creditor.org_id is not applicable \n - For UK FPS Instant payment ultimate_creditor.org_id field is optional with max length 35 \n - For IN UPI ultimate_creditor.org_id is not applicable \n - US Wire, ultimate_creditor.org_id is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.org_id field is not applicable \n - For SEPA IDP ultimate_creditor.org_id field is optional with max length 35 \n - For Japan Instant payment ultimate_creditor.org_id field is not applicable \n - For SEPA, ultimate_creditor.org_id field is optional with max length 35"
          title: org_id
        prvt_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Creditor's private id \n - For TH Instant payment ultimate_creditor.prvt_id is not applicable \n - For US Instant payment ultimate_creditor.prvt_id field is optional with max length 35.Either org_id or prvt_id or none of them should be passed by client \n - For IN IMPS ultimate_creditor.prvt_id is not applicable \n - For UK FPS Instant payment ultimate_creditor.prvt_id is not applicable \n - For IN UPI ultimate_creditor.prvt_id is not applicable \n - US Wire, ultimate_creditor.prvt_id is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.prvt_id field is not applicable \n - For SEPA IDP ultimate_creditor.prvt_id field is optional with max length 35 \n - For Japan Instant payment ultimate_creditor.prvt_id field is not applicable \n - For SEPA, ultimate_creditor.prvt_id field is optional with max length 35"
          title: prvt_id
        birth_date:
          type: string
          format: date
          description: "ISO 8601 (YYYY-MM-DD), ultimate creditor's birth date \n - For TH Instant payment ultimate_creditor.birth_date is not applicable \n - For US Instant payment ultimate_creditor.birth_date field is not applicable \n - For IN IMPS ultimate_creditor.birth_date is not applicable \n - For UK FPS Instant payment ultimate_creditor.birth_date field is not applicable \n - For IN UPI ultimate_creditor.birth_date is not applicable \n - For US Wire ultimate_creditor.birth_date is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.birth_date is not applicable \n - For SEPA IDP ultimate_creditor.birth_date field is optional \n - For Japan Instant payment ultimate_creditor.birth_date field is not applicable \n - For SEPA, ultimate_creditor.birth_date field is optional"
          title: birth_date
        birth_city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate creditor's birth city \n - For TH Instant payment ultimate_creditor.birth_city is not applicable \n - For US Instant payment ultimate_creditor.birth_city field is not applicable \n - For IN IMPS ultimate_creditor.birth_city is not applicable \n - For UK FPS Instant payment ultimate_creditor.birth_city is not applicable  \n - For IN UPI ultimate_creditor.birth_city is not applicable \n - For US Wire ultimate_creditor.birth_city is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.birth_city is not applicable \n - For SEPA IDP ultimate_creditor.birth_city is optional with max length 35 \n - For Japan Instant payment ultimate_creditor.birth_city field is not applicable \n - For SEPA, ultimate_creditor.birth_city is optional with max length 35"
          title: birth_city
        birth_country:
          type: string
          description: "Ultimate creditor's birth country \n - For TH Instant payment ultimate_creditor.birth_country is not applicable \n - For US Instant payment ultimate_creditor.birth_country field is not applicable \n - For IN IMPS  ultimate_creditor.birth_country is not applicable \n - For UK FPS Instant payment ultimate_creditor.birth_country is not applicable \n - For IN UPI ultimate_creditor.birth_country is not applicable \n - For US Wire ultimate_creditor.birth_country is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.birth_country is not applicable \n - For SEPA IDP ultimate_creditor.birth_country field is optional \n - For Japan Instant payment ultimate_creditor.birth_country field is not applicable \n - For SEPA, ultimate_creditor.birth_country field is optional and allowed maxLength is 2"
          pattern: ^[A-Z]{2,2}$
          title: birth_country
        anybic:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate creditor BIC \n - For TH Instant payment ultimate_creditor.anybic is not applicable \n - For US Instant payment ultimate_creditor.anybic is not applicable \n - For IN IMPS ultimate_creditor.anybic is not applicable \n - For UK FPS Instant payment ultimate_creditor.anybic is not applicable \n - For IN UPI ultimate_creditor.anybic is not applicable \n - For US Wire, ultimate_creditor.anybic is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.anybic is not applicable \n - For US ACH IAT payment, ultimate_creditor.anybic is not applicable \n - For US ACH IAT payment, ultimate_creditor.anybic is not applicable \n- For SEPA IDP, ultimate_creditor.anybic is optional with max length 11 \n - For Japan Instant payment ultimate_creditor.anybic field is not applicable \n- For SEPA, ultimate_creditor.anybic is optional with max length 11"
          title: anybic
        lei:
          maxLength: 35
          minLength: 1
          type: string
          description: "LEI of Organization ID for Ultimate creditor \n - For TH Instant payment ultimate_creditor.lei is not applicable \n - For US Instant payment ultimate_creditor.lei is not applicable \n - For IN IMPS ultimate_creditor.lei is not applicable \n - For UK FPS Instant payment ultimate_creditor.lei is not applicable \n - For IN UPI ultimate_creditor.lei is not applicable \n - For US Wire, ultimate_creditor.lei is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.lei is not applicable \n - For US ACH IAT payment, ultimate_creditor.lei is not applicable \n - For US ACH IAT payment, ultimate_creditor.lei is not applicable \n- For SEPA IDP, ultimate_creditor.lei is optional with max length 20 \n - For Japan Instant payment ultimate_creditor.lei field is not applicable \n- For SEPA, ultimate_creditor.lei is optional with max length 20"
          title: lei
        issuer:
          maxLength: 35
          minLength: 1
          type: string
          description: " Ultimate creditor name that identifies an issuer \n - For TH Instant payment ultimate_creditor.issuer is not applicable \n - For US Instant payment ultimate_creditor.issuer is not applicable \n - For IN IMPS ultimate_creditor.issuer is not applicable \n - For UK FPS Instant payment ultimate_creditor.issuer is not applicable \n - For IN UPI ultimate_creditor.issuer is not applicable \n - For US Wire, ultimate_creditor.issuer is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.issuer is not applicable \n - For US ACH IAT payment, ultimate_creditor.issuer is not applicable \n - For US ACH IAT payment, ultimate_creditor.issuer is not applicable \n- For SEPA IDP, ultimate_creditor.issuer is optional with max length 35 \n - For Japan Instant payment ultimate_creditor.issuer field is not applicable \n- For SEPA, ultimate_creditor.issuer is optional with max length 35"
          title: issuer
        birth_province:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate creditor Province Of Birth \n - For TH Instant payment ultimate_creditor.birth_province is not applicable \n - For US Instant payment ultimate_creditor.birth_province is not applicable \n - For IN IMPS ultimate_creditor.birth_province is not applicable \n - For UK FPS Instant payment ultimate_creditor.birth_province is not applicable \n - For IN UPI ultimate_creditor.birth_province is not applicable \n - For US Wire, ultimate_creditor.birth_province is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.birth_province is not applicable \n - For US ACH IAT payment, ultimate_creditor.birth_province is not applicable \n - For US ACH IAT payment, ultimate_creditor.birth_province is not applicable \n- For SEPA IDP, ultimate_creditor.birth_province is optional with max length 35 \n - For Japan Instant payment ultimate_creditor.birth_province field is not applicable \n- For SEPA, ultimate_creditor.birth_province is optional with max length 35"
          title: birth_province
        scheme_name:
          maxLength: 128
          minLength: 1
          type: string
          description: Ultimate creditor's scheme name
          title: scheme_name
    Unstructured:
      type: string
      maxLength: 140
      minLength: 1
      description: Unstructured remitance information
      title: Unstructured
    Creditor-Initiation:
      type: object
      title: CreditorInitiation
      properties:
        proxy_id:
          maxLength: 255
          minLength: 1
          type: string
          description: "Creditor's proxy identification (e.g., email address) \n- Thailand PromptPay - If you don't provide account, proxy_id is required. \n - For US Instant payment creditor.proxy_id field is not applicable \n - For IN IMPS creditor.proxy_id field is not applicable \n - For UK FPS Instant payment creditor.proxy_id field is not applicable \n - For IN UPI Instant payment creditor.proxy_id is mandatory and applicable value VPA ID, if creditor.account and creditor.bank_id is not provided by client \n - For US Wire, creditor.proxy_id field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.proxy_id is not applicable \n - For Japan Instant payment creditor.proxy_id field is not applicable \n - For SEPA, creditor.proxy_id is optional"
          title: proxy_id
        proxy_type:
          type: string
          enum:
          - BIID
          - EMAL
          - EWAL
          - MBNO
          - NIDN
          - COTS
          - IBAN
          - PAYR
          - SVID
          description: "Creditor's proxy type (BIID for bill identification, EMAL for email address, EWAL for electronic wallet identification, MBNO for mobile number, NIDN for national identification, COTS for tax identification, IBAN for internetational bank account number and PAYR for payer identification) \n- Thailand PromptPay - if you provide proxy_id, proxy_type is required.If creditor proxy_type is 'BIID', require client to mandatorily provide 'bill_id_1' value. \n - For US Instant payment creditor.proxy_type field is not applicable \n - For IN IMPS creditor.proxy_type field is not applicable \n - For UK FPS Instant payment creditor.proxy_type field is not applicable \n - For IN UPI creditor.proxy_type field is not applicable \n - For US Wire, creditor.proxy_type field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.proxy_type is not applicable \n - For Japan Instant payment creditor.proxy_type field is not applicable \n - For SEPA, creditor.proxy_type is optional and allowed max length is 35"
          title: proxy_type
        tax_id:
          maxLength: 128
          minLength: 1
          type: string
          description: Creditor's tax identification
          title: tax_id
        account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Creditor's bank account \n- Thailand PromptPay - If you don't provide proxy_id, account and bank_id is required \n - For US Instant payment creditor.account field is mandatory \n - For IN IMPS creditor.account field is mandatory with max length 34 \n - For UK FPS Instant payment creditor.account field is mandatory and allowed max length is 34, Client can pass either account number or IBAN/BBAN number \n - For IN UPI creditor.account field is mandatory with max length 34, if creditor.proxy_id is not provided by client \n - For US Wire, creditor.account is a mandatory field with max length is 34 and allowed value is Virtual account number. \n - For US ACH CCD/PPD/IAT payment, creditor.account is a mandatory field with max length is 34 and allowed value is Virtual account number. \n - For Japan Instant payment creditor.proxy_type field is mandatory and allowed max length is 7 \n - For SEPA, creditor.account is mandatory and allowed max length is 34"
          title: account
        name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Creditor's name \n- Thailand PromptPay - Maximum length is 50. \n- For US Instant payment creditor.name is manadtory - Maximum length is 140 \n- For IN IMPS  creditor.name is mandatory - Maximum length is 50 \n- For UK FPS Instant payment creditor.name field is mandatory - Maximum length is 40 \n- For IN UPI creditor.name is mandatory - Maximum length is 99 \n - For US Wire, creditor.name is a mandatory field with max length 35 \n - For US ACH CCD/PPD payment, creditor.name is a mandatory field with max length is 22 \n - For US ACH IAT payment, creditor.name is a mandatory field with max length is 35 \n - For Japan Instant payment creditor.name field is mandatory. It allows zengin characters ｱｲｳｴｵｶｷｸｹｺｻｼｽｾｿﾀﾁﾂﾃﾄﾅﾆﾇﾈﾉﾊﾋﾌﾍﾎﾏﾐﾑﾒﾓﾔﾕﾖﾗﾘﾙﾚﾛﾜｦﾝ , upper character alphabets A-Z, numeric characters 0 to 9 and special characters as follows . , () - \n - For SEPA, creditor.name is mandatory and allowed max length is 70"
          title: name
        address_lines:
          type: array
          description: "Creditor's address_lines \n - For TH Instant payment creditor.address_lines is not applicable \n - For US Instant payment creditor.address_lines is optional \n - For IN IMPS creditor.address_lines field is optional and allowed  seven instance with each line max length of 70 \n - For UK FPS Instant payment creditor.address_lines field is optional and allowed only four instance with each line max length of 35 \n - For IN UPI creditor.address_lines field is optional and allowed  seven instance with each line max length of 70 \n - For US Wire payment, creditor.address_lines field is conditional and upto 3 lines of min 1 and max 35 characters are allowed. Partial addresses will not be accepted, Street name, city and country should present in address_line. address_lines should present only if structured address tags (street name, building number, city, state and postal code) are not present \n - For US ACH CCD/PPD/IAT payment, creditor.address_lines is mandatory when structured address lines fields are not provided and allowed three instance with each line max length of 35, Address Line 1 should have Building info followed by asterik, Street Address ends with a single backslash \n Address Line 2 and then application to check  Address Line2 should have City followed by asterik, State ends with a single backslash Address Line 3 should have Zip Code followed by asterik, Country Code ends with a single backslash For example Zip code*US\\ \n - For Japan Instant payment creditor.address_lines field is not applicable \n - For SEPA, creditor.address_lines is optional and allowed max length is 70"
          items:
            $ref: '#/components/schemas/Address'
          title: address_lines
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Creditor's street_name \n - For TH Instant payment creditor.street_name is not applicable \n - For US Instant payment creditor.street_name is optional \n - For IN IMPS creditor.street_name is optional \n - For UK FPS Instant payment creditor.street_name field is not applicable \n - For IN UPI creditor.street_name is optional \n - For US Wire, creditor.street_name field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.street_name field is mandatory when creditor.address_lines field is not provided and allowed max length is 18 \n - For Japan Instant payment creditor.street_name field is not applicable \n - For SEPA, creditor.street_name is optional and allowed max length is 70"
          title: street_name
        building_number:
          maxLength: 16
          minLength: 1
          type: string
          description: "Creditor's building_number \n - For TH Instant payment creditor.building_number is not applicable \n - For US Instant payment creditor.building_number field is optional \n - For IN IMPS creditor.building_number field is optional \n - For UK FPS Instant payment creditor.building_number field is not applicable \n - For IN UPI creditor.building_number field is optional \n - For US Wire payment, creditor.building_number field is conditional with max length 16. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.building_number field is mandatory when creditor.address_lines field is not provided and allowed max length is 16 \n - For Japan Instant payment creditor.building_number field is not applicable \n - For SEPA, creditor.building_number is optional and max length is 16"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Creditor's postal_code \n - For TH Instant payment creditor.postal_code is not applicable \n - For US Instant payment creditor.postal_code field is optional \n - For IN IMPS creditor.postal_code field is optional \n - For UK FPS Instant payment creditor.postal_code field is not applicable \n - For IN UPI creditor.postal_code field is optional \n - For US Wire, creditor.postal_code field is conditional with max length 16. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.postal_code field is mandatory when creditor.address_lines field is not provided and allowed max length is 16 \n - For Japan Instant payment creditor.postal_code field is not applicable \n - For SEPA, creditor.postal_code is optional and allowed max length is 16"
          title: postal_code
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's city \n - For TH Instant payment creditor.city is not applicable \n - For US Instant payment creditor.city field is optional \n - For IN IMPS creditor.city field is optional \n - For UK FPS Instant payment creditor.city field is not applicable \n - For IN UPI creditor.city field is optionaloptional \n - For US Wire, creditor.city field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.city field is mandatory when creditor.address_lines field is not provided and allowed max length is 32 \n - For Japan Instant payment creditor.city field is not applicable \n - For SEPA, creditor.city is optional and allowed max length is 35"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's state \n - For TH Instant payment creditor.state is not applicable \n - For US Instant payment creditor.state field is optional \n - For IN IMPS creditor.state field is optional \n - For UK FPS Instant payment creditor.state is not applicable \n - For IN UPI creditor.state field is optional \n - For US Wire, creditor.state field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, creditor.state field is mandatory when creditor.address_lines field is not provided and allowed max length is 2 \n - For Japan Instant payment creditor.state field is not applicable \n - For SEPA, creditor.state is optional and allowed max length is 35"
          title: state
        country:
          type: string
          description: "Creditor's country \n - For TH Instant payment creditor.country is not applicable \n - For US Instant payment creditor.country field is optional \n - For IN IMPS creditor.country field is optional \n - For UK FPS Instant payment creditor.country field is mandatory, if creditor.address_line is provided by client \n - For IN UPI creditor.country field is optional \n - For US Wire, creditor.country field is mandatory with max length 2 \n - For US ACH CCD/PPD/IAT payment, creditor.country field is mandatory when creditor.address_lines field is not provided and allowed max length is 2 \n - For Japan Instant payment creditor.country field is not applicable \n - For SEPA, creditor.country is optional and allowed maxLength is 2"
          pattern: ^[A-Z]{2,2}$
          title: country
        org_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's org_id \n - For TH Instant payment creditor.org_id is not applicable \n - For US Instant payment creditor.org_id field is optional.Pattern should be followed [A-Z0-9]{18,18}[0-9]{2,2} where first 18 characters can be uppercase or numbers and the last two characters must be numeric \n - For IN IMPS creditor.org_id is not applicable \n - For UK FPS Instant payment creditor.org_id field is not applicable \n - For IN UPI creditor.org_id is not applicable \n - For US Wire, creditor.org_id is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.org_id is not applicable \n - For Japan Instant payment creditor.org_id field is not applicable \n - For SEPA, creditor.org_id is conditional optional with either creditor.org_id or creditor.prvt_id or combination of creditor.birth_date/birth_city/birth_country should be populated"
          title: org_id
        prvt_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's prvt_id \n - For TH Instant payment creditor.prvt_id field is not applicable \n - For US Instant payment creditor.prvt_id field is optional with max length 35.Either org_id or prvt_id or none of them should be passed by client. \n - For IN IMPS creditor.prvt_id field is not applicable \n - For UK FPS Instant payment creditor.prvt_id field is optional, Additional identification of Beneficiary Customer’s account with the receiving organisation. \n - For IN UPI creditor.prvt_id field is not applicable \n - For US Wire, creditor.prvt_id is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.prvt_id is not applicable \n - For Japan Instant payment creditor.prvt_id field is not applicable  \n - For SEPA, creditor.org_id is conditional optional with either creditor.org_id or creditor.prvt_id or combination of creditor.birth_date/birth_city/birth_country should be populated"
          title: prvt_id
        birth_date:
          type: string
          format: date
          description: "ISO 8601 (YYYY-MM-DD), Creditor's birth_date \n - For TH Instant payment creditor.birth_date is not applicable \n - For US Instant payment creditor.birth_date field is optional \n - For IN IMPS creditor.birth_date is not applicable \n - For UK FPS Instant payment creditor.birth_date field is optional  \n - For IN UPI creditor.birth_date is not applicable \n - For US Wire, creditor.birth_date field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.birth_date is not applicable \n - For Japan Instant payment creditor.birth_date field is not applicable \n - For SEPA, creditor.birth_date is conditional mandatory with date on which the person is born"
          title: birth_date
        birth_city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's birth_city \n - For TH Instant payment creditor.birth_city is not applicable \n - For US Instant payment creditor.birth_city field is optional \n - For IN IMPS creditor.birth_city is not applicable \n - For UK FPS Instant payment creditor.birth_city is not applicable \n - For IN UPI creditor.birth_city is not applicable \n - For US Wire, creditor.birth_city field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.birth_city is not applicable \n - For Japan Instant payment creditor.birth_city field is not applicable \n - For SEPA, creditor.birth_city is conditional mandatory with city in which the person is born"
          title: birth_city
        birth_country:
          type: string
          description: "Creditor's birth_country \n - For TH Instant payment creditor.birth_country is not applicable \n - For US Instant payment creditor.birth_country field is optional \n - For IN IMPS  creditor.birth_country is not applicable \n - For UK FPS Instant payment creditor.birth_country is not applicable \n - For IN UPI  creditor.birth_country is not applicable \n - For US Wire, creditor.birth_country field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.birth_country is not applicable \n - For Japan Instant payment creditor.birth_country field is not applicable \n - For SEPA, creditor.birth_country is conditional mandatory with country in which person is born"
          pattern: ^[A-Z]{2,2}$
          title: birth_country
        birth_province:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor's Province Of Birth \n - For TH Instant payment creditor.birth_province is not applicable \n - For US Instant payment creditor.birth_province is not applicable \n - For IN IMPS creditor.birth_province is not applicable \n - For UK FPS Instant payment creditor.birth_province is not applicable \n - For IN UPI creditor.birth_province is not applicable \n - For US Wire, creditor.birth_province is not applicable \n - For US ACH CCD/PPD payment, creditor.birth_province is not applicable \n - For US ACH IAT payment, creditor.birth_province is not applicable \n - For US ACH IAT payment, creditor.birth_province is not applicable \n- For SEPA, creditor.birth_province is optional with max length 35 \n - For Japan Instant payment creditor.birth_province is not applicable"
          title: birth_province
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor bank's network identification (e.g., routing number in the United States) \n - For TH Instant payment creditor.bank_id field is optional and allowed maxlength is 3 \n - For US Instant payment creditor.bank_id field is mandatory \n - For IN IMPS Instant payment creditor.bank_id field is mandatory and client should pass IFSC code (including branch code)  \n - For UK FPS Instant payment creditor.bank_id field is mandatory, if creditor.account field is pouplated with account number. For sort code mininum and maximum length is 6 Digits and for BIC Code allowed number of charcters are 8 or 11 \n - For IN UPI Instant payment creditor.bank_id field is mandatory with max length 11, if creditor.proxy_id is not provided by client \n - For US Wire, creditor.bank_id field is optional. It is mandatory only for 2 credit party, either BIC or MmbId must be provided. If the input is BIC, min and max length should be 8 and 11 and should adhere to pattern [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}. If the input is routing code, min and max length is 1 and 11. Note: 1. Target / Beneficiary bank SWIFT code. Applicable only for 2 credit party payments. If it is routing code, min and max length is 9 \n - For US ACH CCD/PPD payment, creditor.bank_id is mandatory field with max length is 9 \n - For US ACH IAT payment, creditor.bank_id is mandatory field with max length is 34 \n - For Japan Instant payment creditor.bank_id field is mandatory and allowed max length is 7  \n - For SEPA, creditor.bank_id is Optional field and allowed max length is 11 and Creditor Agent BIC should be either 8 or 11 characters with Country code in the fifth and sixth characters, the optional characters 9-11 may be 'XXX' "
          title: bank_id
        bank_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Creditor's bank name \n- For Thailand PromptPay creditor.bank_name field is not applicable \n- For United States creditor.bank_name field is not applicble \n- For IN IMPS creditor.bank_name field is not applicable \n- For UK FPS Instant payment creditor.bank_name field is not applicable \n- For IN UPI creditor.bank_name field is not applicable \n - For US Wire, creditor.bank_name is optional field with max length 35 \n - For US ACH CCD/PPD/IAT payment, creditor.bank_name field is optional and allowed maxlength is 35 characters. \n - For Japan Instant payment creditor.bank_name field is not applicable \n- For SEPA, creditor.bank_name field is not applicable"
          title: name
        bank_address_lines:
          type: array
          description: "Creditor's bank address_lines \n- For Thailand PromptPay creditor.bank_address_lines field is not applicable \n- For United States creditor.bank_address_lines field is not applicble \n- For IN IMPS creditor.bank_address_lines field is not applicable \n- For UK FPS Instant payment creditor.bank_address_lines field is not applicable \n- For IN UPI creditor.bank_address_lines field is not applicable \n - For US Wire payment, creditor.bank_address_lines field is optional and upto 3 lines of min 1 and max 35 characters are allowed. \n - For US ACH CCD/PPD/IAT payment, creditor.bank_address_lines is not applicable \n - For Japan Instant payment creditor.bank_address_lines field is not applicable \n- For SEPA, creditor.bank_address_lines field is not applicable"
          items:
            $ref: '#/components/schemas/Address'
          title: bank_address_lines
        account_type:
          maxLength: 35
          minLength: 1
          type: string
          description: "Creditor Account Type \n - For TH Instant payment creditor.account_type field is not applicable \n - For US Instant payment creditor.account_type field is not applicable \n - For IN IMPS creditor.account_type field is mandatory and possible values are 01,02,04 \n - For UK FPS Instant payment creditor.account_type field is not applicable \n - For IN UPI creditor.account_type field is mandatory and possible values are 01 for Current,02 for Savings,04 for Cash Credit \n - For US Wire, creditor.account_type is an optional field and possible values are CACC for Current and SVGS for Savings \n - For US ACH CCD/PPD/IAT payment, creditor.account_type field is mandatory and possible values are CACC for Current and SVGS for Savings \n - For JP Instant payment creditor.account_type field is mandatory and allowed values are FU, TO, CHI and SO  \n- For SEPA, creditor.bank_address_lines field is not applicable"
          title: account_type
        account_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Creditor account name \n- For Thailand PromptPay creditor.account_name field is not applicable \n- For United States creditor.account_name field is not applicble \n- For IN IMPS creditor.account_name field is not applicable \n- For UK FPS Instant payment creditor.account_name field is not applicable \n- For IN UPI creditor.account_name field is not applicable \n - For US Wire, creditor.account_name is an optional field with max length 35.Provide only if it is different than Beneficiary name \n - For US ACH CCD/PPD/IAT payment, creditor.account_name is not applicable \n - For Japan Instant payment creditor.account_name field is not applicable \n- For SEPA, creditor.account_name field is not applicable"
          title: account_name
        scheme_name:
          maxLength: 128
          minLength: 1
          type: string
          description: "Creditor's scheme name \n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments creditor.scheme_name is not applicable \n - For SEPA, creditor.scheme_name field is optional with max length as 35"
          title: scheme_name
        bank_instructions:
          maxLength: 140
          minLength: 1
          type: string
          description: "Instructions code for creditor agent \n- For Thailand PromptPay creditor.bank_instructions field is not applicable \n- For United States creditor.bank_instructions field is not applicble \n- For IN IMPS creditor.bank_instructions field is not applicable \n- For UK FPS Instant payment creditor.bank_instructions field is not applicable \n- For IN UPI creditor.bank_instructions field is not applicable \n - For US Wire, creditor.bank_instructions is an optional field with min 1 and max 36. if It is code, the max length is 4. codes: CHQB - PayCreditorByCheque, HOLD - HoldCashForCreditor, PHOB- PhoneBeneficiary, TELB- Telecom. \n - For US ACH CCD/PPD/IAT payment, creditor.bank_instructions is not applicable \n - For Japan Instant payment creditor.bank_instructions field is not applicable \n- For SEPA, creditor.bank_instructions field is not applicable"
          title: bank_instructions
        name_conversion_flag:
          type: string
          enum:
          - Y
          - N
          description: "Creditor's name conversion flag \n- For TH Instant payment creditor.name_conversion_flag field is not applicable \n - For US Instant payment creditor.name_conversion_flag field is not applicable \n - For IN IMPS creditor.name_conversion_flag field is not applicable \n - For UK FPS Instant payment creditor.name_conversion_flag field is not applicable \n - For IN UPI creditor.name_conversion_flag field is not applicable \n - For US Wire, creditor.name_conversion_flag field is not applicable \n - For US ACH CCD/PPD/IAT payment, creditor.name_conversion_flag is not applicable \n - For Japan Instant payment creditor.name_conversion_flag field is optional \n- For SEPA, creditor.name_conversion_flag field is not applicable"
          title: name_conversion_flag
        department:
          maxLength: 70
          minLength: 1
          type: string
          description: "creditor Address Department \n - For TH Instant payment creditor.department is not applicable \n - For US Instant payment creditor.department is not applicable \n - For IN IMPS creditor.department is not applicable \n - For UK FPS Instant payment creditor.department is not applicable \n - For IN UPI creditor.department is not applicable \n - For US Wire, creditor.department is not applicable \n - For US ACH CCD/PPD payment, creditor.department is not applicable \n - For US ACH IAT payment, creditor.department is not applicable \n - For US ACH IAT payment, creditor.department is not applicable \n- For SEPA IDP, creditor.department is optional with max length 70 \n - For Japan Instant payment creditor.department field is not applicable \n- For SEPA, creditor.department is optional with max length 70"
          title: department
        sub_department:
          maxLength: 70
          minLength: 1
          type: string
          description: "creditor Address Sub-Department \n - For TH Instant payment creditor.sub_department is not applicable \n - For US Instant payment creditor.sub_department is not applicable \n - For IN IMPS creditor.sub_department is not applicable \n - For UK FPS Instant payment creditor.sub_department is not applicable \n - For IN UPI creditor.sub_department is not applicable \n - For US Wire, creditor.sub_department is not applicable \n - For US ACH CCD/PPD payment, creditor.sub_department is not applicable \n - For US ACH IAT payment, creditor.sub_department is not applicable \n - For US ACH IAT payment, creditor.sub_department is not applicable \n- For SEPA IDP, creditor.sub_department is optional with max length 70 \n - For Japan Instant payment creditor.sub_department field is not applicable \n- For SEPA, creditor.sub_department is optional with max length 70"
          title: sub_department
        building_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor building name \n - For TH Instant payment creditor.building_name is not applicable \n - For US Instant payment creditor.building_name is not applicable \n - For IN IMPS creditor.building_name is not applicable \n - For UK FPS Instant payment creditor.building_name is not applicable \n - For IN UPI creditor.building_name is not applicable \n - For US Wire, creditor.building_name is not applicable \n - For US ACH CCD/PPD payment, creditor.building_name is not applicable \n - For US ACH IAT payment, creditor.building_name is not applicable \n - For US ACH IAT payment, creditor.building_name is not applicable \n- For SEPA IDP, creditor.building_name is optional with max length 35 \n - For Japan Instant payment creditor.building_name field is not applicable \n- For SEPA, creditor.building_name is optional with max length 35"
          title: building_name
        floor:
          maxLength: 70
          minLength: 1
          type: string
          description: "creditor address floor \n - For TH Instant payment creditor.floor is not applicable \n - For US Instant payment creditor.floor is not applicable \n - For IN IMPS creditor.floor is not applicable \n - For UK FPS Instant payment creditor.floor is not applicable \n - For IN UPI creditor.floor is not applicable \n - For US Wire, creditor.floor is not applicable \n - For US ACH CCD/PPD payment, creditor.floor is not applicable \n - For US ACH IAT payment, creditor.floor is not applicable \n - For US ACH IAT payment, creditor.floor is not applicable \n- For SEPA IDP, creditor.floor is optional with max length 70 \n - For Japan Instant payment creditor.floor field is not applicable \n- For SEPA, creditor.floor is optional with max length 70"
          title: floor
        post_box:
          maxLength: 16
          minLength: 1
          type: string
          description: "creditor address post box \n - For TH Instant payment creditor.post_box is not applicable \n - For US Instant payment creditor.post_box is not applicable \n - For IN IMPS creditor.post_box is not applicable \n - For UK FPS Instant payment creditor.post_box is not applicable \n - For IN UPI creditor.post_box is not applicable \n - For US Wire, creditor.post_box is not applicable \n - For US ACH CCD/PPD payment, creditor.post_box is not applicable \n - For US ACH IAT payment, creditor.post_box is not applicable \n - For US ACH IAT payment, creditor.post_box is not applicable \n- For SEPA IDP, creditor.post_box is optional with max length 16 \n - For Japan Instant payment creditor.post_box field is not applicable \n- For SEPA, creditor.post_box is optional with max length 16"
          title: post_box
        room:
          maxLength: 70
          minLength: 1
          type: string
          description: "creditor address room \n - For TH Instant payment creditor.room is not applicable \n - For US Instant payment creditor.room is not applicable \n - For IN IMPS creditor.room is not applicable \n - For UK FPS Instant payment creditor.room is not applicable \n - For IN UPI creditor.room is not applicable \n - For US Wire, creditor.room is not applicable \n - For US ACH CCD/PPD payment, creditor.room is not applicable \n - For US ACH IAT payment, creditor.room is not applicable \n - For US ACH IAT payment, creditor.room is not applicable \n- For SEPA IDP, creditor.room is optional with max length 70 \n - For Japan Instant payment creditor.room field is not applicable \n- For SEPA, creditor.room is optional with max length 70"
          title: room
        town_location_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor address town location name \n - For TH Instant payment creditor.town_location_name is not applicable \n - For US Instant payment creditor.town_location_name is not applicable \n - For IN IMPS creditor.town_location_name is not applicable \n - For UK FPS Instant payment creditor.town_location_name is not applicable \n - For IN UPI creditor.town_location_name is not applicable \n - For US Wire, creditor.town_location_name is not applicable \n - For US ACH CCD/PPD payment, creditor.town_location_name is not applicable \n - For US ACH IAT payment, creditor.town_location_name is not applicable \n - For US ACH IAT payment, creditor.town_location_name is not applicable \n- For SEPA IDP, creditor.town_location_name is optional with max length 35 \n - For Japan Instant payment creditor.town_location_name field is not applicable \n- For SEPA, creditor.town_location_name is optional with max length 35"
          title: town_location_name
        district_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor address district_name \n - For TH Instant payment creditor.district_name is not applicable \n - For US Instant payment creditor.district_name is not applicable \n - For IN IMPS creditor.district_name is not applicable \n - For UK FPS Instant payment creditor.district_name is not applicable \n - For IN UPI creditor.district_name is not applicable \n - For US Wire, creditor.district_name is not applicable \n - For US ACH CCD/PPD payment, creditor.district_name is not applicable \n - For US ACH IAT payment, creditor.district_name is not applicable \n - For US ACH IAT payment, creditor.district_name is not applicable \n- For SEPA IDP, creditor.district_name is optional with max length 35 \n - For Japan Instant payment creditor.district_name field is not applicable \n- For SEPA, creditor.district_name is optional with max length 35"
          title: district_name
        anybic:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor BIC \n - For TH Instant payment creditor.anybic is not applicable \n - For US Instant payment creditor.anybic is not applicable \n - For IN IMPS creditor.anybic is not applicable \n - For UK FPS Instant payment creditor.anybic is not applicable \n - For IN UPI creditor.anybic is not applicable \n - For US Wire, creditor.anybic is not applicable \n - For US ACH CCD/PPD payment, creditor.anybic is not applicable \n - For US ACH IAT payment, creditor.anybic is not applicable \n - For US ACH IAT payment, creditor.anybic is not applicable \n- For SEPA IDP, creditor.anybic is optional with max length 11 \n - For Japan Instant payment creditor.anybic field is not applicable \n- For SEPA, creditor.anybic is optional with max length 11"
          title: anybic
        lei:
          maxLength: 35
          minLength: 1
          type: string
          description: "Unique global identifier for legal entities participating in financial transactions \n - For TH Instant payment creditor.lei is not applicable \n - For US Instant payment creditor.lei is not applicable \n - For IN IMPS creditor.lei is not applicable \n - For UK FPS Instant payment creditor.lei is not applicable \n - For IN UPI creditor.lei is not applicable \n - For US Wire, creditor.lei is not applicable \n - For US ACH CCD/PPD payment, creditor.lei is not applicable \n - For US ACH IAT payment, creditor.lei is not applicable \n - For US ACH IAT payment, creditor.lei is not applicable \n- For SEPA IDP, creditor.lei is optional with max length 20 \n - For Japan Instant payment creditor.lei field is not applicable \n- For SEPA, creditor.lei is optional with max length 20"
          title: lei
        issuer:
          maxLength: 35
          minLength: 1
          type: string
          description: "creditor name that identifies an issuer \n - For TH Instant payment creditor.issuer is not applicable \n - For US Instant payment creditor.issuer is not applicable \n - For IN IMPS creditor.issuer is not applicable \n - For UK FPS Instant payment creditor.issuer is not applicable \n - For IN UPI creditor.issuer is not applicable \n - For US Wire, creditor.issuer is not applicable \n - For US ACH CCD/PPD payment, creditor.issuer is not applicable \n - For US ACH IAT payment, creditor.issuer is not applicable \n - For US ACH IAT payment, creditor.issuer is not applicable \n- For SEPA IDP, creditor.issuer is optional with max length 35 \n - For Japan Instant payment creditor.issuer field is not applicable \n- For SEPA, creditor.issuer is optional with max length 35"
          title: issuer
        advice_mobile:
          maxLength: 34
          type: string
          pattern: ^[+][0-9]{1,3}[-\ ][0-9()+\-]{1,30}$
          description: "Creditor's mobile number \n - For TH,US,UK FPS, IN UPI, Stripe US Wire, US ACH CCD/PPD/IAT, Japan, SEPA Instant payment creditor.advice_mobile field is not applicable \n - For India FIR IMPS payment creditor.advice_mobile field is optional and populated when transaction.advice_type is SMSM"
          title: advice_mobile
        advice_email:
          type: string
          maxLength: 2048
          minLength: 1
          description: "Creditor's email address \n- For US,UK FPS,IN UPI ,US Wire,US ACH CCD/PPD/IAT payment, Japan, SEPA, this field is not applicable \n- For India FIR IMPS payment creditor.advice_email field is optional and populated when transaction.advice_type is EMAL"
          title: advice_email
        advice_qrcode:
          type: string
          maxLength: 512
          description: QR Code made available to the creditor - only for open bank with QR code
          title: advice_qrcode
        bank_branch_id:
          maxLength: 35
          minLength: 1
          type: string
          description: Creditor bank's branch network identification
          title: bank_branch_id
      additionalProperties: false
      description: Creditor information
    Intermediary-Details:
      title: IntermediaryDetails
      properties:
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "intermediary agent identifier (e.g., routing number in the United States) \n - For TH Instant payment Intermediary.bank_id field is not applicable \n - For US Instant payment Intermediary.bank_id field is not applicable \n - For IN IMPS Instant payment Intermediary.bank_id field is not applicable \n - For UK FPS Instant payment Intermediary.bank_id field is not applicable \n - For IN UPI Instant payment Intermediary.bank_id field is not applicable \n - For US Wire, intermediary.bank_id field is optional. Applicable to 3 credit party payments only, either BIC or MmbId should be provided. If the input is BIC, min and max length should be 8 and 11 and should adhere to pattern [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}. If the input is routing code, min and max length is 1 and 11. Note: 1. First Intermediary bank SWIFT Code (BIC) is applicable to 3 credit party payments only. 2. Second Intermediary bank SWIFT Code is applicable to 3 credit party payments only \n - For US ACH CCD/PPD payment, Intermediary.bank_id is not applicable \n - For US ACH IAT payment, Intermediary.bank_id is mandatory and allowed max length is 11 \n - For Japan Instant payment Intermediary.bank_id field is not applicable"
          title: bank_id
        bank_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "intermediary agent name \n - For TH Instant payment Intermediary.bank_name is not applicable \n - For US Instant payment Intermediary.bank_name is not applicable \n - For IN IMPS Instant payment Intermediary.bank_name is not applicable \n - For UK FPS Instant payment Intermediary.bank_name is not applicable \n - For IN UPI Instant payment Intermediary.bank_name is not applicable \n - For US Wire, Intermediary.bank_name field is conditional with max length 35. Mandaotry if payment is 3 and 4 credit party payment \n - For US ACH CCD/PPD payment, Intermediary.bank_name is not applicable \n - For US ACH IAT payment, Intermediary.bank_name is optional and allowed max length is 35 \n - For Japan Instant payment Intermediary.bank_name field is not applicable"
          title: name
        bank_country:
          type: string
          description: "intermediary agent Country \n - For TH Instant payment intermediary.bank_country is not applicable \n - For US Instant payment intermediary.bank_country is not applicable \n - For IN IMPS intermediary.bank_country is not applicable \n - For UK FPS Instant payment intermediary.bank_country is not applicable \n - For IN UPI intermediary.bank_country is not applicable \n - For US Wire, intermediary.bank_country field is mandatory with max length 2. \n - For US ACH CCD/PPD payment, Intermediary.bank_country is not applicable \n - For US ACH IAT payment, Intermediary.bank_country is mandatory \n - For Japan Instant payment Intermediary.bank_country field is not applicable"
          pattern: ^[A-Z]{2,2}$
          title: country
        bank_address_lines:
          type: array
          description: "intermediary agent address_lines \n - For TH Instant payment intermediary.bank_address_lines is not applicable \n - For US Instant payment intermediary.bank_address_lines is not applicable \n - For IN IMPS intermediary.bank_address_lines is not applicable \n - For UK FPS Instant payment intermediary.bank_address_lines is not applicable \n - For IN UPI intermediary.bank_address_lines is not applicable \n - For US Wire payment, intermediary.bank_.address_lines field is optional and upto 3 lines of min 1 and max 35 characters are allowed. \n - For US ACH CCD/PPD/IAT payment, Intermediary.bank_address_lines is not applicable \n - For Japan Instant payment Intermediary.bank_address_lines field is not applicable"
          items:
            $ref: '#/components/schemas/Address'
          title: bank_address_lines
        bank_account_id:
          maxLength: 34
          minLength: 1
          type: string
          description: "intermediary agent account id \n - For TH Instant payment intermediary.bank_account_id is not applicable \n - For US Instant payment intermediary.bank_account_id is not applicable \n - For IN IMPS intermediary.bank_account_id is not applicable \n - For UK FPS Instant payment intermediary.bank_account_id is not applicable \n - For IN UPI intermediary.bank_account_id is not applicable \n - For US Wire, intermediary.bank_account_id is an optional field with max length is 34 \n - For US ACH CCD/PPD/IAT payment, Intermediary.bank_account_id is not applicable \n - For Japan Instant payment Intermediary.bank_account_id field is not applicable "
          title: account
      additionalProperties: false
      description: 'intermediary agents information. Note: 1st occurance of intermediary set will be used intermediary agent 1 information. 2nd occurance of intermediary set will be used for intermediary agent 2 '
    Ultimate-Debtor-Status:
      type: object
      title: UltimateDebtorStatus
      properties:
        name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Ultimate Debtor's bank account name \n - For TH Instant payment ultimate_debtor.name is not applicable \n - For US Instant payment ultimate_debtor.name is optional \n - For IN IMPS ultimate_debtor.name is not applicable \n - For UK FPS Instant payment ultimate_debtor.name is optional with max length 40 \n - For IN UPI ultimate_debtor.name is not applicable \n - For US Wire, ultimate_debtor name is a conditional field with min 1 and max 35 characters. It become mandatory if Ultimate Remitter is being used for POBO. \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.name field is mandatory and allowed max length is 16 \n - For Japan Instant payment ultimate_debtor.name field is optional \n - For TH NRBA Instant remittances payment ultimate_debtor.name is mandatory \n - For India FIR IMPS payment, ultimate_debtor.name field is mandatory with max length 50 \n - For SEPA, ultimate_debtor.name is optional with max length 70 \n - For SEPA IDP ultimate_debtor.name is optional with max length 70"
          title: name
        address_lines:
          type: array
          description: "Ultimate Debtor's address_lines \n - For TH Instant payment ultimate_debtor.address_lines is not applicable \n - For US Instant payment ultimate_debtor.address_lines is optional \n - For IN IMPS ultimate_debtor.address_lines is not applicable \n - For UK FPS Instant payment ultimate_debtor.address_lines is optional with max 4 instances allowed and each line max length 35 \n - For IN UPI ultimate_debtor.address_lines is not applicable \n - For US Wire payment, ultimate_debtor.address_lines field is conditional and upto 3 lines of min 1 and max 35 characters are allowed. Partial addresses will not be accepted, Street name, city and country should present in address_line. It become mandatory if Ultimate Remitter is being used for POBO \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.address_lines is mandatory when structured address lines fields are not provided and allowed three instance with each line max length of 35, Address Line 1 should have Building info followed by asterik, Street Address ends with a single backslash \n Address Line 2 and then application to check  Address Line2 should have City followed by asterik, State ends with a single backslash Address Line 3 should have Zip Code followed by asterik, Country Code ends with a single backslash For example Zip code*US\\ \n - For Japan Instant payment ultimate_debtor.address_lines is optional with max 7 instances allowed and each line max length 70 \n - For India FIR IMPS payment ultimate_debtor.address_lines is optional \n- For SEPA IDP, ultimate_debtor.address_lines field is optional with maximum of 2 lines allowed and upto 70 chars each line \n - For SEPA, ultimate_debtor.address_lines field is optional with maximum of 2 lines allowed and upto 70 chars each line"
          items:
            $ref: '#/components/schemas/Address'
          title: address_lines
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Ultimate Debtor's street_name \n - For TH Instant payment ultimate_debtor.street_name is not applicable \n - For US Instant payment ultimate_debtor.street_name is optional \n - For IN IMPS ultimate_debtor.street_name is not applicable \n - For UK FPS Instant payment ultimate_debtor.street_name is optional with max length 70 \n - For IN UPI ultimate_debtor.street_name is not applicable \n - For US Wire ultimate_debtor.street_name is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.street_name is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 18 \n - For Japan Instant payment ultimate_debtor.street_name field is optional \n - For India FIR IMPS payment, ultimate_debtor.street_name field is mandatory with max length 35 \n - For SEPA, ultimate_debtor.street_name field is not applicable \n- For SEPA IDP, this field is not applicable"
          title: street_name
        building_number:
          maxLength: 16
          minLength: 1
          type: string
          description: "Ultimate Debtor's building_number \n - For TH Instant payment ultimate_debtor.building_number is not applicable \n - For US Instant payment ultimate_debtor.building_number field is optional \n - For IN IMPS ultimate_debtor.building_number is not applicable \n - For UK FPS Instant payment ultimate_debtor.building_number is optional with max length 16 \n - For IN UPI ultimate_debtor.building_number is not applicable \n - For US Wire ultimate_debtor.building_number is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.building_number is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 16  \n - For Japan Instant payment ultimate_debtor.building_number field is optional \n - For India FIR IMPS payment, ultimate_debtor.building_number field is mandatory with max length 16 \n - For SEPA, ultimate_debtor.street_name field is not applicable \n- For SEPA IDP, this field is not applicable"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Ultimate Debtor's postal_code \n - For TH Instant payment ultimate_debtor.postal_code is not applicable \n - For US Instant payment ultimate_debtor.postal_code field is optional \n - For IN IMPS ultimate_debtor.postal_code is not applicable \n - For UK FPS Instant payment ultimate_debtor.postal_code is optional with max length 16 \n - For IN UPI ultimate_debtor.postal_code is not applicable \n - For US Wire ultimate_debtor.postal_code is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.postal_code is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 16 \n - For Japan Instant payment ultimate_debtor.postal_code field is optional \n - For India FIR IMPS payment, ultimate_debtor.postal_code field is mandatory \n - For SEPA, ultimate_debtor.postal_code is not applicable \n- For SEPA IDP, this field is not applicable"
          title: postal_code
        town_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's town name \n - For SEPA,TH, US, IN IMPS, UK FPS, IN UPI, US Wire, JP payments ultimate_debtor.town_name is not applicable \n - For TH NRBA Instant remittances payment ultimate_debtor.town_name field is mandatory, if client provided ultimate_debtor.country field \n- For SEPA IDP, this field is not applicable"
          title: town_name
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's city \n - For TH Instant payment ultimate_debtor.city is not applicable \n - For US Instant payment ultimate_debtor.city field is optional \n - For IN IMPS ultimate_debtor.city is not applicable \n - For UK FPS Instant payment ultimate_debtor.city is optional with max length 35 \n - For IN UPI ultimate_debtor.city is not applicable \n - For US Wire ultimate_debtor.city is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.city is is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 32 \n - For Japan Instant payment ultimate_debtor.city field is optional \n - For India FIR IMPS payment, ultimate_debtor.city field is mandatory \n - For SEPA, ultimate_debtor.postal_code is not applicable \n - For SEPA IDP, ultimate_debtor.postal_code is not applicable"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's state \n - For TH Instant payment ultimate_debtor.state is not applicable \n - For US Instant payment ultimate_debtor.state field is optional \n - For IN IMPS ultimate_debtor.state is not applicable \n - For UK FPS Instant payment ultimate_debtor.state is optional with max length 35  \n - For IN UPI ultimate_debtor.state is not applicable \n - For US Wire ultimate_debtor.state is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.state is is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 2  \n - For Japan Instant payment ultimate_debtor.state field is optional \n - For India FIR IMPS payment, ultimate_debtor.state field is optional \n - For SEPA, ultimate_debtor.postal_code is not applicable \n - For SEPA IDP, ultimate_debtor.postal_code is not applicable"
          title: state
        country:
          type: string
          description: "Ultimate Debtor's country \n - For TH Instant payment ultimate_debtor.country is not applicable \n - For US Instant payment ultimate_debtor.country field is optional \n - For IN IMPS ultimate_debtor.country is not applicable \n - For UK FPS Instant payment ultimate_debtor.country is conditional and becomes mandatory if ultimate_debtor.name is provided \n - For IN UPI ultimate_debtor.country is not applicable \n - For US Wire ultimate_debtor.country is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.country is mandatory if ultimate_debtor.address_lines is not provided and allowed max length is 2 \n - For TH NRBA Instant remittances payment ultimate_debtor.country field is mandatory, if client provided ultimate_debtor.town_name field \n - For India FIR IMPS payment, ultimate_debtor.country field is mandatory \n - For SEPA ultimate_debtor.country is conditional and becomes mandatory if ultimate_debtor.name is provided \n - For SEPA IDP, ultimate_debtor.country is conditional and becomes mandatory if ultimate_debtor.name is provided"
          pattern: ^[A-Z]{2,2}$
          title: country
        org_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's org_id \n - For TH Instant payment ultimate_debtor.org_id is not applicable \n - For US Instant payment ultimate_debtor.org_id field is optional with max length 20.Pattern should be followed [A-Z0-9]{18,18}[0-9]{2,2} where first 18 characters can be uppercase or numbers and the last two characters must be numeric \n - For IN IMPS ultimate_debtor.org_id is not applicable \n - For UK FPS Instant payment ultimate_debtor.org_id is optional with max length 35 \n - For IN UPI ultimate_debtor.org_id is not applicable \n - For US Wire, ultimate_debtor.org_id is conditionally optional field with max length 34. It become mandatory if POBO is being used. It is present only if prvt_id is not present \n - For US ACH CCD/PPD payment, ultimate_debtor.org_id field is mandatory and applicable value is Organisation TXID or CUST Identification values and value should prefix with /TXID/ or /CUST/, if ultimate_debtor.prvt_id field is not provided by client and allowed value max length is 10 without prefix (/TXID/ or /CUST/) \n - For US ACH IAT payment, ultimate_debtor.org_id is mandatory if ultimate_debtor.prvt_id is not provided and allowed max length is 10 \n - For SEPA IDP ultimate_debtor.org_id is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.org_id field is not applicable \n - For India FIR IMPS payment, ultimate_debtor.org_id field is mandatory \n - For SEPA, ultimate_debtor.org_id is optional with max length 35 \n - For SEPA IDP ultimate_debtor.org_id is optional with max length 35"
          title: org_id
        birth_date:
          type: string
          format: date
          description: "ISO 8601 (YYYY-MM-DD), ultimate debtor's birth date \n - For TH Instant payment ultimate_debtor.birth_date is not applicable \n - For US Instant payment ultimate_debtor.birth_date field is optional \n - For IN IMPS ultimate_debtor.birth_date is not applicable \n - For UK FPS Instant payment ultimate_debtor.birth_date field is optional \n - For IN UPI ultimate_debtor.birth_date is not applicable \n - For US Wire ultimate_debtor.birth_date is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_date is not applicable \n - For SEPA IDP ultimate_debtor.birth_date field is optional \n - For Japan Instant payment ultimate_debtor.birth_date field is not applicable \n - For SEPA, ultimate_debtor.birth_date field is optional"
          title: birth_date
        birth_city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate debtor's birth city \n - For TH Instant payment ultimate_debtor.birth_city is not applicable \n - For US Instant payment ultimate_debtor.birth_city field is optional \n - For IN IMPS ultimate_debtor.birth_city is not applicable \n - For UK FPS Instant payment ultimate_debtor.birth_city is optional with max length 35  \n - For IN UPI ultimate_debtor.birth_city is not applicable \n - For US Wire ultimate_debtor.birth_city is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_city is not applicable \n - For SEPA IDP ultimate_debtor.birth_city is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.birth_city field is not applicable \n - For SEPA, ultimate_debtor.birth_city is optional with max length 35"
          title: birth_city
        birth_country:
          type: string
          description: "Ultimate debtor's birth country \n - For TH Instant payment ultimate_debtor.birth_country is not applicable \n - For US Instant payment ultimate_debtor.birth_country field is optional \n - For IN IMPS  ultimate_debtor.birth_country is not applicable \n - For UK FPS Instant payment ultimate_debtor.birth_country is optional with max length 2 \n - For IN UPI ultimate_debtor.birth_country is not applicable \n - For US Wire ultimate_debtor.birth_country is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_country is not applicable \n - For SEPA IDP ultimate_debtor.birth_country field is optional \n - For Japan Instant payment ultimate_debtor.birth_country field is not applicable \n - For SEPA, ultimate_debtor.birth_country field is optional"
          pattern: ^[A-Z]{2,2}$
          title: birth_country
        prvt_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's private id \n - For TH Instant payment ultimate_debtor.prvt_id is not applicable \n - For US Instant payment ultimate_debtor.prvt_id field is optional with max length 35.Either org_id or prvt_id or none of them should be passed by client \n - For IN IMPS ultimate_debtor.prvt_id is not applicable \n - For UK FPS Instant payment ultimate_debtor.prvt_id is not applicable \n - For IN UPI ultimate_debtor.prvt_id is not applicable \n - For US Wire, ultimate_debtor.prvt_id is conditionally optional field with max length 34. It become mandatory if POBO is being used. It is present only if org_id is not present \n - For US ACH CCD/PPD payment, ultimate_debtor.prvt_id field is mandatory and applicable value is Organisation TXID or CUST Identification  values and value should prefix with /TXID/ or /CUST/, if ultimate_debtor.org_id field is not provided by client \n - For US ACH IAT payment, ultimate_debtor.prvt_id is mandatory if ultimate_debtor.org_id is not provided and allowed max length is 10 \n - For SEPA IDP ultimate_debtor.prvt_id field is optional with max length 35 \n - For SEPA, ultimate_debtor.prvt_id field is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.prvt_id field is not applicable \n - For SEPA IDP ultimate_debtor.prvt_id field is optional with max length 35"
          title: prvt_id
        anybic:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor BIC \n - For TH Instant payment ultimate_debtor.anybic is not applicable \n - For US Instant payment ultimate_debtor.anybic is not applicable \n - For IN IMPS ultimate_debtor.anybic is not applicable \n - For UK FPS Instant payment ultimate_debtor.anybic is not applicable \n - For IN UPI ultimate_debtor.anybic is not applicable \n - For US Wire, ultimate_debtor.anybic is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.anybic is not applicable \n - For US ACH IAT payment, ultimate_debtor.anybic is not applicable \n - For US ACH IAT payment, ultimate_debtor.anybic is not applicable \n- For SEPA IDP, ultimate_debtor.anybic is optional with max length 11 \n - For Japan Instant payment ultimate_debtor.anybic field is not applicable \n- For SEPA, ultimate_debtor.anybic is optional with max length 11"
          title: anybic
        lei:
          maxLength: 35
          minLength: 1
          type: string
          description: "LEI of Organization ID for Ultimate Debtor \n - For TH Instant payment ultimate_debtor.lei is not applicable \n - For US Instant payment ultimate_debtor.lei is not applicable \n - For IN IMPS ultimate_debtor.lei is not applicable \n - For UK FPS Instant payment ultimate_debtor.lei is not applicable \n - For IN UPI ultimate_debtor.lei is not applicable \n - For US Wire, ultimate_debtor.lei is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.lei is not applicable \n - For US ACH IAT payment, ultimate_debtor.lei is not applicable \n - For US ACH IAT payment, ultimate_debtor.lei is not applicable \n- For SEPA IDP, ultimate_debtor.lei is optional with max length 20 \n - For Japan Instant payment ultimate_debtor.lei field is not applicable \n- For SEPA, ultimate_debtor.lei is optional with max length 20"
          title: lei
        issuer:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor name that identifies an issuer \n - For TH Instant payment ultimate_debtor.issuer is not applicable \n - For US Instant payment ultimate_debtor.issuer is not applicable \n - For IN IMPS ultimate_debtor.issuer is not applicable \n - For UK FPS Instant payment ultimate_debtor.issuer is not applicable \n - For IN UPI ultimate_debtor.issuer is not applicable \n - For US Wire, ultimate_debtor.issuer is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.issuer is not applicable \n - For US ACH IAT payment, ultimate_debtor.issuer is not applicable \n - For US ACH IAT payment, ultimate_debtor.issuer is not applicable \n- For SEPA IDP, ultimate_debtor.issuer is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.issuer field is not applicable \n- For SEPA, ultimate_debtor.issuer is optional with max length 35"
          title: issuer
        birth_province:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor  Province Of Birth \n - For TH Instant payment ultimate_debtor.birth_province is not applicable \n - For US Instant payment ultimate_debtor.birth_province is not applicable \n - For IN IMPS ultimate_debtor.birth_province is not applicable \n - For UK FPS Instant payment ultimate_debtor.birth_province is not applicable \n - For IN UPI ultimate_debtor.birth_province is not applicable \n - For US Wire, ultimate_debtor.birth_province is not applicable \n - For US ACH CCD/PPD payment, ultimate_debtor.birth_province is not applicable \n - For US ACH IAT payment, ultimate_debtor.birth_province is not applicable \n - For US ACH IAT payment, ultimate_debtor.birth_province is not applicable \n- For SEPA IDP, ultimate_debtor.birth_province is optional with max length 35 \n - For Japan Instant payment ultimate_debtor.birth_province field is not applicable \n- For SEPA, ultimate_debtor.birth_province is optional with max length 35"
          title: birth_province
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Debtor's bank identification \n - For TH , US, IN IMPS, UK FPS, IN UPI, US Wire, US ACH CCD/PPD/IAT,SEPA,SEPA IDP and JP payment ultimate_debtor.bank_id is not applicable \n - For India FIR IMPS payment, ultimate_debtor.bank_id field is mandatory with max length 11"
          title: bank_id
        scheme_name:
          maxLength: 128
          minLength: 1
          type: string
          description: Ultimate debtor's scheme name
          title: scheme_name
    Debtor-Status:
      type: object
      title: DebtorStatus
      properties:
        proxy_id:
          $ref: '#/components/schemas/Proxy-Id'
        proxy_type:
          type: string
          enum:
          - BIID
          - EMAL
          - EWAL
          - MBNO
          - NIDN
          description: "Debtor's proxy type (BIID for bill identification, EMAL for email address, EWAL for electronic wallet identification, MBNO for mobile number and NIDN for national identification) \n - For TH Instant payment debtor.proxy_type is optional \n - For US Instant payment debtor.proxy_type is not applicable \n - For IN IMPS debtor.proxy_type is not applicable \n - For UK FPS Instant payment debtor.proxy_type is not applicable \n - For JP Instant payment debtor.proxy_type is not applicable \n - For IN UPI Instant payment debtor.proxy_type is not applicable \n - For US Wire payment, debtor.proxy_type field is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.proxy_type field is not applicable \n- For SEPA IDP, this field is optional with max length 35 \n- For SEPA, this field is optional with max length 35"
          title: proxy_type
        tax_id:
          maxLength: 128
          minLength: 1
          type: string
          description: "Debtor's tax identification \n - For TH Instant payment debtor.tax_id is optional \n - For US Instant payment debtor.tax_id is not applicable \n - For IN IMPS debtor.tax_id field is not applicable \n - For UK FPS Instant payment debtor.tax_id is not applicable \n - For JP Instant payment debtor.tax_id is not applicable \n - For IN UPI debtor.tax_id field is not applicable \n - For US Wire, debtor.tax_id is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.tax_id field is not applicable \n- For SEPA IDP, this field is not applicable \n- For SEPA, this field is not applicable"
          title: tax_id
        account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Debtor's bank account \n - For IN IMPS debtor.account field, allowed max length is 34 \n - For UK FPS Instant payment debtor.account field allowed max length is 34 and either account number or IBAN/BBAN number can be passed \n - For IN UPI Instant payment debtor.account field allowed max length is 34 \n - For US Instant payment, debtor.account is a mandatory field with and max length 34 and allowed value is Virtual account number and DDA. \n - For US Wire payment, debtor.account is a mandatory field with and max length 17 and allowed value is Virtual account number. \n - For US ACH CCD/PPD payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. \n - For US ACH IAT payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. \n- For SEPA IDP, this field is mandatory with max length 34 \n - For Japan Instant payment debtor.account field is mandatory and allowed max length is 34 \n- For SEPA, this field is mandatory with max length 34"
          title: account
        account_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Debtor Account name, different from the Debtor Name \n - For TH Instant payment debtor.account_name is not applicable \n - For US Instant payment debtor.account_name is optional \n - For IN IMPS debtor.account_name is not applicable \n - For UK FPS Instant payment debtor.account_name is not applicable \n - For JP Instant payment debtor.account_name is not applicable \n - For IN UPI debtor.account_name is not applicable \n - For US Wire, debtor.account_name is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.account_name is not applicable \n- For SEPA IDP, this field is not applicable \n- For SEPA, this field is not applicable"
          title: account_name
        virtual_account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Debtor's virtual account \n - For TH Instant payment debtor.virtual_account is optional \n - For US Instant payment virtual_account is not applicable \n - For IN IMPS virtual_account is not applicable \n - For UK FPS Instant payment virtual_account is not applicable \n - For JP Instant payment debtor.virtual_account field is applicable \n - For IN UPI virtual_account is not applicable \n - For US Wire, debtor.vitual_account is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.virtual_account field is not applicable \n- For SEPA IDP, this field is not applicable \n- For SEPA, this field is not applicable"
          title: virtual_account
        name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Debtor's bank account name \n - For TH Instant payment debtor.name is not applicable \n - For US Instant payment debtor.name is mandatory \n - For IN IMPS Instant payment debtor.name is mandatory with max length 99 \n - For UK FPS Instant payment debtor.name field is optional with max length 40 \n - For IN UPI Instant payment debtor.name is mandatory with max length 99 \n - For US Wire payment, debtor.name field is mandatory with max length 35. Name cannot contains only NUMERIC values \n - For US ACH CCD/PPD payment, debtor.name field is mandatory with max length 16 \n - For US ACH IAT payment, debtor.name field is mandatory with max length 35 \n - For SEPA IDP payment debtor.name is mandatory with max length 70 \n - For Japan Instant payment debtor.name field is optional \n - For SEPA, debtor.name is mandatory with max length 70"
          title: name
        address_lines:
          type: array
          description: "Debtor's address_lines \n - For TH Instant payment debtor.address_lines is not applicable \n - For US Instant payment debtor.address_lines is optional \n - For IN IMPS debtor.address_lines is optional and allowed seven instance with each line max length of 70 \n - For UK FPS Instant payment debtor.address_lines is optional and allowed only four instance with each line max length of 35 \n - For IN UPI debtor.address_lines is optional and allowed seven instance with each line max length of 70 \n - For US Wire payment, debtor.address_lines field is conditional and upto 3 lines of min 1 and max 35 characters are allowed. Partial addresses will not be accepted, Street name, city and country should present in address_line. address_lines should present only if structured address tags (street name, building number, city, state and postal code) are not present \n - For US ACH CCD/PPD/IAT payment, debtor.address_lines is mandatory when structured address lines fields are not provided and allowed three instance with each line max length of 35, Address Line 1 should have Building info followed by asterik, Street Address ends with a single backslash \n Address Line 2 and then application to check  Address Line2 should have City followed by asterik, State ends with a single backslash Address Line 3 should have Zip Code followed by asterik, Country Code ends with a single backslash For example Zip code*US\\ \n - For SEPA IDP debtor.address_lines is optional and allowed two instance with each line max length of 70 \n - For Japan Instant payment debtor.address_lines is not applicable \n - For SEPA, debtor.address_lines is optional and allowed two instance with each line max length of 70"
          items:
            $ref: '#/components/schemas/Address'
          title: address_lines
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Debtor's street_name \n - For TH Instant payment debtor.street_name is not applicable \n - For US Instant payment debtor.street_name is optional \n - For IN IMPS debtor.street_name is optional \n - For UK FPS Instant payment debtor.street_name is not applicable \n - For IN UPI debtor.street_name is optional \n - For US Wire, debtor.street_name field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, debtor.street_name field is mandatory when debtor.address_lines field is not provided and allowed max length is 18 \n- For SEPA IDP, debtor.street_name is optional with max length 70 \n - For Japan Instant payment debtor.street_name is not applicable \n- For SEPA, debtor.street_name is optional with max length 70"
          title: street_name
        building_number:
          maxLength: 16
          minLength: 1
          type: string
          description: "Debtor's building_number \n - For TH Instant payment debtor.building_number is not applicable \n - For US Instant payment debtor.building_number field is optional \n - For IN IMPS debtor.building_number field is optional \n - For UK FPS Instant payment debtor.building_number is not applicable \n - For IN UPI debtor.building_number field is optional \n - For US Wire payment, debtor.building_number field is conditional with max length 16. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, debtor.building_number field is mandatory when debtor.address_lines field is not provided and allowed max length is 16 \n- For SEPA IDP, debtor.building_number is optional with max length 16 \n - For Japan Instant payment debtor.building_number is not applicable \n- For SEPA, debtor.building_number is optional and allowed MaxLength is 16"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Debtor's postal_code \n - For TH Instant payment debtor.postal_code is not applicable \n - For US Instant payment debtor.postal_code field is optional \n - For IN IMPS debtor.postal_code is optional \n - For UK FPS Instant payment debtor.postal_code is not applicable \n - For IN UPI debtor.postal_code is optional \n - For US Wire, debtor.postal_code field is conditional with max length 16. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, debtor.postal_code field is mandatory when debtor.address_lines field is not provided and allowed max length is 16 \n- For SEPA IDP, debtor.postal_code is optional with max length 16 \n - For Japan Instant payment debtor.postal_code is not applicable \n- For SEPA, debtor.postal_code is optional with max length 16"
          title: postal_code
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's city \n - For TH Instant payment city is not applicable \n - For US Instant payment city field is optional \n - For IN IMPS debtor.city is optional \n - For UK FPS Instant payment debtor.city is not applicable \n - For IN UPI debtor.city is optional \n - For US Wire, debtor.city field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, debtor.city field is mandatory when debtor.address_lines field is not provided and allowed max length is 32 \n- For SEPA IDP, debtor.city is optional with max length 35 \n - For Japan Instant payment debtor.city is not applicable \n- For SEPA, debtor.city is optional with max length 35"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's State \n - For TH Instant payment debtor.state is not applicable \n - For US Instant payment debtor.state field is optional \n - For IN IMPS debtor.state is optional \n - For UK FPS Instant payment debtor.state is not applicable \n - For IN UPI debtor.state is optional  \n - For US Wire, debtor.state field is conditional with max length 35. If using structured address, (Street name, city, State, Postal Code and country) tags are required. \n - For US ACH CCD/PPD/IAT payment, debtor.state field is mandatory when debtor.address_lines field is not provided and allowed max length is 2 \n- For SEPA IDP, debtor.state is optional with max length 35 \n - For Japan Instant payment debtor.state is not applicable \n- For SEPA, debtor.state is optional with max length 35"
          title: state
        country:
          type: string
          description: "Debtor's Country \n - For TH Instant payment debtor.country is not applicable \n - For US Instant payment debtor.country field is optional \n - For IN IMPS debtor.country is optional \n - For UK FPS Instant payment debtor.country field is mandatory, if debtor.address_line is provided by client \n - For IN UPI debtor.country is optional \n - For US Wire, debtor.country field is mandatory with max length 2. \n - For US ACH CCD/PPD/IAT payment, debtor.country field is mandatory when debtor.address_lines field is not provided and allowed max length is 2 \n- For SEPA IDP, debtor.country is optional \n - For Japan Instant payment debtor.country is not applicable \n- For SEPA, debtor.country is optional"
          pattern: ^[A-Z]{2,2}$
          title: country
        org_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's org_id \n - For TH Instant payment debtor.org_id is not applicable \n - For US Instant payment debtor.org_id field is optional.Pattern should be followed [A-Z0-9]{18,18}[0-9]{2,2} where first 18 characters can be uppercase or numbers and the last two characters must be numeric \n - For IN IMPS debtor.org_id is not applicable \n - For UK FPS Instant payment debtor.org_id is not applicable \n - For IN UPI debtor.org_id is not applicable \n - For US Wire, debtor.org_id is not applicable \n - For US ACH CCD/PPD/IAT payments, debtor.org_id field is optional \n- For SEPA IDP, debtor.org_id is optional with max length 35 \n - For Japan Instant payment debtor.org_id is not applicable \n- For SEPA, debtor.org_id is optional with max length 35"
          title: org_id
        birth_date:
          type: string
          format: date
          description: "ISO 8601 (YYYY-MM-DD), Debtor's birth_date \n - For TH Instant payment debtor.birth_date is not applicable \n - For US Instant payment debtor.birth_date field is optional \n - For IN IMPS debtor.birth_date is not applicable \n - For UK FPS Instant payment debtor.birth_date is not applicable \n - For IN UPI debtor.birth_date is not applicable  \n - For US Wire, debtor.birth_date is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.birth_date field is not applicable \n - For SEPA IDP debtor.birth_date field is optional \n - For Japan Instant payment debtor.birth_date is not applicable \n - For SEPA, debtor.birth_date field is optional"
          title: birth_date
        birth_city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's birth_city \n - For TH Instant payment debtor.birth_city is not applicable \n - For US Instant payment debtor.birth_city field is optional \n - For IN IMPS debtor.birth_city is not applicable \n - For UK FPS Instant payment debtor.birth_city is not applicable \n - For IN UPI debtor.birth_city is not applicable  \n - For US Wire, debtor.birth_city is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.birth_city field is not applicable \n - For SEPA IDP debtor.birth_city field is optional with max length 35 \n - For Japan Instant payment debtor.birth_city is not applicable \n - For SEPA, debtor.birth_city field is optional with max length 35"
          title: birth_city
        birth_country:
          type: string
          description: "Debtor's birth_country \n - For TH Instant payment debtor.birth_country is not applicable \n - For US Instant payment debtor.birth_country field is optional \n - For IN IMPS debtor.birth_country is not applicable \n - For UK FPS Instant payment debtor.birth_country is not applicable \n - For IN UPI debtor.birth_country is not applicable \n - For US Wire, debtor.birth_country is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.birth_country field is not applicable \n - For SEPA IDP debtor.birth_country field is optional \n - For Japan Instant payment debtor.birth_country is not applicable \n - For SEPA, debtor.birth_country field is optional"
          pattern: ^[A-Z]{2,2}$
          title: birth_country
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor bank's network identification (e.g., routing number in the United States) \n - For TH Instant payment debtor.bank_id field is optional and allowed maxlength is 3 \n - For US Instant payment debtor.bank_id field is mandatory \n - For IN IMPS Instant payment debtor.bank_id field is mandatory and client should pass IFSC code (including branch code) \n - For UK FPS Instant payment debtor.bank_id field is optional and allowed maxlength is 11  \n - For IN UPI Instant payment debtor.bank_id field is mandatory with max length 11 \n - For US Wire, debtor.bank_id field is mandatory. Either BIC or MmbId must be provided. If the input is BIC, min and max length should be 8 and 11 and should adhere to pattern [A-Z]{6,6}[A-Z2-9][A-NP-Z0-9]([A-Z0-9]{3,3}){0,1}. If it is routing code, min and max length is 9. BIC is mandatory if branch 915 used, routing code should not use if branch 915 is used \n - For US ACH CCD/PPD/IAT payment, debtor.bank_id field is optional and allowed max length is 9. \n - For SEPA IDP debtor.bank_id field is mandatory with max length 11 \n - For SEPA IDP debtor.bank_id field is mandatory with max length 11 \n - For Japan Instant payment debtor.bank_id is optional \n - For SEPA,debtor.bank_id field is mandatory with max length 11"
          title: bank_id
        bank_branch_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor bank's branch network identification \n - For TH Instant payment debtor.bank_branch_id field is not applicable \n - For US Instant payment debtor.bank_branch_id field is not applicable \n - For UK Instant payment debtor.bank_branch_id field is not applicable \n - For JP Instant payment debtor.bank_branch_id is applicable \n - For IN IMPS Instant payment debtor.bank_branch_id field is not applicable \n - For IN UPI Instant payment debtor.bank_branch_id field is not applicable \n - For US Wire, debtor.bank_branch_id is not applicable \n - For Stripe_US ACH CCD/PPD/IAT payment, debtor.bank_branch_id is not applicable \n- For SEPA IDP, this field is not applicable \n- For SEPA, this field is not applicable"
          title: bank_branch_id
        mobile_number:
          maxLength: 34
          type: string
          pattern: ^[+]{1}[9]{1}[1]{1}[-][0-9]{10}$
          description: "Debtor's mobile number \n - For TH Instant payment debtor.mobile_number field is not applicable \n - For US Instant payment debtor.mobile_number field is not applicable \n - For IN IMPS debtor.mobile_number field is optional \n - For UK FPS Instant payment debtor.mobile_number is not applicable \n- For IN UPI debtor.mobile_number field is mandatory, if transaction.advice_type is SMSM \n - For US Wire, debtor.mobile_number is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.mobile_number field is not applicable \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment debtor.mobile_number is not applicable \n- For SEPA, this field is not applicable"
          title: mobile_number
        email_address:
          type: string
          maxLength: 2048
          minLength: 1
          description: Debtor's email address
          title: email_address
        prvt_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor's private id \n - For TH Instant payment debtor.prvt_id is not applicable \n - For US Instant payment debtor.prvt_id field is optional with max length 35.Either org_id or prvt_id or none of them should be passed by client \n - For IN IMPS debtor.prvt_id is not applicable \n - For UK FPS Instant payment debtor.prvt_id is not applicable \n - For IN UPI debtor.prvt_id is not applicable \n - For US Wire, debtor.prvt_id is not applicable \n - For US ACH CCD/PPD/IAT payments, debtor.prvt_id field is optional and applicable value is tax identification \n - For SEPA IDP debtor.prvt_id field is optional with max length 35 \n - For Japan Instant payment debtor.prvt_id is not applicable \n - For SEPA, debtor.prvt_id field is optional with max length 35"
          title: prvt_id
        bank_instructions:
          maxLength: 140
          minLength: 1
          type: string
          description: "instruction for debtor agent Indicator of the urgency of the payment to instructed party. \n- For Thailand PromptPay debtor.bank_instructions field is not applicable \n- For United States debtor.bank_instructions field is not applicble \n- For IN IMPS debtor.bank_instructions field is not applicable \n- For UK FPS Instant payment debtor.bank_instructions field is not applicable \n- For IN UPI debtor.bank_instructions field is not applicable \n - For US Wire, debtor.bank_instructions is an optional field with min 1 and max 35 characters . This fields is used to provide Bank to Bank details in the multiple occurrences of this tag. Further information related to the processing of the payment instruction that may need to be acted upon by the debtor agent, depending on agreement between debtor and the debtor agent. The following instructions to Citibank are supported: - /PREFORMAT/code/group - preformat code and group - /CONFIDENTIAL/ - confidential indicator - /REC/info - information to Citigroup operations - information without code word is interpreted as /REC/ \n - For US ACH CCD/PPD/IAT payment, debtor.bank_instructions field is optional, client want to do confidential transaction then the value should be /CONFIDENTIAL/ and client want to do Preformat transaction then the value should be /PREFORMAT/CODE/GROUP. \n- For SEPA IDP, this field is not applicable \n - For Japan Instant payment debtor.bank_instructions is not applicable \n- For SEPA, this field is not applicable"
          title: bank_instructions
        department:
          maxLength: 70
          minLength: 1
          type: string
          description: "Debtor Address Department \n - For TH Instant payment debtor.department is not applicable \n - For US Instant payment debtor.department is not applicable \n - For IN IMPS debtor.department is not applicable \n - For UK FPS Instant payment debtor.department is not applicable \n - For IN UPI debtor.department is not applicable \n - For US Wire, debtor.department is not applicable \n - For US ACH CCD/PPD payment, debtor.department is not applicable \n - For US ACH IAT payment, debtor.department is not applicable \n - For US ACH IAT payment, debtor.department is not applicable \n- For SEPA IDP, debtor.department is optional with max length 70 \n - For Japan Instant payment debtor.department is not applicable \n- For SEPA, debtor.department is optional with max length 70"
          title: department
        sub_department:
          maxLength: 70
          minLength: 1
          type: string
          description: "Debtor Address Sub-Department \n - For TH Instant payment debtor.sub_department is not applicable \n - For US Instant payment debtor.sub_department is not applicable \n - For IN IMPS debtor.sub_department is not applicable \n - For UK FPS Instant payment debtor.sub_department is not applicable \n - For IN UPI debtor.sub_department is not applicable \n - For US Wire, debtor.sub_department is not applicable \n - For US ACH CCD/PPD payment, debtor.sub_department is not applicable \n - For US ACH IAT payment, debtor.sub_department is not applicable \n - For US ACH IAT payment, debtor.sub_department is not applicable \n- For SEPA IDP, debtor.sub_department is optional with max length 70 \n - For Japan Instant payment debtor.sub_department is not applicable \n- For SEPA, debtor.sub_department is optional with max length 70"
          title: sub_department
        building_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor building name \n - For TH Instant payment debtor.building_name is not applicable \n - For US Instant payment debtor.building_name is not applicable \n - For IN IMPS debtor.building_name is not applicable \n - For UK FPS Instant payment debtor.building_name is not applicable \n - For IN UPI debtor.building_name is not applicable \n - For US Wire, debtor.building_name is not applicable \n - For US ACH CCD/PPD payment, debtor.building_name is not applicable \n - For US ACH IAT payment, debtor.building_name is not applicable \n - For US ACH IAT payment, debtor.building_name is not applicable \n- For SEPA IDP, debtor.building_name is optional with max length 35 \n - For Japan Instant payment debtor.building_name is not applicable \n- For SEPA, debtor.building_name is optional with max length 35"
          title: building_name
        floor:
          maxLength: 70
          minLength: 1
          type: string
          description: "Debtor address floor \n - For TH Instant payment debtor.floor is not applicable \n - For US Instant payment debtor.floor is not applicable \n - For IN IMPS debtor.floor is not applicable \n - For UK FPS Instant payment debtor.floor is not applicable \n - For IN UPI debtor.floor is not applicable \n - For US Wire, debtor.floor is not applicable \n - For US ACH CCD/PPD payment, debtor.floor is not applicable \n - For US ACH IAT payment, debtor.floor is not applicable \n - For US ACH IAT payment, debtor.floor is not applicable \n- For SEPA IDP, debtor.floor is optional with max length 70 \n - For Japan Instant payment debtor.floor is not applicable \n- For SEPA, debtor.floor is optional with max length 70"
          title: floor
        post_box:
          maxLength: 16
          minLength: 1
          type: string
          description: "Debtor address post box \n - For TH Instant payment debtor.post_box is not applicable \n - For US Instant payment debtor.post_box is not applicable \n - For IN IMPS debtor.post_box is not applicable \n - For UK FPS Instant payment debtor.post_box is not applicable \n - For IN UPI debtor.post_box is not applicable \n - For US Wire, debtor.post_box is not applicable \n - For US ACH CCD/PPD payment, debtor.post_box is not applicable \n - For US ACH IAT payment, debtor.post_box is not applicable \n - For US ACH IAT payment, debtor.post_box is not applicable \n- For SEPA IDP, debtor.post_box is optional with max length 16 \n - For Japan Instant payment debtor.post_box is not applicable \n- For SEPA, debtor.post_box is optional with max length 16"
          title: post_box
        room:
          maxLength: 70
          minLength: 1
          type: string
          description: "Debtor address room \n - For TH Instant payment debtor.room is not applicable \n - For US Instant payment debtor.room is not applicable \n - For IN IMPS debtor.room is not applicable \n - For UK FPS Instant payment debtor.room is not applicable \n - For IN UPI debtor.room is not applicable \n - For US Wire, debtor.room is not applicable \n - For US ACH CCD/PPD payment, debtor.room is not applicable \n - For US ACH IAT payment, debtor.room is not applicable \n - For US ACH IAT payment, debtor.room is not applicable \n- For SEPA IDP, debtor.room is optional with max length 70 \n - For Japan Instant payment debtor.room is not applicable \n- For SEPA, debtor.room is optional with max length 70"
          title: room
        town_location_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor address town location name \n - For TH Instant payment debtor.town_location_name is not applicable \n - For US Instant payment debtor.town_location_name is not applicable \n - For IN IMPS debtor.town_location_name is not applicable \n - For UK FPS Instant payment debtor.town_location_name is not applicable \n - For IN UPI debtor.town_location_name is not applicable \n - For US Wire, debtor.town_location_name is not applicable \n - For US ACH CCD/PPD payment, debtor.town_location_name is not applicable \n - For US ACH IAT payment, debtor.town_location_name is not applicable \n - For US ACH IAT payment, debtor.town_location_name is not applicable \n- For SEPA IDP, debtor.town_location_name is optional with max length 35 \n - For Japan Instant payment debtor.town_location_name is not applicable \n- For SEPA, debtor.town_location_name is optional with max length 35"
          title: town_location_name
        district_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor address district_name \n - For TH Instant payment debtor.district_name is not applicable \n - For US Instant payment debtor.district_name is not applicable \n - For IN IMPS debtor.district_name is not applicable \n - For UK FPS Instant payment debtor.district_name is not applicable \n - For IN UPI debtor.district_name is not applicable \n - For US Wire, debtor.district_name is not applicable \n - For US ACH CCD/PPD payment, debtor.district_name is not applicable \n - For US ACH IAT payment, debtor.district_name is not applicable \n - For US ACH IAT payment, debtor.district_name is not applicable \n- For SEPA IDP, debtor.district_name is optional with max length 35 \n - For Japan Instant payment debtor.district_name is not applicable \n- For SEPA, debtor.district_name is optional with max length 35"
          title: district_name
        anybic:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor BIC \n - For TH Instant payment debtor.anybic is not applicable \n - For US Instant payment debtor.anybic is not applicable \n - For IN IMPS debtor.anybic is not applicable \n - For UK FPS Instant payment debtor.anybic is not applicable \n - For IN UPI debtor.anybic is not applicable \n - For US Wire, debtor.anybic is not applicable \n - For US ACH CCD/PPD payment, debtor.anybic is not applicable \n - For US ACH IAT payment, debtor.anybic is not applicable \n - For US ACH IAT payment, debtor.anybic is not applicable \n- For SEPA IDP, debtor.anybic is optional with max length 11 \n - For Japan Instant payment debtor.anybic is not applicable \n- For SEPA, debtor.anybic is optional with max length 11"
          title: anybic
        lei:
          maxLength: 35
          minLength: 1
          type: string
          description: "Unique global identifier for legal entities participating in financial transactions \n - For TH Instant payment debtor.lei is not applicable \n - For US Instant payment debtor.lei is not applicable \n - For IN IMPS debtor.lei is not applicable \n - For UK FPS Instant payment debtor.lei is not applicable \n - For IN UPI debtor.lei is not applicable \n - For US Wire, debtor.lei is not applicable \n - For US ACH CCD/PPD payment, debtor.lei is not applicable \n - For US ACH IAT payment, debtor.lei is not applicable \n - For US ACH IAT payment, debtor.lei is not applicable \n- For SEPA IDP, debtor.lei is optional with max length 20 \n - For Japan Instant payment debtor.lei is not applicable \n- For SEPA, debtor.lei is optional with max length 20"
          title: lei
        issuer:
          maxLength: 35
          minLength: 1
          type: string
          description: "Debtor name that identifies an issuer \n - For TH Instant payment debtor.issuer is not applicable \n - For US Instant payment debtor.issuer is not applicable \n - For IN IMPS debtor.issuer is not applicable \n - For UK FPS Instant payment debtor.issuer is not applicable \n - For IN UPI debtor.issuer is not applicable \n - For US Wire, debtor.issuer is not applicable \n - For US ACH CCD/PPD payment, debtor.issuer is not applicable \n - For US ACH IAT payment, debtor.issuer is not applicable \n - For US ACH IAT payment, debtor.issuer is not applicable \n- For SEPA IDP, debtor.issuer is optional with max length 35 \n - For Japan Instant payment debtor.issuer is not applicable \n- For SEPA, debtor.issuer is optional with max length 35"
          title: issuer
        birth_province:
          maxLength: 35
          minLength: 1
          type: string
          description: " Debtor Province Of Birth \n - For TH Instant payment debtor.birth_province is not applicable \n - For US Instant payment debtor.birth_province is not applicable \n - For IN IMPS debtor.birth_province is not applicable \n - For UK FPS Instant payment debtor.birth_province is not applicable \n - For IN UPI debtor.birth_province is not applicable \n - For US Wire, debtor.birth_province is not applicable \n - For US ACH CCD/PPD payment, debtor.birth_province is not applicable \n - For US ACH IAT payment, debtor.birth_province is not applicable \n - For US ACH IAT payment, debtor.birth_province is not applicable \n- For SEPA IDP, debtor.birth_province is optional with max length 35 \n - For Japan Instant payment debtor.birth_province is not applicable \n- For SEPA, debtor.birth_province is optional with max length 35"
          title: birth_province
        bank_account:
          maxLength: 40
          minLength: 1
          type: string
          description: "Debtor's bank account number \n - For TH, US , IN IMPS, UK FPS, IN UPI, US Wire, US ACH CCD/PPD/IAT,SEPA,SEPA IDP and JP payments debtor.bank_account is not applicable \n - For India FIR IMPS payment, debtor.bank_account field is mandatory"
          title: bank_account
        bank_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Debtor's bank name \n - For TH Instant payment debtor.bank_name is not applicable \n - For US Instant payment debtor.bank_name is not applicable \n - For IN IMPS Instant payment debtor.bank_name is not applicable \n - For UK FPS Instant payment debtor.bank_name is not applicable \n - For IN UPI Instant payment debtor.bank_name is not applicable \n - For US Wire payment, debtor.bank_name is not applicable \n - For US ACH CCD/PPD/IAT payment, debtor.bank_name is optional with max length 35 \n - For SEPA IDP debtor.bank_name is not applicable \n - For Japan Instant payment debtor.bank_name is not applicable \n - For India FIR IMPS payment, debtor.bank_name is mandatory with max length 100 \n - For SEPA, debtor.bank_name is not applicable"
          title: bank_name
        scheme_name:
          maxLength: 128
          minLength: 1
          type: string
          description: Debtor's scheme name
          title: scheme_name
        contact_details:
          maxLength: 35
          minLength: 1
          type: string
          description: Debtor's Other contact details
          title: contact_details
      additionalProperties: false
      description: Debtor information
    Iso-Normalised-Date-Time:
      type: string
      format: date-time
      description: an ISODateTime whereby all timezoned dateTime values are UTC.
      title: IsoNormalisedDateTime
    Address:
      type: string
      maxLength: 70
      minLength: 1
      maxItems: 7
      description: Address
      title: Address
    Exchange:
      type: object
      title: exchange
      properties:
        exchange_rate:
          type: number
          format: double
          description: Exchange rate between two currencies
          title: exchange_rate
        equivalent_amount:
          type: number
          description: The equivalent amount in a target currency based on a specified amount in a source currency
          title: equivalent_amount
        equivalent_amount_currency_transfer:
          type: string
          description: Currency in which the transaction amount is expressed
          title: equivalent_amount_currency_transfer
        equivalent_amount_currency:
          type: string
          description: Currency applicable to the equivalent or converted amount
          title: equivalent_amount_currency
    Initiating-Party-Status:
      type: object
      title: InitiatingPartyStatus
      properties:
        name:
          maxLength: 140
          minLength: 1
          type: string
          description: Initiating Party's name where participant owns the account that the OBO Payments are sent from and the Participant’s customer is an Initiating Customer that transmits payment instructions but is not in the funds flow
          title: name
        id:
          maxLength: 35
          minLength: 1
          type: string
          description: Initiating Party's identification where participant owns the account that the OBO Payments are sent from and the Participant’s customer is an Initiating Customer that transmits payment instructions but is not in the funds flow
          title: id
    Payment-Initiation-Request:
      type: object
      title: PaymentInitiationRequest
      required:
      - debtor
      - creditor
      - method
      - transaction
      properties:
        debtor:
          $ref: '#/components/schemas/Debtor-Initiation'
        ultimate_debtor:
          $ref: '#/components/schemas/Ultimate-Debtor-Initiation'
        creditor:
          $ref: '#/components/schemas/Creditor-Initiation'
        ultimate_creditor:
          $ref: '#/components/schemas/Ultimate-Creditor-Initiation'
        intermediary:
          $ref: '#/components/schemas/Intermediary-Initiation'
        instructing_agent:
          $ref: '#/components/schemas/Instructing-Agent-Initiation'
        method:
          $ref: '#/components/schemas/Method-Initiation'
        transaction:
          $ref: '#/components/schemas/Transaction-Initiation'
      additionalProperties: false
      description: "Payment initiation (acceptance) request \n\n For UK FPS payment, only the below set of character supported \n - A to Z (uppercase) \n - a to z (lowercase) \n - 0 to 9 \n -  / (forward slash), - (minus sign), ? (question mark), : (colon), ( (left parenthesis), ) (right parenthesis), . (point), , (comma), ’(right single quote), + (plus sign), SPACE, # (hash), = (equals), ! (exclamation mark), ” (right double quote), % (percentage), & (ampersand), * (asterisk), < (less than), > (greater than), ; (semi colon), { (left curly bracket), @ (commercial at), CrLf (carriage return line feed) \n - Fixed length numeric fields are right justified with leading zeros \n - Fixed length alphanumeric fields are left justified with trailing spaces \n - Fixed length binary fields are left justified with trailing zeros \n - } (right curly bracket) is not supported"
    Method-Status:
      type: object
      title: MethodStatus
      required:
      - country
      - instructed_currency
      - method
      - type
      properties:
        country:
          description: ISO 3166 Alpha-2 code for the transaction country
          type: string
          enum:
          - TH
          - US
          - IN
          - GB
          - JP
          - IE
          - DE
          - AT
          - BE
          - FI
          - FR
          - GR
          - IT
          - LU
          - NL
          - PT
          - ES
          - SK
          - AU
          - BG
          - MX
          - RS
          - AR
          - HU
          - HK
          - BR
          - BG
          title: country
        instructed_currency:
          type: string
          description: ISO 4217 code for the transaction instructed amount currency
          enum:
          - THB
          - USD
          - INR
          - GBP
          - JPY
          - EUR
          - AUD
          - MXN
          - ARS
          - HUF
          - BRL
          - HKD
          - CNY
          title: instructed_currency
        method:
          description: "Method specified by the debtor for the transaction \n- Provide IP for instant payment \n- For India provide either IMPS or UPI \n - Provide WIRE for US Wire"
          type: string
          enum:
          - IP
          - IMPS
          - UPI
          - WIRE
          - ACH
          - NEFT
          - BKT
          title: method
        type:
          type: string
          description: "Transaction message type (e.g., CT for credit transfer. RF for Refund) \n- BK_CT - Book to Book Credit Transfer \n- BK_RF - Book to Book Return Payment"
          enum:
          - CT
          - RF
          - BK_CT
          - BK_RF
          title: type
        network:
          type: string
          enum:
          - PromptPay
          - RTP
          - FPS
          - IMPS
          - UPI
          - ZENGIN
          - RT1
          - TIPS
          - FDN
          - INNEFT
          - NPP
          - PIX
          - COELSA
          - BOOK
          - GIRO
          description: Financial market infrastructure or clearing system (e.g., RTP Network in the United States)
          title: network
    Error-Detail:
      type: object
      title: ErrorDetail
      xml:
        name: Errordetail
      properties:
        issue:
          xml:
            name: issue
          type: string
          maxLength: 200
          description: more details about the issue
          title: issue
        action:
          xml:
            name: action
          type: string
          maxLength: 350
          description: corrective action to be taken to resolve above issue
          title: action
        code:
          xml:
            name: code
          type: string
          maxLength: 8
          description: unique code representing the issue
          title: code
    Payments-Response:
      type: array
      items:
        $ref: '#/components/schemas/Payments'
      maxItems: 1000
    contact-details:
      type: object
      title: contact_details
      properties:
        mobile_number:
          maxLength: 35
          minLength: 1
          type: string
          description: Creditor's Contact Details - Mobile Number
          title: mobile_number
        email_address:
          type: string
          maxLength: 2048
          minLength: 1
          description: Creditor's Contact Details - Email Address
          title: email_address
        other:
          type: string
          maxLength: 35
          minLength: 1
          description: Creditor's Contact Other Details
          title: other
    Instructing-Agent-Status:
      type: object
      title: InstructingAgent
      properties:
        bank_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Instructing Agent/Debtor Agent member Identification ID or BIC of a clearing system. \n - For TH Instant payment instructing_agent.bank_id field is not applicable \n - For US Instant payment instructing_agent.bank_id field is not applicable \n - For IN IMPS Instant payment instructing_agent.bank_id field is not applicable  \n - For UK FPS Instant payment instructing_agent.bank_id field is not applicable \n - For IN UPI Instant payment instructing_agent.bank_id field is not applicable \n - For US Wire, instructing_agent.bank_id is not applicable \n - For US ACH CCD/PPD payment, instructing_agent.bank_id is not applicable \n - For US ACH IAT payment, instructing_agent.bank_id is not applicable \n - For SEPA IDP instructing_agent.bank_id field is mandatory with max length 11 \n - For Japan Instant payment instructing_agent.bank_id field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.bank_id field is optional and allowed length is 11 \n - For SEPA, instructing_agent.bank_id field is mandatory with max length 11"
          title: bank_id
        bank_name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Instructing Agent name. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT, SEPA, SEPA IDP and JP payment instructing_agent.bank_name field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.bank_name field is mandatory, if client provided instructing_agent.bank_id and allowed max length is 100"
          title: bank_name
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Instructing Agent street name. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT, SEPA, SEPA IDP and JP payment instructing_agent.street_name field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.street_name field is mandatory, if client provided instructing_agent.bank_id and allowed max length is 35"
          title: street_name
        building_number:
          maxLength: 35
          minLength: 1
          type: string
          description: "Instructing Agent building number. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT, SEPA, SEPA IDP and JP payment instructing_agent.building_number field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.building_number field is mandatory, if client provided instructing_agent.bank_id and allowed max length is 16"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Instructing Agent postal code. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT, SEPA, SEPA IDP and JP payment instructing_agent.postal_code field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.postal_code field is mandatory, if client provided instructing_agent.bank_id"
          title: postal_code
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Instructing Agent city. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT, SEPA, SEPA IDP and JP payment instructing_agent.city field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.city field is mandatory, if client provided instructing_agent.bank_id"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Instructing Agent state. \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT, SEPA, SEPA IDP and JP payment instructing_agent.state field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.state field is mandatory, if client provided instructing_agent.bank_id"
          title: state
        country:
          type: string
          description: "Instructing Agent country \n - For TH, US, India IMPS, UK FPS, IN UPI, Stripe US - Wire, Stripe US- ACH CCD/PPD/IAT, SEPA, SEPA IDP and JP payment instructing_agent.country field is not applicable \n - For India FIR IMPS Instant payment instructing_agent.country field is mandatory, if client provided instructing_agent.bank_id"
          pattern: ^[A-Z]{2,2}$
          title: country
    Intermediary-Status:
      title: IntermediaryStatus
      description: Intermediary agent information status
      type: array
      maxItems: 3
      items:
        $ref: '#/components/schemas/Intermediary-Details-Status'
    Reason:
      type: object
      title: Reason
      properties:
        code:
          type: string
          description: "Reason codes (e.g., AM03,AM02,AC02,CH03,CH04,CH20,CH21,BE23,NARR and etc.) \n- refer to validation_code_description excel file for complete list of response codes and descriptions"
          title: code
        description:
          type: string
          description: "Reason code description (e.g., \n- AM03 -Method instructed currency is invalid (not in ISO 4217 format or value) \n- AM02 -Instructed amount is not ≥ 0.01 & ≤ 2,000,000.00.\n- AC02 -Debtor account is invalid \n- CH03 -Value date is in the future \n- CH04 -Value date is in the past \n- CH20 -Value-added tax (VAT) amount format is invalid \n- CH21 -Bill identification 1 is mandatory for a bill payment,Bill identification 2 and 3 are conditional for a bill payment \n- BE23 -Creditor mobile number (proxy identification) format is invalid \n- NARR -Creditor name maximum length is 50 )\n- refer to validation_code_description excel file for complete list of response codes and descriptions"
          title: description
        non_iso_code:
          maxLength: 4
          minLength: 1
          type: string
          description: "Reason local Clearing codes (e.g.0000,0080,0081,0082,0083,0084,1100 and etc.).Additional status code received from the local clearing which does not follow ISO standards but will on some occasions provide additional insights. Codes will vary by country (where applicable) and will be published on our developer portal \n- For UK it is an optional field with max length 4 \n- For SEPA IDP it is an optional field \n- For US, this field is optional \n- For SEPA, it is an optional field"
          title: non_iso_code
    Ultimate-Creditor-Initiation:
      type: object
      title: UltimateCreditorInitiation
      properties:
        name:
          maxLength: 140
          minLength: 1
          type: string
          description: "Ultimate Creditor's bank account name \n - For TH Instant payment ultimate_creditor.name is not applicable \n - For US Instant payment ultimate_creditor.name is optional \n - For IN IMPS ultimate_creditor.name is not applicable \n - For UK FPS Instant payment ultimate_creditor.name field is optional with max length 140 \n - For IN UPI ultimate_creditor.name is not applicable \n - US Wire, ultimate_creditor.name is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.name field is mandatory and allowed max length is 22 \n - For US ACH IAT payment, ultimate_creditor.name field is mandatory and allowed max length is 35 \n - For Japan Instant payment ultimate_creditor.name field is not applicable \n - For SEPA, ultimate_creditor.name field is optional and allowed maxLength is 70"
          title: name
        address_lines:
          type: array
          description: "Ultimate Creditor's address_lines \n - For TH Instant payment ultimate_creditor.address_lines is not applicable \n - For US Instant payment ultimate_creditor.address_lines is optional \n - For IN IMPS ultimate_creditor.address_lines is not applicable \n - For UK FPS Instant payment ultimate_creditor.address_lines field is optional \n - For IN UPI ultimate_creditor.address_lines is not applicable \n - For US Wire, ultimate_creditor.address_lines is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.address_lines field is not applicable \n - For SEPA, Japan Instant payment ultimate_creditor.address_lines field is not applicable"
          items:
            $ref: '#/components/schemas/Address'
          title: address_lines
        street_name:
          maxLength: 70
          minLength: 1
          type: string
          description: "Ultimate Creditor's street_name \n - For TH Instant payment ultimate_creditor.street_name is not applicable \n - For US Instant payment ultimate_creditor.street_name is optional \n - For IN IMPS ultimate_creditor.street_name is not applicable \n - For UK FPS Instant payment ultimate_creditor.street_name field is optional with max length 70 \n - For IN UPI ultimate_creditor.street_name is not applicable \n - For US Wire, ultimate_creditor.street_name is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.street_name field is not applicable \n - For SEPA, Japan Instant payment ultimate_creditor.street_name field is not applicable"
          title: street_name
        building_number:
          maxLength: 16
          minLength: 1
          type: string
          description: "Ultimate Creditor's building_number \n - For TH Instant payment ultimate_creditor.building_number is not applicable \n - For US Instant payment ultimate_creditor.building_number field is optional \n - For IN IMPS ultimate_creditor.building_number is not applicable \n - For UK FPS Instant payment ultimate_creditor.building_number field is optional with max length 16 \n - For IN UPI ultimate_creditor.building_number is not applicable \n - For US Wire, ultimate_creditor.building_number is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.building_number field is not applicable \n - For SEPA, Japan Instant payment ultimate_creditor.building_number field is not applicable"
          title: building_number
        postal_code:
          maxLength: 16
          minLength: 1
          type: string
          description: "Ultimate Creditor's postal_code \n - For TH Instant payment ultimate_creditor.postal_code is not applicable \n - For US Instant payment ultimate_creditor.postal_code field is optional \n - For IN IMPS ultimate_creditor.postal_code is not applicable \n - For UK FPS Instant payment ultimate_creditor.postal_code field is optional with max length 16 \n - For IN UPI ultimate_creditor.postal_code is not applicable \n - For US Wire, ultimate_creditor.postal_code is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.postal_code field is not applicable \n - For SEPA, Japan Instant payment ultimate_creditor.postal_code field is not applicable"
          title: postal_code
        city:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Creditor's city \n - For TH Instant payment ultimate_creditor.city is not applicable \n - For US Instant payment ultimate_creditor.city field is optional \n - For IN IMPS ultimate_creditor.city is not applicable \n - For UK FPS Instant payment ultimate_creditor.city field is optional with max length 35 \n - For IN UPI ultimate_creditor.city is not applicable \n - For US Wire, ultimate_creditor.city is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.city field is not applicable \n - For SEPA, Japan Instant payment ultimate_creditor.city field is not applicable"
          title: city
        state:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Creditor's state \n - For TH Instant payment ultimate_creditor.state is not applicable \n - For US Instant payment ultimate_creditor.state field is optional \n - For IN IMPS ultimate_creditor.state is not applicable  \n - For UK FPS Instant payment ultimate_creditor.state field is optional with max length 35 \n - For IN UPI ultimate_creditor.state is not applicable \n - For US Wire, ultimate_creditor.state is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.state field is not applicable \n - For SEPA, Japan Instant payment ultimate_creditor.state field is not applicable"
          title: state
        country:
          type: string
          description: "Ultimate Creditor's country \n - For TH Instant payment ultimate_creditor.country is not applicable \n - For US Instant payment ultimate_creditor.country field is optional \n - For IN IMPS ultimate_creditor.country is not applicable \n - For UK FPS Instant payment ultimate_creditor.country field is optional\n - For IN UPI ultimate_creditor.country is not applicable \n - For US Wire, ultimate_creditor.country is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.country field is not applicable \n - For SEPA, Japan Instant payment ultimate_creditor.country field is not applicable"
          pattern: ^[A-Z]{2,2}$
          title: country
        org_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Creditor's org_id \n - For TH Instant payment ultimate_creditor.org_id is not applicable \n - For US Instant payment ultimate_creditor.org_id field is optional with max length 20.Pattern should be followed [A-Z0-9]{18,18}[0-9]{2,2} where first 18 characters can be uppercase or numbers and the last two characters must be numeric \n - For IN IMPS ultimate_creditor.org_id is not applicable \n - For UK FPS Instant payment ultimate_creditor.org_id field is optional with max length 35 \n - For IN UPI ultimate_creditor.org_id is not applicable \n - US Wire, ultimate_creditor.org_id is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.org_id field is not applicable \n - For Japan Instant payment ultimate_creditor.org_id field is not applicable \n - For SEPA, ultimate_creditor.org_id field is conditional optional with either ultimate_creditor.org_id or ultimate_creditor.prvt_id or combination of ultimate_creditor.birth_date/birth_city/birth_country should be populated"
          title: org_id
        prvt_id:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Creditor's private id \n - For TH Instant payment ultimate_creditor.prvt_id is not applicable \n - For US Instant payment ultimate_creditor.prvt_id field is optional with max length 35.Either org_id or prvt_id or none of them should be passed by client \n - For IN IMPS ultimate_creditor.prvt_id is not applicable \n - For UK FPS Instant payment ultimate_creditor.prvt_id is not applicable \n - For IN UPI ultimate_creditor.prvt_id is not applicable \n - US Wire, ultimate_creditor.prvt_id is not applicable \n - For US ACH CCD/PPD/IAT payment, ultimate_creditor.prvt_id field is not applicable \n - For Japan Instant payment ultimate_creditor.prvt_id field is not applicable \n - For SEPA, ultimate_creditor.prvt_id field is conditinal optional with either ultimate_creditor.org_id or ultimate_creditor.prvt_id or combination of ultimate_creditor.brith_date/birth_city/birth_country should be populated"
          title: prvt_id
        anybic:
          maxLength: 16
          minLength: 1
          type: string
          description: "Ultimate Creditor's anybic \n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.anybic is not applicable \n - For SEPA, ultimate_creditor.anybic field is optional with max length 16"
          title: anybic
        lei:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Creditor's lei \n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.lei is not applicable \n - For SEPA, ultimate_creditor.lei field is optional with max length 20"
          title: lei
        scheme_name:
          maxLength: 128
          minLength: 1
          type: string
          description: "Ultimate Creditor's scheme \n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.scheme_name is not applicable \n - For SEPA, ultimate_creditor.scheme_name field is optional with max length as 35"
          title: scheme_name
        issuer:
          maxLength: 35
          minLength: 1
          type: string
          description: "Ultimate Creditor's issuer \n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.scheme_issuer is not applicable \n - For SEPA, ultimate_creditor.issuer field is optional with max length as 35"
          title: issuer
        birth_date:
          type: string
          format: date
          description: "\n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.birth_date is not applicable \n - For SEPA, ultimate_creditor.birth_date field is conditional mandatory with date on which the person is born"
          title: birth_date
        birth_province:
          maxLength: 35
          minLength: 1
          type: string
          description: "\n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.birth_province is not applicable \n - For SEPA, ultimate_creditor.birth_province field is optinal with maxLength as 35"
          title: birth_province
        birth_city:
          maxLength: 35
          minLength: 1
          type: string
          description: "\n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.birth_city is not applicable \n - For SEPA, ultimate_creditor.birth_city field is conditional mandatory with city in which the person is born"
          title: birth_city
        birth_country:
          type: string
          description: "\n - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.birth_country is not applicable \n - For SEPA, ultimate_creditor.birth_country field is conditional mandatory with country in which the person is born"
          pattern: ^[A-Z]{2,2}$
          title: birth_country
        department:
          maxLength: 70
          minLength: 1
          type: string
          description: "ultimate creditor's Address Department \n - For TH Instant payment ultimate_creditor.department is not applicable \n - For US Instant payment ultimate_creditor.department is not applicable \n - For IN IMPS ultimate_creditor.department is not applicable \n - For UK FPS Instant payment ultimate_creditor.department is not applicable \n - For IN UPI ultimate_creditor.department is not applicable \n - For US Wire, ultimate_creditor.department is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.department is not applicable \n - For US ACH IAT payment, ultimate_creditor.department is not applicable \n - For US ACH IAT payment, ultimate_creditor.department is not applicable \n- For SEPA IDP, ultimate_creditor.department is optional with max length 70 \n - For Japan Instant payment ultimate_creditor.department field is not applicable \n- For SEPA, ultimate_creditor.department is optional with max length 70"
          title: department
        sub_department:
          maxLength: 70
          minLength: 1
          type: string
          description: "ultimate creditor's Address Sub-Department \n - For TH Instant payment ultimate_creditor.sub_department is not applicable \n - For US Instant payment ultimate_creditor.sub_department is not applicable \n - For IN IMPS ultimate_creditor.sub_department is not applicable \n - For UK FPS Instant payment ultimate_creditor.sub_department is not applicable \n - For IN UPI ultimate_creditor.sub_department is not applicable \n - For US Wire, ultimate_creditor.sub_department is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.sub_department is not applicable \n - For US ACH IAT payment, ultimate_creditor.sub_department is not applicable \n - For US ACH IAT payment, ultimate_creditor.sub_department is not applicable \n- For SEPA IDP, ultimate_creditor.sub_department is optional with max length 70 \n - For Japan Instant payment ultimate_creditor.sub_department field is not applicable \n- For SEPA, ultimate_creditor.sub_department is optional with max length 70"
          title: sub_department
        building_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "ultimate creditor's building name \n - For TH Instant payment ultimate_creditor.building_name is not applicable \n - For US Instant payment ultimate_creditor.building_name is not applicable \n - For IN IMPS ultimate_creditor.building_name is not applicable \n - For UK FPS Instant payment ultimate_creditor.building_name is not applicable \n - For IN UPI ultimate_creditor.building_name is not applicable \n - For US Wire, ultimate_creditor.building_name is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.building_name is not applicable \n - For US ACH IAT payment, ultimate_creditor.building_name is not applicable \n - For US ACH IAT payment, ultimate_creditor.building_name is not applicable \n- For SEPA IDP, ultimate_creditor.building_name is optional with max length 35 \n - For Japan Instant payment ultimate_creditor.building_name field is not applicable \n- For SEPA, ultimate_creditor.building_name is optional with max length 35"
          title: building_name
        floor:
          maxLength: 70
          minLength: 1
          type: string
          description: "ultimate creditor's address floor \n - For TH Instant payment ultimate_creditor.floor is not applicable \n - For US Instant payment ultimate_creditor.floor is not applicable \n - For IN IMPS ultimate_creditor.floor is not applicable \n - For UK FPS Instant payment ultimate_creditor.floor is not applicable \n - For IN UPI ultimate_creditor.floor is not applicable \n - For US Wire, ultimate_creditor.floor is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.floor is not applicable \n - For US ACH IAT payment, ultimate_creditor.floor is not applicable \n - For US ACH IAT payment, ultimate_creditor.floor is not applicable \n- For SEPA IDP, ultimate_creditor.floor is optional with max length 70 \n - For Japan Instant payment ultimate_creditor.floor field is not applicable \n- For SEPA, ultimate_creditor.floor is optional with max length 70"
          title: floor
        post_box:
          maxLength: 16
          minLength: 1
          type: string
          description: "ultimate creditor's address post box \n - For TH Instant payment ultimate_creditor.post_box is not applicable \n - For US Instant payment ultimate_creditor.post_box is not applicable \n - For IN IMPS ultimate_creditor.post_box is not applicable \n - For UK FPS Instant payment ultimate_creditor.post_box is not applicable \n - For IN UPI ultimate_creditor.post_box is not applicable \n - For US Wire, ultimate_creditor.post_box is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.post_box is not applicable \n - For US ACH IAT payment, ultimate_creditor.post_box is not applicable \n - For US ACH IAT payment, ultimate_creditor.post_box is not applicable \n- For SEPA IDP, ultimate_creditor.post_box is optional with max length 16 \n - For Japan Instant payment ultimate_creditor.post_box field is not applicable \n- For SEPA, ultimate_creditor.post_box is optional with max length 16"
          title: post_box
        room:
          maxLength: 70
          minLength: 1
          type: string
          description: "ultimate creditor's address room \n - For TH Instant payment ultimate_creditor.room is not applicable \n - For US Instant payment ultimate_creditor.room is not applicable \n - For IN IMPS ultimate_creditor.room is not applicable \n - For UK FPS Instant payment ultimate_creditor.room is not applicable \n - For IN UPI ultimate_creditor.room is not applicable \n - For US Wire, ultimate_creditor.room is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.room is not applicable \n - For US ACH IAT payment, ultimate_creditor.room is not applicable \n - For US ACH IAT payment, ultimate_creditor.room is not applicable \n- For SEPA IDP, ultimate_creditor.room is optional with max length 70 \n - For Japan Instant payment ultimate_creditor.room field is not applicable \n- For SEPA, ultimate_creditor.room is optional with max length 70"
          title: room
        town_location_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "ultimate creditor's address town location name \n - For TH Instant payment ultimate_creditor.town_location_name is not applicable \n - For US Instant payment ultimate_creditor.town_location_name is not applicable \n - For IN IMPS ultimate_creditor.town_location_name is not applicable \n - For UK FPS Instant payment ultimate_creditor.town_location_name is not applicable \n - For IN UPI ultimate_creditor.town_location_name is not applicable \n - For US Wire, ultimate_creditor.town_location_name is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.town_location_name is not applicable \n - For US ACH IAT payment, ultimate_creditor.town_location_name is not applicable \n - For US ACH IAT payment, ultimate_creditor.town_location_name is not applicable \n- For SEPA IDP, ultimate_creditor.town_location_name is optional with max length 35 \n - For Japan Instant payment ultimate_creditor.town_location_name field is not applicable \n- For SEPA, ultimate_creditor.town_location_name is optional with max length 35"
          title: town_location_name
        district_name:
          maxLength: 35
          minLength: 1
          type: string
          description: "ultimate creditor's address district_name \n - For TH Instant payment ultimate_creditor.district_name is not applicable \n - For US Instant payment ultimate_creditor.district_name is not applicable \n - For IN IMPS ultimate_creditor.district_name is not applicable \n - For UK FPS Instant payment ultimate_creditor.district_name is not applicable \n - For IN UPI ultimate_creditor.district_name is not applicable \n - For US Wire, ultimate_creditor.district_name is not applicable \n - For US ACH CCD/PPD payment, ultimate_creditor.district_name is not applicable \n - For US ACH IAT payment, ultimate_creditor.district_name is not applicable \n - For US ACH IAT payment, ultimate_creditor.district_name is not applicable \n- For SEPA IDP, ultimate_creditor.district_name is optional with max length 35 \n - For Japan Instant payment ultimate_creditor.district_name field is not applicable \n- For SEPA, ultimate_creditor.district_name is optional with max length 35"
          title: district_name
      additionalProperties: false
      description: Ultimate Creditor information
    Status:
      type: object
      title: Status
      properties:
        date_time:
          type: string
          format: date-time
          description: "GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Date time of transaction status"
          title: date_time
        code:
          type: string
          description: ISO 20022 transaction status code
          enum:
          - ACTC
          - PDNG
          - RJCT
          - ACCC
          - ACWP
          - ACCP
          - ACSP
          title: code
        description:
          type: string
          description: "Status code description \n- ACTC - Accepted \n- ACCC - Completed \n- PDNG - Pending \n- RJCT - Rejected (only in case of US incoming returns - 'Returned') \n- ACWP - AcceptedWithoutPosting (Applicable for US country) \n- ACCP - Accepted (Applicable for UK BACS - ACH) \n- ACSP - Accepted, Settlement in progress (Applicable for UK BACS - ACH)"
          title: description
        refund_status:
          type: string
          description: Refund Status P - Partial Refund F - Full Refund
          enum:
          - P
          - F
          title: refund_status
    PaymentType:
      title: PaymentType
      type: string
      description: "Specify the payment type you want Citi to process on behalf of the PSU.\n\nEach Citi instance may support a different set of payment types depending on the local standards and schemes enabled.\n\nFor example,\n\n  - global-payment (Single Instant Payment, Multi Payment - Fixed and Variable Recurring Payment, Future Dated Payment etc)\n"
    GlobalActiveOrHistoricAmount:
      title: GlobalActiveOrHistoricAmount
      description: Provide the payment amount as a decimal number compliant with ISO 4217, formatted to two decimal places, so Citi can validate and process the exact instructed value.
      type: string
      pattern: ^\d{1,16}\.\d{2}$
      example: '100.00'
    PaymentRequest:
      description: Provide the core payment instruction details — including execution date, amount, currency, and counterparty information — that Citi requires to execute the payment on the PSU's behalf.
      type: object
      additionalProperties: false
      required:
      - requestedExecutionDate
      - instruction
      - personalIdentifiableInformation
      - paymentPurposeCode
      - paymentDetails
      - creditorIndicators
      properties:
        requestedExecutionDate:
          $ref: '#/components/schemas/GlobalRequestedExecutionDate'
        instructionPriority:
          description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
          type: string
          enum:
          - NORMAL
          - URGENT
        chargeBearer:
          $ref: '#/components/schemas/GlobalChargeBearerType1Code'
        instruction:
          type: object
          additionalProperties: false
          required:
          - amount
          description: The Initiation payload is sent by the initiating party to the LFI. It is used to request movement of funds from the debtor account to a creditor for a single payment.
          properties:
            amount:
              description: The Currency and Amount relating to the Payment
              type: object
              required:
              - amount
              - currency
              properties:
                amount:
                  $ref: '#/components/schemas/GlobalActiveOrHistoricAmount'
                currency:
                  $ref: '#/components/schemas/GlobalActiveOrHistoricCurrencyCode'
        currencyRequest:
          description: The details of the non-local currency or FX request that has been agreed between the User and the TPP. The requested ChargeBearer and ExchangeRateInformation are included in this object may be overwritten by the LFI in the returned Consent object.
          type: object
          additionalProperties: false
          required:
          - currencyOfTransfer
          properties:
            currencyOfTransfer:
              description: Specifies the currency to be transferred amount, which is different from the currency of the debtor's account.
              type: string
              pattern: ^[A-Z]{3,3}$
            destinationCountryCode:
              description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
              type: string
              pattern: '[A-Z]{2,2}'
            exchangeRateInformation:
              type: object
              additionalProperties: false
              required:
              - unitCurrency
              - rateType
              description: Provides details on the currency exchange rate and contract.
              properties:
                unitCurrency:
                  description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                exchangeRate:
                  description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
                  type: number
                rateType:
                  description: Specifies the type used to complete the currency exchange.
                  type: string
                  enum:
                  - ACTUAL
                  - AGREED
                  - INDICATIVE
                contractIdentification:
                  description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
                  type: string
                  minLength: 1
                  maxLength: 256
        fxQuoteId:
          $ref: '#/components/schemas/FxQuoteId'
        personalIdentifiableInformation:
          description: 'Personal Identifiable Information, represented in both encoded and decoded form using a `anyOf`, to help implementers readily understand both the structure and serialized form of the property. Schema Objects are provided for both Domestic and International payments.


            **Implementations MUST reflect the GlobalJWEPaymentPII Schema Object structure and the notes provided on** **implementing a JWS and JWE.**


            **The decoded form GlobalPaymentPII is for guidance on content only.**'
          anyOf:
          - $ref: '#/components/schemas/GlobalBankServiceInitiation.GlobalDomesticPaymentPIIProperties'
          - $ref: '#/components/schemas/GlobalBankServiceInitiation.GlobalInternationalPaymentPIIProperties'
        paymentPurposeCode:
          $ref: '#/components/schemas/GlobalPaymentPurposeCode'
        debtorReference:
          $ref: '#/components/schemas/GlobalDebtorReference'
        creditorReference:
          $ref: '#/components/schemas/GlobalCreditorReference'
        paymentDetails:
          $ref: '#/components/schemas/PaymentDetails'
        creditorIndicators:
          $ref: '#/components/schemas/GlobalCreditorIndicators'
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorAccountTypeCodes:
      title: GlobalCreditorAccountTypeCodes
      type: string
      enum:
      - INDIVIDUAL
      - MERCHANT
      - BUSINESS
      - CHARITY
      - GOVERNMENT_BODY
      - OTHER
      description: Select the creditor type (e.g., individual, merchant, or business) from the allowed list so Citi can present the correct payee category to the PSU during the consent authorization journey.
    GlobalAdditionalAccountHolderIdentifiers:
      title: GlobalAdditionalAccountHolderIdentifiers
      type: array
      items:
        type: object
        description: Provides the details to identify an account.
        required:
        - schemeName
        - identification
        properties:
          schemeName:
            $ref: '#/components/schemas/GlobalRiskExternalAccountIdentificationCode'
          identification:
            $ref: '#/components/schemas/GlobalIdentification'
        additionalProperties: false
    GlobalCreditorReference:
      title: GlobalCreditorReference
      description: Provide a creditor-side reference so the beneficiary and their bank can reconcile the incoming payment against an invoice or outstanding obligation.
      type: string
      minLength: 1
      maxLength: 35
    Service-Error-Response:
      title: ServiceErrorResponse
      type: object
      required:
      - ref_id
      - error_details
      properties:
        ref_id:
          type: string
          maxLength: 120
          description: Unique ID for the Transaction
          title: ref_id
          example: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
        error_details:
          type: array
          description: List of error details
          title: error_details
          items:
            $ref: '#/components/schemas/Error-Detail_2'
    GlobalPaymentPurposeCode:
      title: GlobalPaymentPurposeCode
      description: Submit a purpose code that classifies the nature of the payment (e.g., goods or services) using the published ISO 20022 error code list, enabling Citi to meet regulatory reporting and compliance requirements.
      type: string
      minLength: 1
      maxLength: 4
      pattern: ^[A-Z]{3}$
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalInternationalPaymentInitiation:
      title: GlobalInternationalPaymentInitiation
      type: object
      required:
      - debtorAccount
      - creditorAccount
      - creditorAgent
      - creditor
      properties:
        debtorAccount:
          $ref: '#/components/schemas/DebtorAccount'
        creditorAgent:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorAgentProperties'
        creditor:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorProperties'
        creditorAccount:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalInternationalCreditorAccountProperties'
      description: Provide the complete set of debtor account, creditor account, creditor agent, and creditor details for Citi to execute a cross-border payment. Note that Confirmation of Payee is not required for international payments.
      additionalProperties: false
    GlobalChargeBearerType1Code:
      title: GlobalChargeBearerType1Code
      description: Specify which party bears the payment processing charges so Citi can apply the correct fee allocation between the PSU (debtor) and the beneficiary (creditor).
      type: string
      enum:
      - BORNEBYCREDITOR
      - BORNEBYDEBTOR
      - SHARED
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalDomesticPaymentInitiation:
      title: GlobalDomesticPaymentInitiation
      type: object
      required:
      - debtorAccount
      - creditorAccount
      - creditorAgent
      - creditor
      properties:
        debtorAccount:
          $ref: '#/components/schemas/DebtorAccount'
        creditorAgent:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorAgentProperties'
        creditor:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorProperties'
        creditorAccount:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalDomesticCreditorAccountProperties'
        confirmationOfPayeeResponse:
          type: string
          pattern: ^.+\..+\..+$
          description: 'Response from Confirmation of Payee operation, when executed for the Creditor Account.


            This is JSON Web Signature returned by the Payee Confirmation operation at the Confirmation of Payee API.


            The value must be the full JWS string, including the header and signature, without decoding to an object.


            If Confirmation of Payee is not performed this property can be omitted'
      description: Provide the complete set of debtor account, creditor account, creditor agent, and creditor details needed for Citi to execute and route a domestic payment on the PSU's behalf.
      additionalProperties: false
    Error-Detail_2:
      type: object
      title: ErrorDetail
      properties:
        issue:
          type: string
          minLength: 1
          maxLength: 200
          description: more details about the issue
          title: issue
          example: property emailAddress is mandatory and it cannot be empty
        action:
          type: string
          maxLength: 350
          description: corrective action to be taken to resolve above issue
          title: action
          example: please provide valid value for property emailAddress
        code:
          type: string
          minLength: 1
          maxLength: 64
          description: unique code representing the issue
          title: code
          example: VC00010
    FxQuoteId:
      title: FxQuoteId
      description: Provide the FX quote identifier you received from a prior quote request when your payment relates to a pre-agreed FX trade. For long-lived consents, you must supply a new QuoteId with each individual payment initiation request to link it to the correct agreed rate.
      allOf:
      - $ref: '#/components/schemas/FxServiceInitiation.FxQuoteIdType'
    PaymentPostRequest:
      allOf:
      - $ref: '#/components/schemas/GlobalPaymentPostRequest'
      discriminator:
        propertyName: paymentType
        mapping:
          global-payment: '#/components/schemas/GlobalPaymentPostRequest'
    GlobalExchangeRateInformation:
      title: GlobalExchangeRateInformation
      type: object
      additionalProperties: false
      required:
      - unitCurrency
      - exchangeRate
      - rateType
      description: Review the exchange rate details Citi applied to this payment, including the unit currency, rate type, and contract reference, enabling you to display the full FX conversion information to the PSU.
      properties:
        unitCurrency:
          description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
          type: string
          pattern: ^[A-Z]{3,3}$
        exchangeRate:
          description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
          type: number
        rateType:
          description: Specifies the type used to complete the currency exchange.
          type: string
          enum:
          - ACTUAL
          - AGREED
          - INDICATIVE
        contractIdentification:
          description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
          type: string
          minLength: 1
          maxLength: 256
        expirationDateTime:
          description: "Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
          type: string
          format: date-time
    GlobalDebtorReference:
      title: GlobalDebtorReference
      description: Include a PSU-side reference note that will appear in the PSU's account statement, supporting their own payment reconciliation and record-keeping.
      type: string
      minLength: 1
      maxLength: 35
    GlobalBankServiceInitiation.GlobalInternationalPaymentPIIProperties:
      title: International Payment PII Schema Object
      type: object
      required:
      - initiation
      properties:
        initiation:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalInternationalPaymentInitiation'
      additionalProperties: false
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalTradingName:
      title: GlobalTradingName
      type: object
      properties:
        en:
          type: string
          maxLength: 70
          description: English value of the string
        ar:
          type: string
          maxLength: 70
          description: Arabic value of the string
      description: Provide the creditor's trading or brand name in English and/or Arabic when it differs from the registered legal name, enabling Citi to include the correct commercial identity in payment notifications.
      additionalProperties: false
    GlobalConsentId:
      title: GlobalConsentId
      type: string
      minLength: 1
      maxLength: 128
      description: Supply the consent identifier you received during consent creation; Citi uses this to confirm the PSU has authorized the requested payment before processing.
    GlobalIdentification:
      title: GlobalIdentification
      description: Provide the actual identifier value corresponding to the selected scheme so Citi can verify the creditor's identity during payment processing.
      type: string
      minLength: 1
    GlobalExternalPaymentChargeTypeCode:
      title: GlobalExternalPaymentChargeTypeCode
      description: Identifies the category of charge applied to this payment (e.g., VAT or fees), allowing you to present an itemized cost breakdown to the PSU.
      type: string
      enum:
      - VAT
      - FEES
    GlobalRiskExternalAccountIdentificationCode:
      title: GlobalRiskExternalAccountIdentificationCode
      description: Select the identification scheme code that applies to the additional creditor identifier you are submitting. Supported codes are — USRC - Unified State Register Code, TRAN - Taxpayer Registration Account Number, NA - Not Assigned, RNRCT - National Code, PSPT - Passport Number, OTHER - Other Identification and UNKN - Unknown Identification.
      type: string
      enum:
      - USRC
      - TRAN
      - NA
      - RNRCT
      - PSPT
      - OTHER
      - UNKN
    GlobalPaymentIdResponse:
      title: GlobalPaymentIdResponse
      description: 'Citi returns this response after you submit a payment initiation request, providing the payment transaction identifier, current processing status, and associated charges or FX details you need to inform the PSU of the outcome.


        The structure of this response aligns with standard payment initiation response patterns.

        '
      type: object
      additionalProperties: false
      required:
      - data
      properties:
        data:
          type: object
          description: Required fields are common for all the payments including file payment. Apart from that, paymentTransactionId is required for all payments except file payments
          additionalProperties: false
          required:
          - paymentTransactionId
          - status
          - statusUpdateDateTime
          - creationDateTime
          - paymentPurposeCode
          properties:
            consentId:
              description: Unique identification assigned by the TPP to identify the consent resource.
              type: string
            paymentTransactionId:
              description: 'This is an end-to-end identifier that is generated by the underlying payment rails when it is sent from an Originating LFI to a Receiving LFI.

                For IPP transactions, this is the IPP generated identifier.


                This property is not the same as the `transactionId` in the Bank Data Sharing Transactions API.


                The `paymentTransactionId` must be populated if the payment is processed by the LFI, and updated at the Consent Manager Payment Log API using the `patch` operation.

                '
              type: string
            status:
              description: 'Specifies the status of the payment information group

                * Pending: Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.

                * Rejected: The payment initiation has been rejected

                * AcceptedSettlementCompleted: Settlement of the Debtor''s account has been completed

                * AcceptedCreditSettlementCompleted: When the Creditor account has been credited with the funds of the payment initiated via the TPP

                * AcceptedWithoutPosting:  When the Recipient Bank has accepted the payment but has not applied the credit to the Creditor account yet.

                '
              type: string
              enum:
              - PENDING
              - ACCEPTED_SETTLEMENT_COMPLETED
              - ACCEPTED_CREDIT_SETTLEMENT_COMPLETED
              - ACCEPTED_WITHOUT_POSTING
              - REJECTED
              - RECEIVED
            statusUpdateDateTime:
              description: Date and time at which the resource status was updated.
              type: string
              format: date-time
            rejectReasonCode:
              items:
                description: Rejection Reason
                type: object
                required:
                - code
                - message
                additionalProperties: false
                properties:
                  code:
                    description: "Rejected Reason Code is a namespaced rejection reason code. The first part of the code is the namespace, which is the name of the organisation or system (e.g., AANI) that is rejecting the payment, and the second part is the specific rejection reason code for the originating organisation or system.\nPayments that are rejected by AANI will have the AANI prefix, followed by the specific ANNI reason code.\n\nThe Payment resouce is updated with the rejection reason code if a Rejected payment is initially created in a Pending state. \nIf the Payment resource is rejected, and no Payment resource is created - a 4xx HTTP status code is returned to the TPP with the appropriate Error Response.\n"
                    type: string
                    pattern: ^[A-Za-z]+\.[A-Za-z0-9]+$
                  message:
                    description: Message
                    type: string
              type: array
              minItems: 1
            creationDateTime:
              description: Date and time at which the message was created.
              type: string
              format: date-time
            charges:
              $ref: '#/components/schemas/GlobalCharges'
            exchangeRate:
              $ref: '#/components/schemas/GlobalExchangeRateInformation'
            currencyRequest:
              $ref: '#/components/schemas/GlobalCurrencyRequest'
            instruction:
              $ref: '#/components/schemas/GlobalPaymentInstruction'
            paymentPurposeCode:
              $ref: '#/components/schemas/GlobalPaymentPurposeCode'
            debtorReference:
              $ref: '#/components/schemas/GlobalDebtorReference'
            instructionPriority:
              description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction.
              type: string
              enum:
              - NORMAL
              - URGENT
            paymentDetails:
              $ref: '#/components/schemas/PaymentDetails'
            creditorIndicators:
              $ref: '#/components/schemas/GlobalCreditorIndicators'
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorProperties:
      title: GlobalCreditorProperties
      type: object
      required:
      - name
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 140
        postalAddress:
          $ref: '#/components/schemas/GlobalAddress'
      description: Supply the beneficiary's legal name and optional postal address so Citi can populate the payment message with the correct creditor details as required by the payment scheme.
      additionalProperties: false
    FxServiceInitiation.FxQuoteIdType:
      title: FxQuoteIdType
      type: string
      minLength: 1
      maxLength: 128
      format: uuid
    GlobalCharges:
      title: GlobalCharges
      description: Review the itemized charges Citi will apply to this payment, enabling you to display the full cost breakdown to the PSU prior to or following execution.
      type: array
      items:
        type: object
        additionalProperties: false
        description: 'Set of elements used to provide details of a charge for the payment initiation.

          * For Payments, these Charges are on the Debtor.

          '
        required:
        - chargeBearer
        - type
        - amount
        properties:
          chargeBearer:
            $ref: '#/components/schemas/GlobalChargeBearerType1Code'
          type:
            $ref: '#/components/schemas/GlobalExternalPaymentChargeTypeCode'
          amount:
            $ref: '#/components/schemas/GlobalActiveCurrencyAmount'
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalInternationalCreditorAccountProperties:
      title: GlobalInternationalCreditorAccountProperties
      type: object
      required:
      - schemeName
      - identification
      - name
      properties:
        schemeName:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorExternalAccountIdentificationCode'
        identification:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalIdentification'
        name:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalName'
        tradingName:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalTradingName'
        type:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorAccountTypeCodes'
      description: Identify the international beneficiary account using IBAN or account number along with the holder's name, enabling Citi to route and credit the cross-border payment to the correct destination account.
      additionalProperties: false
    GlobalPaymentInstruction:
      title: GlobalPaymentInstruction
      type: object
      additionalProperties: false
      required:
      - Amount
      description: Specify the currency and amount of the funds you are instructing Citi to transfer from the PSU's debtor account to the creditor for this single payment.
      properties:
        Amount:
          $ref: '#/components/schemas/GlobalActiveCurrencyAmount'
    GlobalActiveCurrencyAmount:
      title: GlobalActiveCurrencyAmount
      description: Specify the ISO 4217 currency code and monetary amount for this payment component, ensuring Citi processes the correct value in the intended currency.
      type: object
      required:
      - amount
      - currency
      properties:
        amount:
          $ref: '#/components/schemas/GlobalActiveOrHistoricAmount'
        currency:
          $ref: '#/components/schemas/GlobalActiveOrHistoricCurrencyCode'
    DebtorAccount:
      title: DebtorAccount
      type: object
      description: Specify the PSU's source account — identified by IBAN or account number — from which Citi will debit the payment amount upon successful PSU authorization.
      required:
      - schemeName
      - identification
      - name
      properties:
        schemeName:
          title: SchemeName
          type: string
          description: Type of the account. Allowed values are IBAN, AccountNumber. Name of the identification scheme, in a coded form as published in an external list.
          enum:
          - ACCOUNT_NUMBER
          - IBAN
        identification:
          title: Identification
          type: string
          description: Account, Iban of the debtor.
          maxLength: 35
          minLength: 1
        name:
          title: Name.
          type: string
          description: Debtor Name.
          minLength: 1
          maxLength: 35
    PaymentDetails:
      title: PaymentDetails
      type: string
      description: Include free-text payment narrative here so the PSU's remittance information or payment reference is passed through to the beneficiary.
      minLength: 1
      maxLength: 280
    GlobalCurrencyRequest:
      title: GlobalCurrencyRequest
      description: 'Submit the FX or non-local currency details agreed between you and the PSU so Citi can apply the correct exchange rate and currency conversion when executing the payment.

        Note that the ChargeBearer and ExchangeRateInformation you provide may be overwritten by Citi in the returned Consent object.

        '
      type: object
      additionalProperties: false
      required:
      - currencyOfTransfer
      properties:
        currencyOfTransfer:
          description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account.
          type: string
          pattern: ^[A-Z]{3,3}$
        destinationCountryCode:
          description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
          type: string
          pattern: '[A-Z]{2,2}'
        exchangeRateInformation:
          type: object
          additionalProperties: false
          required:
          - unitCurrency
          - rateType
          description: Provides details on the currency exchange rate and contract.
          properties:
            unitCurrency:
              description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP.
              type: string
              pattern: ^[A-Z]{3,3}$
            exchangeRate:
              description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency.
              type: number
            rateType:
              description: Specifies the type used to complete the currency exchange.
              type: string
              enum:
              - ACTUAL
              - AGREED
              - INDICATIVE
            contractIdentification:
              description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent.
              type: string
              minLength: 1
              maxLength: 256
        fxQuoteId:
          $ref: '#/components/schemas/FxQuoteId'
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalName:
      title: GlobalName
      type: object
      properties:
        en:
          type: string
          maxLength: 70
          description: English value of the string
        ar:
          type: string
          maxLength: 70
          description: Arabic value of the string
      description: Provide the account holder's name in English and/or Arabic so Citi can perform payee validation and include the correct beneficiary name in payment messages.
      additionalProperties: false
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalIdentification:
      title: GlobalIdentification
      type: string
      minLength: 1
      description: Provide the account identifier assigned by the financial institution for the selected scheme (e.g., IBAN or account number), as known by the PSU who owns the account.
    GlobalRequestedExecutionDate:
      title: GlobalRequestedExecutionDate
      description: 'Specify the future date on which you want Citi to execute the payment on the PSU''s behalf.

        The date must be in the future and cannot be the current day or a past date.

        You may schedule the payment up to one year from the date the PSU granted consent to your TPP application.

        All dates in the JSON payloads are represented in ISO 8601 date format.

        '
      type: string
      format: date
    GlobalAddress:
      title: GlobalAddress
      description: Supply one or more postal addresses for a party involved in the payment, enabling Citi to include address details required by compliance and correspondent banking standards.
      type: array
      minItems: 1
      items:
        description: Address properties based on ISO 20022 `PostalAddress27` definition
        type: object
        required:
        - addressType
        - addressLine
        - country
        properties:
          addressType:
            description: The type of address.
            type: string
            enum:
            - BILLING
            - BUSINESS
            - CORRESPONDENCE
            - DELIVERYTO
            - MAILTO
            - POBOX
            - POSTAL
            - PERMANENT
            - RESIDENTIAL
            - STATEMENT
            - OTHER
          addressLine:
            description: Information that locates and identifies a specific address for a transaction entry, that is presented in free format text.
            type: array
            minItems: 1
            maxItems: 7
            items:
              type: string
              minLength: 1
              maxLength: 70
          buildingNumber:
            description: The unit, apartment, or villa number within a building or community
            type: string
            minLength: 1
            maxLength: 16
          buildingName:
            description: Name of the building or house.
            type: string
            minLength: 1
            maxLength: 140
          floor:
            description: Floor or storey within a building.
            type: string
            minLength: 1
            maxLength: 70
          streetName:
            description: The name of the street or road where the property is located.
            type: string
            minLength: 1
            maxLength: 140
          districtName:
            description: The district, community, or neighbourhood where the property is located.
            type: string
            minLength: 1
            maxLength: 140
          postBox:
            description: The P.O. Box number assigned to the recipient for mail delivery.
            type: string
            minLength: 1
            maxLength: 16
          townName:
            description: Name of a built-up area, such as a town or city.
            type: string
            minLength: 1
            maxLength: 140
          countrySubDivision:
            description: Country subdivision, such as state or province. For country-specific implementations, this value can represent a local administrative region.
            type: string
          country:
            description: The country associated with the address, represented using the ISO 3166-1 alpha-2 country code.
            type: string
            pattern: ^[A-Z]{2}$
        additionalProperties: false
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorAgentProperties:
      title: GlobalCreditorAgentProperties
      type: object
      required:
      - schemeName
      - identification
      properties:
        schemeName:
          type: string
          description: 'The identification scheme for uniquely identifying the Agent.

            * BICFI: The BIC/SWIFT Code

            * Other: Identifier based on non-SWIFT payment system or local market scheme.

            '
          enum:
          - BICFI
          - OTHER
        identification:
          description: Identifier that can be the BIC/SWIFT code or target payment scheme identifier.
          type: string
        name:
          description: Name by which an agent is known and which is usually used to identify that agent.
          type: string
          minLength: 1
          maxLength: 140
        postalAddress:
          $ref: '#/components/schemas/GlobalAddress'
      description: Specify the beneficiary's financial institution using its BIC/SWIFT code or local scheme identifier so Citi can route the payment to the correct receiving bank.
      additionalProperties: false
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalDomesticCreditorAccountProperties:
      title: GlobalDomesticCreditorAccountProperties
      type: object
      required:
      - schemeName
      - identification
      - name
      properties:
        schemeName:
          type: string
          enum:
          - IBAN
          - ACCOUNT_NUMBER
          description: Domestic payment scheme, restricted to `IBAN`
        identification:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalIdentification'
        name:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalName'
        tradingName:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalTradingName'
        type:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorAccountTypeCodes'
      description: Identify the domestic beneficiary account using IBAN or account number, along with the holder's name, so Citi can verify the destination account and apply a credit entry to the correct account.
      additionalProperties: false
    GlobalPaymentPostRequest:
      title: GlobalPaymentPostRequest
      description: Submit this object to initiate a payment on behalf of a PSU, specifying the consent reference, payment type, and full payment instruction that Citi requires to process the transaction.
      type: object
      properties:
        consentId:
          $ref: '#/components/schemas/GlobalConsentId'
        paymentType:
          $ref: '#/components/schemas/PaymentType'
        paymentRequest:
          $ref: '#/components/schemas/PaymentRequest'
      required:
      - consentId
      - paymentType
      - paymentRequest
      additionalProperties: false
    Gateway-Error-Response:
      type: object
      title: GatewayErrorResponse
      required:
      - httpCode
      - httpMessage
      - moreInformation
      properties:
        httpCode:
          type: string
          maxLength: 3
          description: Numeric HTTP status code
          title: httpCode
        httpMessage:
          type: string
          maxLength: 128
          description: HTTP error message
          title: httpMessage
          example: Bad Request
        moreInformation:
          type: string
          maxLength: 128
          description: HTTP error message
          title: moreInformation
          example: please provide valid value for request
    GlobalBankServiceInitiation.GlobalDomesticPaymentPIIProperties:
      title: Domestic Payment PII Schema Object
      type: object
      additionalProperties: false
      description: Submit the domestic payment PII — containing the debtor and creditor account details — as a JWE-encrypted payload; Citi decrypts and validates this data before processing the domestic payment instruction.
      required:
      - initiation
      properties:
        initiation:
          $ref: '#/components/schemas/GlobalBankServiceInitiationRichAuthorizationRequests.GlobalDomesticPaymentInitiation'
    GlobalActiveOrHistoricCurrencyCode:
      title: GlobalActiveOrHistoricCurrencyCode
      description: Provide the ISO 4217 three-character alphabetic currency code for the payment amount, ensuring Citi processes and settles the transaction in the correct currency.
      type: string
      pattern: ^[A-Z]{3,3}$
      example: AED
    GlobalBankServiceInitiationRichAuthorizationRequests.GlobalCreditorExternalAccountIdentificationCode:
      title: GlobalCreditorExternalAccountIdentificationCode
      type: string
      enum:
      - IBAN
      - ACCOUNT_NUMBER
      description: Choose IBAN for international payments or ACCOUNT_NUMBER when using a local scheme to identify the creditor account, ensuring Citi applies the correct routing and validation logic.
    GlobalCreditorIndicators:
      title: GlobalCreditorIndicators
      type: object
      description: Include supplementary creditor identification details that support regulatory compliance and risk checks performed by Citi during payment processing.
      required:
      - additionalIdentifiers
      properties:
        additionalIdentifiers:
          $ref: '#/components/schemas/GlobalAdditionalAccountHolderIdentifiers'
  examples:
    Method-Not-Allowed-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: HTTP method is not supported
          action: Provide valid HTTP method
          code: CC00001
    SEPA-MandatoryFields-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          account: '5589076'
        method:
          country: IE
          instructed_currency: EUR
          method: IP
        transaction:
          creation_date_time: '2023-09-10T08:23:49.112Z'
          value_date: '2024-09-10'
          instructed_amount: 100
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
    Us-Ach-Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '927393038'
          name: Stripe
          bank_id: 021000089
          org_id: '3052963052'
          address_lines:
          - 525 23rd Street NW Org Address XXX1
          - Washington*DC Org Address line XX2
          - US*20037 Org Address line number 3
        creditor:
          account: '333333333'
          name: John Len
          bank_id: '444444444'
          account_type: SVGS
          address_lines:
          - 525 23rd Street NW Org Address XXX1
          - Washington*DC Org Address line XX2
          - US*20037 Org Address line number 3
        method:
          country: US
          instructed_currency: USD
          method: ACH
          type: CT
        transaction:
          payment_information_id: PAY1234567
          additional_info: /MICE/ACCTVERIFY
          category: CCD
          end_to_end_id: r/434SKtUcdGQ
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          creation_date_time: '2023-05-23T08:23:49.230Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACTC
            description: Accepted
        ultimate_debtor:
          name: VA wallet merchant
          org_id: /TXID/12345678
          address_lines:
          - 525 23rd Street NW Org Address XXX1
          - Washington*DC Org Address line XX2
          - US*20037 Org Address line number 3
    UK-BACS-Initiation-Response-Example:
      value:
        debtor:
          account: '927393038'
          bank_id: CITIGB2L
        creditor:
          account: '7788993038'
          name: STEVE
          bank_id: '789654'
        method:
          country: GB
          instructed_currency: GBP
          method: ACH
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          value_date: '2026-04-01'
          instructed_amount: 570.03
          creation_date_time: '2026-04-01T08:23:49.554Z'
          status:
            date_time: '2026-04-01T08:23:56.665Z'
            code: ACTC
            description: Accepted
    SEPA-IDP-Completed:
      value:
      - debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
    SEPA-VoP-Nok-Completed:
      value:
      - debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
        account_validation:
          uetr: 921a9445-97df-4118-9a55-68d14667656f
          account:
            number_validation: MISMATCH
            name_validation: MISMATCH
          status:
            code: RJCT
            description: Rejected
            date_time: '2024-09-10T08:23:49.112Z'
          reasons:
            code: AC01
            description: Invalid Account Number
          unstructured_remittance_info:
          - Name -MISMATCH , Account -MISMATCH
    AU-Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '5589089'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: AU
          address_lines:
          - ABC#GFD
          org_id: HIDC3344
          lei: QWSX3456
          issuer: ABC pvt ltd
          anybic: AGKLIE20
          scheme_name: NPP
        ultimate_debtor:
          name: Heri Tig
          address_lines:
          - ABT#GFT
          anybic: ABKLIE20
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: AU
          scheme_name: NPP
          building_number: '32'
          city: New Carol
          country: AU
          lei: QGDH2738
          postal_code: '90987'
          state: California
          street_name: 9th Street
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: AU
          address_lines:
          - ABC#TEG
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          lei: VHKX3456
          account: '5589076'
          anybic: HRKLIE20
          scheme_name: NPP
        instructing_agent:
          bank_id: GLRB7983
        method:
          country: AU
          instructed_currency: AUD
          method: IP
          type: CT
        transaction:
          instructed_amount: 90.91
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          creation_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          unstructured_remittance_info:
          - More details of transaction
          value_date: '2025-09-09'
          status:
            date_time: '2022-09-13T08:23:50.665Z'
            code: ACTC
            description: Accepted
    Uk-Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '927393038'
        creditor:
          account: '7788993038'
          name: MAD RANJI
          bank_id: '789656'
          birth_date: '1999-05-26'
        method:
          country: GB
          instructed_currency: GBP
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          type: debit
          creation_date_time: '2023-05-02T08:23:49.227Z'
          value_date: '2023-05-02'
          instructed_amount: 599
          status:
            date_time: '2023-05-02T08:23:49.230Z'
            code: ACTC
            description: Accepted
    Duplicate-Payment-Conflict-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: duplicate request. same request is being processed in another request
          action: please do not repeat the same request again
          code: VC00017
    Th-Account-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '927393038'
        creditor:
          account: '1027393037'
          name: JOHN
          bank_id: '014'
        method:
          country: TH
          instructed_currency: THB
          method: IP
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          instructed_amount: 88765
    MX-BKT-Payment-Initiation-Request-Example:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: BKT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          instructed_amount: 100.51
        debtor:
          account: '12345678901'
          bank_branch_id: '485'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    In-Neft-Ok-Response-Failed:
      value:
        debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: IN
          instructed_currency: INR
          method: NEFT
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: credit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2025-07-08'
          instructed_amount: 300.03
          settlement_amount: 300.03
          settlement_currency: INR
          network_id: NET123456
          local_reference: LOCAL123456
          reference: REF123456
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
        reasons:
        - code: AM02
          description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    In-Neft-Ok-Response-Multiple-Failed:
      value:
      - debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: IN
          instructed_currency: INR
          method: NEFT
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: credit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2025-07-08'
          instructed_amount: 300.03
          settlement_amount: 300.03
          settlement_currency: INR
          network_id: NET123456
          local_reference: LOCAL123456
          reference: REF123456
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
        reasons:
        - code: AM02
          description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
      - debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: IN
          instructed_currency: INR
          method: NEFT
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGD
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: credit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2025-07-08'
          instructed_amount: 301.03
          settlement_amount: 301.03
          settlement_currency: INR
          network_id: NET123456
          local_reference: LOCAL123456
          reference: REF123456
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
        reasons:
        - code: AM02
          description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    Us-Ach-Ccd-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '100000000228'
          name: sample name
          street_name: sample street Suite
          building_number: '1309'
          postal_code: '12345'
          city: ABCDEFG
          state: WY
          country: US
        creditor:
          account: '8137871234'
          account_type: CACC
          name: ABCD INC
          street_name: street Ave. Suite
          building_number: '1234'
          postal_code: '12345'
          city: ABCDEFG
          state: WY
          country: US
          bank_id: '031207607'
        method:
          country: US
          instructed_currency: USD
          method: ACH
        transaction:
          instructed_amount: 1.49
          value_date: '2025-04-07'
          end_to_end_id: MHI908304X91Q1YM
          category: CCD
          payment_information_id: '6387965'
        ultimate_debtor:
          name: TESTAirbakery Ci
          org_id: /TXID/1345678980
          street_name: street Ave. Suite
          building_number: '1234'
          postal_code: '12345'
          city: ABCDEFG
          state: WY
          country: US
        ultimate_creditor:
          name: ABCD INC
    SEPA-IDP-Completed-Status:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: BirdView
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Bel fast
          town_location_name: Bel fast
          district_name: Bel fast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4thStreet
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: NewArk
          town_location_name: NewArk
          district_name: NewArk
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBHpvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYPpvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
    MX-BKT-Status-Get-Response-Rejected:
      value:
      - method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: RJCT
            description: Rejected
          reasons:
          - code: NARR
            description: Invalid Account Number.
        debtor:
          account: '12345678901'
          bank_id: CITIMXMM
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    In-Ok-Response-Multiple:
      value:
      - debtor:
          account: '110654321'
          name: PETER
        creditor:
          account: '44227754321'
          name: JOHN
          bank_id: '561223'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: p434SKtUcd77
          uetr: 8f09214d-296c-411b-8e9c-810bf1d9fc77
          purpose: CASH
          network_id: '889923283934'
          type: credit
          creation_date_time: '2023-05-13T08:23:49.112Z'
          value_date: '2023-05-02'
          instructed_amount: 300.98
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
      - debtor:
          account: '220654321'
          name: PETER
        creditor:
          account: '87527754321'
          name: JOHN
          bank_id: '561223'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: p434SKtUcd77
          uetr: 8f07814d-296c-411b-8e9c-810bf1d9fc77
          purpose: CASH
          network_id: '779923283934'
          type: credit
          creation_date_time: '2023-05-13T08:23:49.112Z'
          value_date: '2023-05-02'
          instructed_amount: 301.98
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    Uk-Ok-Response-Failed:
      value:
        debtor:
          account: '220654001'
          name: MARK
          bank_id: '789546'
        creditor:
          account: 00227754885
          name: STEVE
          bank_id: '561223'
        method:
          country: GB
          instructed_currency: GBP
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 405
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
            non_iso_code: '1183'
    SEPA-Ok-Completed-Final:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRSpvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYPpvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
    US-WIRE-Ok-Response-Multiple:
      value:
      - debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: '111111111'
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for debtor agent
        ultimate_debtor:
          name: Jack
          address_lines:
          - address line
          org_id: '222222222'
        creditor:
          account: '333333333'
          name: John Len
          bank_id: '444444444'
          bank_name: Citi bank
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for creditor agent
        intermediary:
        - bank_id: '444444444'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '555555555'
        - bank_id: '666666666'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '777777777'
        method:
          country: US
          instructed_currency: USD
          method: WIRE
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: CNFL
          batch_id: '492084893'
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          priority: HIGH
          charges_paid_by: DEBT
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
      - debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: '111111111'
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for debtor agent
        ultimate_debtor:
          name: Jack
          address_lines:
          - address line
          org_id: '222222222'
        creditor:
          account: '333333333'
          name: John Len
          bank_id: '444444444'
          bank_name: Citi bank
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for creditor agent
        intermediary:
        - bank_id: '444444444'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '555555555'
        - bank_id: '666666666'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '777777777'
        method:
          country: US
          instructed_currency: USD
          method: WIRE
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: CNFL
          batch_id: '492084893'
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          priority: HIGH
          charges_paid_by: DEBT
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
    SEPA-VoP-Nok-Completed-Final:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: BirdView
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Bel fast
          town_location_name: Bel fast
          district_name: Bel fast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABCpvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: NewArk
          town_location_name: NewArk
          district_name: NewArk
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRSpvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
        account_validation:
          uetr: 921a9445-97df-4118-9a55-68d14667656f
          account:
            number_validation: MISMATCH
            name_validation: MISMATCH
          status:
            code: RJCT
            description: Rejected
            date_time: '2024-09-10T08:23:49.112Z'
          reasons:
            code: AC01
            description: Invalid Account Number
          unstructured_remittance_info:
          - Name -MISMATCH , Account -MISMATCH
    In-Imps-Fir-Ok-Response-Multiple-Failed:
      value:
      - debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000038
          bank_name: SCBB
          bank_account: '1122334455'
        ultimate_debtor:
          name: JOHN
          bank_id: HDFC000038
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        instructing_agent:
          bank_name: DFCI
          bank_id: DFCI12345
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          creation_date_time: '2022-09-13T08:23:56.665Z'
          instructed_amount: 200.02
          category: FIR
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
      - debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000038
          bank_name: SCBB
          bank_account: '1122334455'
        ultimate_debtor:
          name: JOHN
          bank_id: HDFC000038
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        instructing_agent:
          bank_name: DFCI
          bank_id: DFCI12345
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          creation_date_time: '2023-05-23T08:23:49.227Z'
          instructed_amount: 200.02
          category: FIR
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    In-Imps-Fir-Ok-Response:
      value:
        debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000038
          bank_name: SCBB
          bank_account: '1122334455'
        ultimate_debtor:
          name: JOHN
          bank_id: HDFC000038
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        instructing_agent:
          bank_name: DFCI
          bank_id: DFCI12345
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          creation_date_time: '2023-05-23T08:23:49.230Z'
          instructed_amount: 200.02
          category: FIR
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    Us-Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '31216795'
          name: Stripe
          bank_id: '254689456'
          org_id: ABCDEQHNXJKLMNCGBH24
        creditor:
          account: '7788993038'
          name: JOHN
          bank_id: '789654778'
        method:
          country: US
          instructed_currency: USD
          method: IP
          type: CT
        ultimate_debtor:
          name: VA wallet merchant
          street_name: 4th Street
          org_id: ABCDEQHNXJKLMNCGBH21
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          type: debit
          creation_date_time: '2023-05-02T08:23:49.227Z'
          value_date: '2023-05-02'
          instructed_amount: 403
          status:
            date_time: '2023-05-02T08:23:49.230Z'
            code: ACTC
            description: Accepted
    MX-DFT-Payment-Initiation-Response-Example:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            date_time: '2025-11-11T08:23:50.665Z'
            code: ACTC
            description: Accepted
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    In-Ok-Response-Failed-Multiple:
      value:
      - debtor:
          account: '220654001'
          name: MARK
          bank_id: '7895462'
        creditor:
          account: 00227754885
          name: STEVE
          bank_id: '561223'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 405
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
      - debtor:
          account: '118654001'
          name: MARK
          bank_id: '7895462'
        creditor:
          account: '11227754885'
          name: STEVE
          bank_id: '561223'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-282c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 505
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    Jp-Ok-Response-Failed-Multiple:
      value:
      - debtor:
          account: '220654001'
          name: MARK
          bank_id: '7895460'
        creditor:
          account: 00227754885
          name: STEVE
          bank_id: '0561223'
        method:
          country: JP
          instructed_currency: JPY
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 405
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
      - debtor:
          account: '118654001'
          name: MARK
          bank_id: 0789546
        creditor:
          account: '11227754885'
          name: STEVE
          bank_id: '8561223'
        method:
          country: JP
          instructed_currency: JPY
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-282c-494b-8e9c-810bf1d9fc93
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 505
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    AR-IP-Payment-Initiation-Request-Example:
      value:
        method:
          country: AR
          instructed_currency: ARS
          method: IP
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: AR0037217563
          instructed_amount: 103.76
          uetr: 4f09288d-296c-494b-8e9c-810bf1d9fc93
          purpose: '06'
        debtor:
          account: '1234567809'
          name: Abc Argentina
          anybic: CITIARBA
        creditor:
          account: 0130003123456789123456
          bank_id: '013'
          bank_branch_id: '0003'
          name: Passi Saludas
          tax_id: '20123452875'
          country: AR
          address_lines:
          - ABC#GFD
          account_type: CACC
    Us-Ok-Response-Failed-Multiple:
      value:
      - debtor:
          account: '220654001'
          name: MARK
          bank_id: '7895462'
        creditor:
          account: 00227754885
          name: STEVE
          bank_id: '561223'
        method:
          country: US
          instructed_currency: USD
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 405
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
            non_iso_code: '1183'
      - debtor:
          account: '118654001'
          name: MARK
          bank_id: '7895462'
        creditor:
          account: '11227754885'
          name: STEVE
          bank_id: '561223'
        method:
          country: US
          instructed_currency: USD
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-282c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 505
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
            non_iso_code: '1183'
    Us-Ach-Ok-Response-Failed:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: US
          instructed_currency: USD
          method: ACH
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    Ok-Response-Multiple:
      value:
      - debtor:
          account: '897654321'
        creditor:
          account: '44227754321'
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 7634an78543
          purpose: CASH
          network_id: '209323283934'
          type: credit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 29876.98
          settlement_currency: THB
          settlement_amount: 29876.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
      - debtor:
          account: '557654321'
        creditor:
          account: '66227754321'
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f00214d-296c-404b-8e9c-810bf1d9fc93
          local_reference: 9634an78543
          purpose: CASH
          network_id: '209323283934'
          type: credit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 276.98
          settlement_currency: THB
          settlement_amount: 276.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    AU-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '5589089'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: AU
          address_lines:
          - ABC#GFD
          org_id: HIDC3344
          lei: QWSX3456
          issuer: ABC pvt ltd
          anybic: AGKLIE20
          scheme_name: NPP
        ultimate_debtor:
          name: Heri Tig
          address_lines:
          - ABT#GFT
          anybic: ABKLIE20
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: AU
          scheme_name: NPP
          building_number: '32'
          city: New Carol
          country: AU
          lei: QGDH2738
          postal_code: '90987'
          state: California
          street_name: 9th Street
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: AU
          address_lines:
          - ABC#TEG
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          lei: VHKX3456
          account: '5589076'
          anybic: HRKLIE20
          scheme_name: NPP
        instructing_agent:
          bank_id: GLRB7983
        method:
          country: AU
          instructed_currency: AUD
          method: IP
        transaction:
          instructed_amount: 90.91
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          charges_paid_by: SLEV
          purpose: PAYR
          unstructured_remittance_info:
          - More details of transaction
          value_date: '2025-09-09'
    In-Ok-Response-Failed:
      value:
        debtor:
          account: '220654001'
          name: MARK
          bank_id: '7895462'
        creditor:
          account: 00227754885
          name: STEVE
          bank_id: '561223'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 405
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    In-Upi-Ok-Response:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: UPI
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    SEPA-Ok-Completed-Status:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRSpvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYPpvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
    MX-BKT-Status-Single-Get-Response-Rejected:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: RJCT
            description: Rejected
          reasons:
          - code: NARR
            description: Invalid Account Number.
        debtor:
          account: '12345678901'
          bank_id: CITIMXMM
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    SEPA-Ok-Reject:
      value:
      - debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 1,000,000.00
    MX-BKT-Completed:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: ACCC
            description: Completed
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
    Proxy-Transaction-Post:
      value:
        debtor:
          account: '897654321'
        creditor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 7634an78543
          purpose: CASH
          network_id: '209323283934'
          type: debit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 29876.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACTC
            description: Accepted
    MX-BKT-Rejected:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: RJCT
            description: Rejected
          reasons:
          - code: NARR
            description: Invalid Account Number.
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
    Us-Ok-Response-Multiple:
      value:
      - debtor:
          account: '31216795'
          name: Stripe
          bank_id: '254689456'
          org_id: ABCDEQHNXJKLMNCGBH24
        creditor:
          account: '7788993038'
          name: JOHN
          bank_id: '789654778'
        method:
          country: US
          instructed_currency: USD
          method: IP
          type: CT
        ultimate_debtor:
          name: VA wallet merchant
          street_name: 4th Street
          org_id: ABCDEQHNXJKLMNCGBH21
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          type: debit
          creation_date_time: '2023-05-02T08:23:49.227Z'
          value_date: '2023-05-02'
          instructed_amount: 403
          purpose: CASH
          network_id: '889923283934'
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
      - debtor:
          account: '31216795'
          name: Stripe
          bank_id: '254689456'
          org_id: ABCDEQHNXJKLMNCGBH24
        creditor:
          account: '7788993038'
          name: JOHN
          bank_id: '789654778'
        method:
          country: US
          instructed_currency: USD
          method: IP
          type: CT
        ultimate_debtor:
          name: VA wallet merchant
          street_name: 4th Street
          org_id: ABCDEQHNXJKLMNCGBH21
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          type: debit
          creation_date_time: '2023-05-02T08:23:49.227Z'
          value_date: '2023-05-02'
          instructed_amount: 402
          purpose: CASH
          network_id: '889923283934'
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    Us-Ach-Ok-Response-Multiple-Failed:
      value:
      - debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: US
          instructed_currency: USD
          method: ACH
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
        reasons:
        - code: AM02
          description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
      - debtor:
          account: '110993444'
          name: Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: US
          instructed_currency: USD
          method: ACH
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 400.04
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
        reasons:
        - code: AM02
          description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    MX-BKT-Status-Single-Get-Response-Completed:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: ACCC
            description: Completed
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    Payer-Id-Transaction-Get:
      value:
        debtor:
          account: '897654321'
        creditor:
          account: '54805587254'
          virtual_account: '9987654321'
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 7634an78543
          purpose: CASH
          network_id: '209323283934'
          type: credit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 29876.98
          settlement_currency: THB
          settlement_amount: 29876.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
    AR-IP-Status-Get-Response-Completed:
      value:
        method:
          country: AR
          instructed_currency: ARS
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: AR0037217563
          uetr: 4f09288d-296c-494b-8e9c-810bf1d9fc93
          instructed_amount: 103.76
          creation_date_time: '2025-11-11T08:23:49.112Z'
          purpose: '06'
          type: debit
          status:
            date_time: '2025-11-11T08:23:50.665Z'
            code: ACCC
            description: Completed
        debtor:
          account: '1234567809'
          name: Abc Argentina
          bank_id: '056'
        creditor:
          account: 0130003123456789123456
          bank_id: '013'
          name: Passi Saludas
          tax_id: '20123452875'
    Us-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '31216795'
          name: Stripe
          bank_id: '254689456'
          org_id: ABCDEQHNXJKLMNCGBH24
        creditor:
          account: '7788993038'
          name: JOHN
          bank_id: '789654778'
        method:
          country: US
          instructed_currency: USD
          method: IP
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          instructed_amount: 403
          value_date: '2023-05-02'
        ultimate_debtor:
          name: VA wallet merchant
          street_name: 4th Street
          org_id: ABCDEQHNXJKLMNCGBH21
    Not-Found-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627702
        error_details:
        - issue: Resource that you are searching is not found
          action: Please use valid resource details
          code: CC00006
    US-WIRE-Ok-Response-Failed:
      value:
        debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: '111111111'
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for debtor agent
        ultimate_debtor:
          name: Jack
          address_lines:
          - address line
          org_id: '222222222'
        creditor:
          account: '333333333'
          name: John Len
          bank_id: '444444444'
          bank_name: Citi bank
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for creditor agent
        intermediary:
        - bank_id: '444444444'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '555555555'
        - bank_id: '666666666'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '777777777'
        method:
          country: US
          instructed_currency: USD
          method: WIRE
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: CNFL
          batch_id: '492084893'
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          priority: HIGH
          charges_paid_by: DEBT
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    Proxy-Transaction-Get:
      value:
        debtor:
          account: '897654321'
        creditor:
          proxy_id: '55448877992'
          proxy_type: BIID
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/558SKtUcdGQ
          uetr: 5f09214d-596c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          batch_id: '221084801'
          network_id: '209323283934'
          bill_id_1: '554488779934'
          type: debit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 402.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
    Th-Proxy-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '927393038'
        creditor:
          proxy_id: 1-2345-45678-78-1
          proxy_type: NIDN
        method:
          country: TH
          instructed_currency: THB
          method: IP
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          instructed_amount: 88765
    Qr-Transaction-Get:
      value:
        debtor:
          account: '897654321'
        creditor:
          account: '552654301'
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 7634an78543
          purpose: CASH
          network_id: '209323283934'
          bill_id_1: '112288779001'
          type: credit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 404.01
          settlement_currency: THB
          settlement_amount: 404.01
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
    Uk-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '927393038'
        creditor:
          account: '7788993038'
          name: MAD RANJI
          bank_id: '789654'
          birth_date: '1999-05-26'
        method:
          country: GB
          instructed_currency: GBP
          method: IP
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          value_date: '2023-05-02'
          instructed_amount: 599
    In-Upi-Payment-Initiation-Response-Example:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: UPI
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACTC
            description: Accepted
    In-Upi-Ok-Response-Multiple:
      value:
      - debtor:
          proxy_id: a93d@gmail.com
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: UPI
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
        reasons:
        - description: Citi validated and commercially completed the transaction. Account posting may be pending.
      - debtor:
          proxy_id: a70d@gmail.com
          account: '110993444'
          name: Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: UPI
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 400.04
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
        reasons:
        - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    In-Imps-Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000038
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACTC
            description: Accepted
    AR-IP-Status-Get-Response-Rejected:
      value:
        method:
          country: AR
          instructed_currency: ARS
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: AR0037217563
          uetr: 4f09288d-296c-494b-8e9c-810bf1d9fc93
          instructed_amount: 103.76
          creation_date_time: '2025-11-11T08:23:49.112Z'
          purpose: '06'
          type: debit
          status:
            date_time: '2025-11-11T08:23:50.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AC01
            description: Account number is invalid or missing
        debtor:
          account: '1234567809'
          name: Abc Argentina
          bank_id: '056'
        creditor:
          account: 0130003123456789123456
          bank_id: '013'
          name: Passi Saludas
          tax_id: '20123452875'
    US-WIRE-Ok-Response:
      value:
        debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: '111111111'
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for debtor agent
        ultimate_debtor:
          name: Jack
          address_lines:
          - address line
          org_id: '222222222'
        creditor:
          account: '333333333'
          name: John Len
          bank_id: '444444444'
          bank_name: Citi bank
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for creditor agent
        intermediary:
        - bank_id: '444444444'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '555555555'
        - bank_id: '666666666'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '777777777'
        method:
          country: US
          instructed_currency: USD
          method: WIRE
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: CNFL
          batch_id: '492084893'
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          priority: HIGH
          charges_paid_by: DEBT
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
    Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '1088009'
        creditor:
          proxy_id: 1-2345-45678-78-1
          proxy_type: NIDN
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          type: debit
          creation_date_time: '2022-09-13T08:23:49.227Z'
          value_date: '2022-09-13'
          instructed_amount: 88765
          status:
            date_time: '2022-09-13T08:23:56.332Z'
            code: ACTC
            description: Accepted
    Us-Ach-Ok-Response-Multiple:
      value:
      - debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: US
          instructed_currency: USD
          method: ACH
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
        reasons:
        - description: Citi validated and commercially completed the transaction. Account posting may be pending.
      - debtor:
          account: '110993444'
          name: Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: US
          instructed_currency: USD
          method: ACH
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 400.04
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    SEPA-VoP-Ok-Completed:
      value:
      - debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
          resolved_name: Hans Qwiss
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
        account_validation:
          uetr: 921a9445-97df-4118-9a55-68d14667656f
          account:
            number_validation: MATCH
            name_validation: MATCH
          status:
            code: ACCC
            description: Completed
            date_time: '2024-09-10T08:23:49.112Z'
          unstructured_remittance_info:
          - Name -MATCH , Account -MATCH
    SEPA-Ok-Completed:
      value:
      - debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
    AU-Ok-Completed-Status:
      value:
      - debtor:
          account: '5589089'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: AU
          address_lines:
          - ABC#GFD
          org_id: HIDC3344
          issuer: ABC pvt ltd
          bank_branch_id: '032'
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: AU
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: AU
          address_lines:
          - ABC#TEG
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
          virtual_account: hapen@okpraxis
          bank_branch_id: '032'
        ultimate_creditor:
          name: Karl Lewis
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: AU
          instructed_currency: AUD
          method: IP
          type: CT
          network: NPP
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: AUD
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
    Unauthorized-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: Request is not authorized
          action: Try again with valid credentials
          code: CC00007
    Jp-Ok-Response:
      value:
        debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: '0000027'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: '7788990'
          account_type: FU
        method:
          country: JP
          instructed_currency: JPY
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    SEPA-AllFields-Payment-Initiation-Request-Example:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          bank_id: ABCFDF
          name: Chris Topher
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          prvt_id: FGFGFGF
          issuer: ABC pvt ltd
          birth_date: '2024-09-10'
          birth_province: JKGKGLG
          birth_city: HYUYTREW
          scheme_name: RT1
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
          scheme_name: RT1
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
          scheme_name: RT1
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
          scheme_name: RT1
        method:
          country: IE
          instructed_currency: EUR
          method: IP
        transaction:
          creation_date_time: '2023-09-10T08:23:49.112Z'
          value_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          instructed_amount: 100
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
    AU-Nok-Rejected:
      value:
      - debtor:
          account: '5589089'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: AU
          address_lines:
          - ABC#GFD
          org_id: HIDC3344
          issuer: ABC pvt ltd
          bank_branch_id: '032'
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: AU
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: AU
          address_lines:
          - ABC#TEG
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
          virtual_account: hapen@okpraxis
          bank_branch_id: '032'
        ultimate_creditor:
          name: Karl Lewis
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: AU
          instructed_currency: AUD
          method: IP
          type: CT
          network: NPP
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: AUD
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: RC08
            description: Bank identification code is invalid.
    Ok-Response-Failed-Multiple:
      value:
      - debtor:
          account: '897654321'
        creditor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 3324an78555
          purpose: CASH
          network_id: '209323283934'
          type: debit
          creation_date_time: '2022-09-13T08:23:49.554Z'
          value_date: '2022-09-13'
          instructed_amount: 29876.98
          settlement_currency: THB
          settlement_amount: 29876.98
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
      - debtor:
          account: '444654321'
        creditor:
          proxy_id: efgh@gmail.com
          proxy_type: EMAL
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f00014d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 8824an78555
          purpose: CASH
          network_id: '209323283934'
          type: debit
          creation_date_time: '2022-09-13T08:23:49.554Z'
          value_date: '2022-09-13'
          instructed_amount: 16.98
          settlement_currency: THB
          settlement_amount: 16.98
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    Us-Ok-Response-Failed:
      value:
        debtor:
          account: '31216795'
          name: Stripe
          bank_id: '254689456'
          org_id: ABCDEQHNXJKLMNCGBH24
        creditor:
          account: '7788993038'
          name: JOHN
          bank_id: '789654778'
        method:
          country: US
          instructed_currency: USD
          method: IP
          type: CT
        ultimate_debtor:
          name: VA wallet merchant
          street_name: 4th Street
          org_id: ABCDEQHNXJKLMNCGBH21
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          type: debit
          creation_date_time: '2023-05-02T08:23:49.227Z'
          value_date: '2023-05-02'
          instructed_amount: 403
          purpose: CASH
          network_id: '889923283934'
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
            non_iso_code: '1183'
    IN-IMPS-Credit-Notification-Completed:
      value:
        debtor:
          account: '7852775432'
          name: JOHN
          bank_id: '561223'
          street_name: Paul
          building_number: '123'
          postal_code: '123456'
          city: Mumbai
          state: Maharashtra
        creditor:
          account: '7852775432'
          name: JOHN
          bank_id: '561223'
          street_name: Paul
          building_number: '123'
          postal_code: '123456'
          city: Mumbai
          state: Maharashtra
          country: IN
        method:
          network: IMPS
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          netwrok_id: '123456'
          local_reference: 7634an78543
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 404.01
          settlement_currency: INR
          settlement_amount: 404.01
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
    SEPA-IDP-Pending:
      value:
      - debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: PDNG
            description: Pending
    UK-BACS-Initiation-Request-Example:
      value:
        debtor:
          account: '927393038'
          bank_id: CITIGB2L
        creditor:
          account: '7788993038'
          name: STEVE
          bank_id: '789654'
        method:
          country: GB
          instructed_currency: GBP
          method: ACH
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          value_date: '2026-04-01'
          instructed_amount: 570.03
          payment_information_id: ABC202604010001A
    In-IMPS-Get-Response-Completed:
      value:
      - debtor:
          account: '7852775432'
          name: JOHN
          bank_id: '561223'
          street_name: Paul
          building_number: '123'
          postal_code: '123456'
          city: Mumbai
          state: Maharashtra
        creditor:
          account: '7852775432'
          name: JOHN
          bank_id: '561223'
          street_name: Paul
          building_number: '123'
          postal_code: '123456'
          city: Mumbai
          state: Maharashtra
          country: IN
        method:
          network: IMPS
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          netwrok_id: '123456'
          local_reference: 7634an78543
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 404.01
          settlement_currency: INR
          settlement_amount: 404.01
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
    Uk-Ok-Response:
      value:
        debtor:
          account: '110654321'
          name: PETER
          bank_id: '561288'
        creditor:
          account: '44227754321'
          name: JOHN
          bank_id: '561223'
        method:
          country: GB
          instructed_currency: GBP
          method: IP
          type: CT
        transaction:
          end_to_end_id: p434SKtUcd77
          uetr: 8f09214d-296c-411b-8e9c-810bf1d9fc77
          purpose: CASH
          network_id: '889923283934'
          type: credit
          creation_date_time: '2023-05-13T08:23:49.112Z'
          value_date: '2023-05-02'
          instructed_amount: 300.98
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    In-IMPS-Get-Response-Rejected:
      value:
      - debtor:
          account: '7852775432'
          name: JOHN
          bank_id: '561223'
          street_name: Paul
          building_number: '123'
          postal_code: '123456'
          city: Mumbai
          state: Maharashtra
        creditor:
          account: '7852775432'
          name: JOHN
          bank_id: '561223'
          street_name: Paul
          building_number: '123'
          postal_code: '123456'
          city: Mumbai
          state: Maharashtra
          country: IN
        method:
          network: IMPS
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          netwrok_id: '123456'
          local_reference: 7634an78543
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 404.01
          settlement_currency: INR
          settlement_amount: 404.01
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: NARR
            description: SUSPECTED FRAUD
    AU-IP-Completed:
      value:
        debtor:
          account: '5589089'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          account: '5589076'
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: AU
          instructed_currency: AUD
          method: IP
          type: CT
          network: NPP
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: AUD
          interbank_settlement_date: '2024-09-10'
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          settlement_amount: 90.91
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
    In-Neft-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '13'
        method:
          country: IN
          instructed_currency: INR
          method: NEFT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          instructed_amount: 300.03
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          value_date: '2023-05-23'
          purpose: SALA
          additional_info: Salary payment
    AU-IP-Rejected:
      value:
        debtor:
          account: '5589089'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          account: '5589076'
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: AU
          instructed_currency: AUD
          method: IP
          type: CT
          network: NPP
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: AUD
          interbank_settlement_date: '2024-09-10'
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          settlement_amount: 90.91
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: RC08
            description: Bank identification code is invalid.
    Uk-Ok-Response-Multiple:
      value:
      - debtor:
          account: '110654321'
          name: PETER
          bank_id: '561223'
        creditor:
          account: '44227754321'
          name: JOHN
          bank_id: '561223'
        method:
          country: GB
          instructed_currency: GBP
          method: IP
          type: CT
        transaction:
          end_to_end_id: p434SKtUcd77
          uetr: 8f09214d-296c-411b-8e9c-810bf1d9fc77
          purpose: CASH
          network_id: '889923283934'
          type: credit
          creation_date_time: '2023-05-13T08:23:49.112Z'
          value_date: '2023-05-02'
          instructed_amount: 300.98
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
      - debtor:
          account: '220654321'
          name: PETER
          bank_id: '561993'
        creditor:
          account: '87527754321'
          name: JOHN
          bank_id: '561883'
        method:
          country: GB
          instructed_currency: GBP
          method: IP
          type: CT
        transaction:
          end_to_end_id: p434SKtUcd77
          uetr: 8f07814d-296c-411b-8e9c-810bf1d9fc77
          purpose: CASH
          network_id: '779923283934'
          type: credit
          creation_date_time: '2023-05-13T08:23:49.112Z'
          value_date: '2023-05-02'
          instructed_amount: 301.98
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    SEPA-IDP-Pending-Status:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: BirdView
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Bel fast
          town_location_name: Bel fast
          district_name: Bel fast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABCpvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: NewArk
          town_location_name: NewArk
          district_name: NewArk
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBHpvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYPpvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: PDNG
            description: Pending
    SEPA-AllFields-Payment-Initiation-Response-Example:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          bank_id: ABCFDF
          name: Chris Topher
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          prvt_id: FGFGFGF
          issuer: ABC pvt ltd
          birth_date: '2024-09-10'
          birth_province: JKGKGLG
          birth_city: HYUYTREW
          scheme_name: RT1
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
          scheme_name: RT1
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
          scheme_name: RT1
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
          scheme_name: RT1
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
        transaction:
          creation_date_time: '2023-09-10T08:23:49.112Z'
          value_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          instructed_amount: 100
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.332Z'
            code: ACTC
            description: Accepted
    Un-Supported-Media-Type-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: Media type is invalid
          action: Provide valid media type
          code: CC00002
    Idempotency-Id-Conflict-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: Idempotency-Id provided is currently being used in another request
          action: please do not repeat the same request again
          code: VC00016
    In-Imps-Fir-Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000038
          bank_name: SCBB
          bank_account: '1122334455'
        ultimate_debtor:
          name: JOHN
          bank_id: HDFC000038
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        instructing_agent:
          bank_name: DFCI
          bank_id: DFCI12345
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          creation_date_time: '2023-05-23T08:23:49.227Z'
          instructed_amount: 200.02
          category: FIR
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACTC
            description: Accepted
    In-Imps-Fir-Ok-Response-Failed:
      value:
        debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000038
          bank_name: SCBB
          bank_account: '1122334455'
        ultimate_debtor:
          name: JOHN
          bank_id: HDFC000038
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        instructing_agent:
          bank_name: DFCI
          bank_id: DFCI12345
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          creation_date_time: '2023-05-23T08:23:49.227Z'
          instructed_amount: 200.02
          category: FIR
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    MX-DFT-Rejected:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: RJCT
            description: Rejected
          reasons:
          - code: NARR
            description: Invalid Account Number.
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
    In-Imps-Fir-Ok-Response-Multiple:
      value:
      - debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000038
          bank_name: SCBB
          bank_account: '1122334455'
        ultimate_debtor:
          name: JOHN
          bank_id: HDFC000038
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        instructing_agent:
          bank_name: DFCI
          bank_id: DFCI12345
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          creation_date_time: '2023-05-23T08:23:49.227Z'
          instructed_amount: 200.02
          category: FIR
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
      - debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000038
          bank_name: SCBB
          bank_account: '1122334455'
        ultimate_debtor:
          name: JOHN
          bank_id: HDFC000038
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        instructing_agent:
          bank_name: DFCI
          bank_id: DFCI12345
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          creation_date_time: '2023-05-23T08:23:49.227Z'
          instructed_amount: 200.02
          category: FIR
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    AR-IP-Payment-Initiation-Response-Example:
      value:
        method:
          country: AR
          instructed_currency: ARS
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: AR0037217563
          uetr: 4f09288d-296c-494b-8e9c-810bf1d9fc93
          instructed_amount: 103.76
          creation_date_time: '2025-11-11T08:23:49.112Z'
          purpose: '06'
          status:
            date_time: '2025-11-11T08:23:50.665Z'
            code: ACTC
            description: Accepted
        debtor:
          account: '1234567809'
          name: Abc Argentina
        creditor:
          account: 0130003123456789123456
          bank_id: '013'
          name: Passi Saludas
          tax_id: '20123452875'
    SEPA-Ok-Reject-Final:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRSpvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBHpvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYPpvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 1,000,000.00
    MX-DFT-Completed:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: ACCC
            description: Completed
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
    MX-DFT-Status-Get-Response-Completed:
      value:
      - method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: ACCC
            description: Completed
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    Ok-Response:
      value:
        debtor:
          account: '897654321'
        creditor:
          account: '44227754321'
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 7634an78543
          purpose: CASH
          network_id: '209323283934'
          type: credit
          bill_id_1: '77889900'
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 29876.98
          settlement_currency: THB
          settlement_amount: 29876.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    Uk-Rfi-Compliance-Pending:
      value:
        debtor:
          account: '220654001'
          name: MARK
          bank_id: '789546'
        creditor:
          account: 00227754885
          name: STEVE
          bank_id: '561223'
        method:
          country: GB
          instructed_currency: GBP
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 405
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: PDNG
            description: Pending
          reasons:
          - code: RECI
            description: Transaction is in compliance review request for further information
    Jp-Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: '688291098'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: FGHJ0985026
          name_conversion_flag: Y
        method:
          country: JP
          instructed_currency: JPY
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACTC
            description: Accepted
    SEPA-VoP-Nok-Completed-Status:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: BirdView
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Bel fast
          town_location_name: Bel fast
          district_name: Bel fast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABCpvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: NewArk
          town_location_name: NewArk
          district_name: NewArk
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRSpvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYP pvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
        account_validation:
          uetr: 921a9445-97df-4118-9a55-68d14667656f
          account:
            number_validation: MISMATCH
            name_validation: MISMATCH
          status:
            code: RJCT
            description: Rejected
            date_time: '2024-09-10T08:23:49.112Z'
          reasons:
            code: AC01
            description: Invalid Account Number
          unstructured_remittance_info:
          - Name -MISMATCH , Account -MISMATCH
    Ok-Response-Failed:
      value:
        debtor:
          account: '897654321'
        creditor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 3324an78555
          purpose: CASH
          network_id: '209323283934'
          type: debit
          creation_date_time: '2022-09-13T08:23:49.554Z'
          value_date: '2022-09-13'
          instructed_amount: 29876.98
          settlement_currency: THB
          settlement_amount: 29876.98
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    Us-Wire-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '11223344'
          name: sample name
          street_name: sample street Suite
          building_number: '1309'
          postal_code: '12345'
          city: ABCDEFG
          state: WY
          country: US
          bank_id: '021000000'
        ultimate_debtor:
          name: Sample City Air
          org_id: '51143722'
          address_lines:
          - A100
          - Washington
          - US
        creditor:
          account: '123465789'
          name: ABCD INC
          address_lines:
          - A100 IAT building
          - Washington*DC\
          - US*20037\
          bank_id: '031207607'
        method:
          country: US
          instructed_currency: USD
          method: WIRE
        transaction:
          end_to_end_id: F5V6746ERTY
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          value_date: '2023-05-23'
          instructed_amount: 200.02
          priority: NORM
          charges_paid_by: SHAR
          payment_information_id: '1122334455'
    Us-Ach-Iat-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '100000000228'
          name: Stripe
          street_name: Apple Street
          building_number: A123
          postal_code: '127444'
          city: Atlanta
          state: GA
          country: US
          org_id: '3052963052'
        creditor:
          bank_id: '021000021'
          bank_name: BAnkUS
          name: Jennifer Peter
          street_name: South East lane
          building_number: D404
          postal_code: '123445'
          city: Belmont
          state: CA
          country: US
          account: '12345678'
          account_type: CACC
        method:
          country: US
          instructed_currency: USD
          method: ACH
        transaction:
          payment_information_id: '87940'
          category: IAT
          end_to_end_id: r434SKtUcdGQ
          value_date: '2023-05-23'
          instructed_amount: 200.02
        ultimate_debtor:
          name: VA wallet merchant
          org_id: /TXID/1234567809
          address_lines:
          - A100 IAT building
          - Washington*DC\
          - US*20037\
        intermediary:
        - bank_id: 021000089
          bank_name: USbank
          bank_country: US
        ultimate_creditor:
          name: ABCD INC
    Us-Ok-Response:
      value:
        debtor:
          account: '31216795'
          name: Stripe
          bank_id: '254689456'
          org_id: ABCDEQHNXJKLMNCGBH24
        creditor:
          account: '7788993038'
          name: JOHN
          bank_id: '789654778'
        method:
          country: US
          instructed_currency: USD
          method: IP
          type: CT
        ultimate_debtor:
          name: VA wallet merchant
          street_name: 4th Street
          org_id: ABCDEQHNXJKLMNCGBH21
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          type: debit
          creation_date_time: '2023-05-02T08:23:49.227Z'
          value_date: '2023-05-02'
          instructed_amount: 403
          purpose: CASH
          network_id: '889923283934'
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    Us-Ach-Ok-Response:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: US
          instructed_currency: USD
          method: ACH
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
          Reason:
            non_iso_code: 008T
    SEPA-Ok-Reject-Status:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRSpvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBHpvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYPpvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 1,000,000.00
    MX-BKT-Status-Get-Response-Completed:
      value:
      - method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: ACCC
            description: Completed
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    IN-IMPS-Credit-Notification-Rejected:
      value:
        debtor:
          account: '7852775432'
          name: JOHN
          bank_id: '561223'
          street_name: Paul
          building_number: '123'
          postal_code: '123456'
          city: Mumbai
          state: Maharashtra
        creditor:
          account: '7852775432'
          name: JOHN
          bank_id: '561223'
          street_name: Paul
          building_number: '123'
          postal_code: '123456'
          city: Mumbai
          state: Maharashtra
          country: IN
        method:
          network: IMPS
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          netwrok_id: '123456'
          local_reference: 7634an78543
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 404.01
          settlement_currency: INR
          settlement_amount: 404.01
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: NARR
            description: SUSPECTED FRAUD
    AU-Ok-Completed:
      value:
        debtor:
          account: '5589089'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: Bird View
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: AU
          address_lines:
          - ABC#GFD
          org_id: HIDC3344
          issuer: ABC pvt ltd
          bank_branch_id: '032'
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          issuer: JKL pvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: AU
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: New Ark
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: AU
          address_lines:
          - ABC#TEG
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
          virtual_account: hapen@okpraxis
          bank_branch_id: '032'
        ultimate_creditor:
          name: Karl Lewis
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: AU
          instructed_currency: AUD
          method: IP
          type: CT
          network: NPP
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: AUD
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
    MX-DFT-Status-Single-Get-Response-Rejected:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: RJCT
            description: Rejected
          reasons:
          - code: NARR
            description: Invalid Account Number.
        debtor:
          account: '12345678901'
          bank_id: CITIMXMM
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    MX-DFT-Status-Single-Get-Response-Completed:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: ACCC
            description: Completed
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    In-Upi-Payment-Initiation-Request-Example:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: UPI
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          instructed_amount: 300.03
    Proxy-Transaction-Get-Multiple:
      value:
      - debtor:
          account: '897654321'
        creditor:
          proxy_id: '55448877992'
          proxy_type: BIID
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/558SKtUcdGQ
          uetr: 5f09214d-596c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          batch_id: '221084801'
          network_id: '209323283934'
          bill_id_1: '554488779934'
          type: debit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 402.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
      - debtor:
          account: '332654321'
        creditor:
          proxy_id: '55448877992'
          proxy_type: BIID
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/558SKtUcdGQ
          uetr: 5f77714d-596c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          batch_id: '771084801'
          network_id: '209323283934'
          bill_id_1: '554488779934'
          type: debit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 402.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
    Qr-Transaction-Get-Multiple:
      value:
      - debtor:
          account: '897654321'
        creditor:
          account: '552654301'
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 7634an78543
          purpose: CASH
          network_id: '209323283934'
          bill_id_1: '112288779001'
          type: credit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 404.01
          settlement_currency: THB
          settlement_amount: 404.01
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
      - debtor:
          account: '001654321'
        creditor:
          account: '552654301'
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09288d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 7884an78543
          purpose: CASH
          network_id: '209323283934'
          bill_id_1: '112288779001'
          type: credit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 405.01
          settlement_currency: THB
          settlement_amount: 405.01
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
    Payer-Id-Transaction-Get-Multiple:
      value:
      - debtor:
          account: '897654321'
        creditor:
          account: '54805587254'
          virtual_account: '9987654321'
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 7634an78543
          purpose: CASH
          network_id: '209323283934'
          type: credit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 29876.98
          settlement_currency: THB
          settlement_amount: 29876.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
      - debtor:
          account: '660654321'
        creditor:
          account: '78905587254'
          virtual_account: '9987654321'
        method:
          country: TH
          instructed_currency: THB
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          local_reference: 7634an78543
          purpose: CASH
          network_id: '209323283934'
          type: credit
          creation_date_time: '2022-09-13T08:23:49.112Z'
          value_date: '2022-09-13'
          instructed_amount: 286.98
          settlement_currency: THB
          settlement_amount: 286.98
          status:
            date_time: '2022-09-13T08:23:56.223Z'
            code: ACCC
            description: Completed
    In-Neft-Ok-Response-Multiple:
      value:
      - debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: IN
          instructed_currency: INR
          method: NEFT
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: credit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2025-07-08'
          instructed_amount: 300.03
          settlement_amount: 300.03
          settlement_currency: INR
          network_id: NET123456
          local_reference: LOCAL123456
          reference: REF123456
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
        reasons:
        - description: Citi validated and commercially completed the transaction. Account posting may be pending.
      - debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: IN
          instructed_currency: INR
          method: NEFT
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGD
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: credit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2025-07-08'
          instructed_amount: 301.03
          settlement_amount: 301.03
          settlement_currency: INR
          network_id: NET123456
          local_reference: LOCAL123456
          reference: REF123456
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
        reasons:
        - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    MX-DFT-Payment-Initiation-Request-Example:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: IP
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          instructed_amount: 100.51
        debtor:
          account: '12345678901'
          bank_branch_id: '485'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    In-Upi-Ok-Response-Multiple-Failed:
      value:
      - debtor:
          proxy_id: a93d@gmail.com
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: UPI
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
        reasons:
        - code: AM02
          description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
      - debtor:
          proxy_id: a70d@gmail.com
          account: '110993444'
          name: Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: UPI
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 400.04
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
        reasons:
        - code: AM02
          description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    Uk-Ok-Response-Failed-Multiple:
      value:
      - debtor:
          account: '220654001'
          name: MARK
          bank_id: '789546'
        creditor:
          account: 00227754885
          name: STEVE
          bank_id: '561223'
        method:
          country: GB
          instructed_currency: GBP
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 405
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
            non_iso_code: '1183'
      - debtor:
          account: '118654001'
          name: MARK
          bank_id: '789546'
        creditor:
          account: '11227754885'
          name: STEVE
          bank_id: '561223'
        method:
          country: GB
          instructed_currency: GBP
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 4f09214d-282c-494b-8e9c-810bf1d9fc93
          purpose: CASH
          network_id: '88823283934'
          type: debit
          creation_date_time: '2023-05-02T08:23:49.554Z'
          value_date: '2023-05-02'
          instructed_amount: 505
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
            non_iso_code: '1183'
    In-Imps-Fir-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000038
          bank_name: SCBB
          bank_account: '1122334455'
        ultimate_debtor:
          name: JOHN
          bank_id: HDFC000038
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        instructing_agent:
          bank_name: DFCI
          bank_id: DFCI12345
          street_name: SCBB
          building_number: '11'
          city: LOS
          state: TEXAS
          country: US
          postal_code: '1234'
          org_id: '5678902'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          instructed_amount: 200.02
          category: FIR
    MX-BKT-Payment-Initiation-Response-Example:
      value:
        method:
          country: MX
          instructed_currency: MXN
          method: BKT
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            date_time: '2025-11-11T08:23:50.665Z'
            code: ACTC
            description: Accepted
        debtor:
          account: '12345678901'
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    Us-Wire-Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '927393038'
          name: Stripe
          bank_id: '111111111'
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for debtor agent
        ultimate_debtor:
          name: VA wallet merchant
          address_lines:
          - address line
          org_id: '222222222'
        creditor:
          account: '333333333'
          name: John Len
          bank_id: '444444444'
          bank_name: Citi bank
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for creditor agent
        intermediary:
        - bank_id: '444444444'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '555555555'
        - bank_id: '666666666'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '777777777'
        method:
          country: US
          instructed_currency: USD
          method: WIRE
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: CNFL
          batch_id: '492084893'
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          priority: HIGH
          charges_paid_by: DEBT
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACTC
            description: Accepted
    SEPA-VoP-Ok-Completed-Final:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: BirdView
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKLpvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: NewArk
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
          resolved_name: Hans Qwiss
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBHpvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYPpvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
        account_validation:
          uetr: 921a9445-97df-4118-9a55-68d14667656f
          account:
            number_validation: MATCH
            name_validation: MATCH
          status:
            code: ACCC
            description: Completed
            date_time: '2024-09-10T08:23:49.112Z'
          unstructured_remittance_info:
          - Name -MATCH , Account -MATCH
    Bad-Request-Example:
      value:
        ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab
        error_details:
        - issue: instructed_amount is missing
          action: Provide valid instructed_amount
          code: VC00010
    Internal-Server-Error-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: Request was not processed
          code: CC00004
    Jp-Ok-Response-Multiple:
      value:
      - debtor:
          account: '110654321'
          name: シテイ タロウ
        creditor:
          account: '44227754321'
          name: ABC CORP
          bank_id: '561223'
        method:
          country: JP
          instructed_currency: JPY
          method: IP
          type: CT
        transaction:
          end_to_end_id: p434SKtUcd77
          uetr: 8f09214d-296c-411b-8e9c-810bf1d9fc77
          purpose: CASH
          network_id: '889923283934'
          type: credit
          edi_info: JPY1234567
          creation_date_time: '2023-05-13T08:23:49.112Z'
          value_date: '2023-05-02'
          instructed_amount: 300.98
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
      - debtor:
          account: '220654321'
          name: PETER
        creditor:
          account: '87527754321'
          name: JOHN
          bank_id: '561223'
        method:
          country: JP
          instructed_currency: JPY
          method: IP
          type: CT
        transaction:
          end_to_end_id: p434SKtUcd77
          uetr: 8f07814d-296c-411b-8e9c-810bf1d9fc77
          purpose: CASH
          network_id: '779923283934'
          type: credit
          edi_info: JPY1234567
          creation_date_time: '2023-05-13T08:23:49.112Z'
          value_date: '2023-05-02'
          instructed_amount: 301.98
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    In-Ok-Response:
      value:
        debtor:
          account: '789054321'
          name: PETER
          bank_id: '561288'
        creditor:
          account: '7852775432'
          name: JOHN
          bank_id: '561223'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: p434SKtUcd77
          uetr: 8f09214d-296c-411b-8e9c-810bf1d9fc77
          purpose: CASH
          network_id: '889923283934'
          type: credit
          creation_date_time: '2023-05-13T08:23:49.112Z'
          value_date: '2023-05-02'
          instructed_amount: 300.98
          status:
            date_time: '2023-05-02T08:23:56.223Z'
            code: ACCC
            description: Completed
          reasons:
          - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    MX-DFT-Status-Get-Response-Rejected:
      value:
      - method:
          country: MX
          instructed_currency: MXN
          method: IP
          type: CT
        transaction:
          value_date: '2025-11-11'
          end_to_end_id: CCAPI0603180692
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          instructed_amount: 100.51
          creation_date_time: '2025-11-11T08:23:49.112Z'
          status:
            code: RJCT
            description: Rejected
          reasons:
          - code: NARR
            description: Invalid Account Number.
        debtor:
          account: '12345678901'
          bank_id: CITIMXMM
          bank_branch_id: '001'
        creditor:
          account: '900900981912345678'
          bank_id: '012'
          name: Carnage
          account_type: '05'
    Jp-Ok-Response-Failed:
      value:
        debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: '0000027'
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: 000A025
          account_type: FU
        method:
          country: JP
          instructed_currency: JPY
          method: IP
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    In-Neft-Payment-Initiation-Response-Example:
      value:
        debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '13'
        method:
          country: IN
          instructed_currency: INR
          method: NEFT
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: SALA
          type: debit
          additional_info: Salary payment
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACTC
            description: Accepted
    In-Imps-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: CITI0000038
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: UTIB0005144
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: IMPS
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          instructed_amount: 200.02
    SEPA-VoP-Ok-Completed-Status:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          proxy_type: EMAL
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: BirdView
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Belfast
          town_location_name: Belfast
          district_name: Belfast
          state: California
          country: IE
          address_lines:
          - ABC#GFD
          anybic: ABCDIE20
          lei: ABCDIE20XXX
          org_id: HIDC3344
          issuer: ABC pvt ltd
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          lei: ABKLIE20XXX
          issuer: JKLpvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: IE
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: NewArk
          town_location_name: New Ark
          district_name: New Ark
          state: California
          country: IE
          address_lines:
          - ABC#TEG
          anybic: POLVIE20
          lei: POLVIE20XXX
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
          resolved_name: Hans Qwiss
        ultimate_creditor:
          name: Karl Lewis
          anybic: ABCJIE20
          lei: ABCJIE20XXX
          org_id: 55879VB
          issuer: VBHpvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: IE
          instructed_currency: EUR
          method: IP
          type: CT
          network: RT1
        transaction:
          type: debit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: EUR
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference_information_code: RADM
            creditor_reference_issuer: HYPpvt ltd
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: ACCC
            description: Completed
        account_validation:
          uetr: 921a9445-97df-4118-9a55-68d14667656f
          account:
            number_validation: MATCH
            name_validation: MATCH
          status:
            code: ACCC
            description: Completed
            date_time: '2024-09-10T08:23:49.112Z'
          unstructured_remittance_info:
          - Name -MATCH , Account -MATCH
    In-Neft-Ok-Response:
      value:
        debtor:
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
        method:
          country: IN
          instructed_currency: INR
          method: NEFT
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: credit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2025-07-08'
          instructed_amount: 300.03
          settlement_amount: 300.03
          settlement_currency: INR
          network_id: NET123456
          local_reference: LOCAL123456
          reference: REF123456
          status:
            date_time: '2023-05-23T08:23:49.230Z'
            code: ACCC
            description: Completed
        reasons:
        - description: Citi validated and commercially completed the transaction. Account posting may be pending.
    US-WIRE-Ok-Response-Multiple-Failed:
      value:
      - debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: '111111111'
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for debtor agent
        ultimate_debtor:
          name: Jack
          address_lines:
          - address line
          org_id: '222222222'
        creditor:
          account: '333333333'
          name: John Len
          bank_id: '444444444'
          bank_name: Citi bank
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for creditor agent
        intermediary:
        - bank_id: '444444444'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '555555555'
        - bank_id: '666666666'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '777777777'
        method:
          country: US
          instructed_currency: USD
          method: WIRE
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: CNFL
          batch_id: '492084893'
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          priority: HIGH
          charges_paid_by: DEBT
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
        reasons:
        - code: AM02
          description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
      - debtor:
          account: '927393038'
          name: Chris Topher
          bank_id: '111111111'
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for debtor agent
        ultimate_debtor:
          name: Jack
          address_lines:
          - address line
          org_id: '222222222'
        creditor:
          account: '333333333'
          name: John Len
          bank_id: '444444444'
          bank_name: Citi bank
          country: US
          address_lines:
          - address line
          bank_instructions: instruction for creditor agent
        intermediary:
        - bank_id: '444444444'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '555555555'
        - bank_id: '666666666'
          bank_name: bank name
          bank_country: US
          bank_address_lines:
          - bank address line
          bank_account_id: '777777777'
        method:
          country: US
          instructed_currency: USD
          method: WIRE
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: CNFL
          batch_id: '492084893'
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 200.02
          priority: HIGH
          charges_paid_by: DEBT
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
        reasons:
        - code: AM02
          description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    In-Upi-Ok-Response-Failed:
      value:
        debtor:
          proxy_id: a93d@gmail.com
          account: '520993444'
          name: Chris Topher
          bank_id: CITI0000027
        creditor:
          account: '7788993038'
          name: John Len
          bank_id: IDIB000A025
          account_type: '02'
        method:
          country: IN
          instructed_currency: INR
          method: UPI
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          purpose: OTHR
          type: debit
          creation_date_time: '2023-05-23T08:23:49.227Z'
          value_date: '2023-05-23'
          instructed_amount: 300.03
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: AM02
            description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00
    AU-Nok-Rejected-status:
      value:
        debtor:
          account: '5589089'
          name: Chris Topher
          bank_id: CITI0000027
          department: Loan
          sub_department: Personal
          street_name: 123 street
          building_number: '67'
          building_name: BirdView
          floor: 3rd
          post_box: Bhesil Dist
          room: '234'
          postal_code: '196278'
          city: Bel fast
          town_location_name: Bel fast
          district_name: Bel fast
          state: California
          country: AU
          address_lines:
          - ABC#GFD
          org_id: HIDC3344
          issuer: ABCpvt ltd
          bank_branch_id: '032'
        ultimate_debtor:
          name: Heri Tig
          anybic: ABKLIE20
          issuer: JKLpvt ltd
          birth_date: '1989-09-08'
          birth_province: Cali
          birth_city: New Jersey
          birth_country: AU
        creditor:
          bank_id: TYEG6758
          name: Retin Sew
          department: Mortgage
          sub_department: Car
          street_name: 4th Street
          building_number: '29'
          building_name: Antella
          floor: 9th
          post_box: Calst
          room: '999'
          postal_code: '901223'
          city: NewArk
          town_location_name: NewArk
          district_name: NewArk
          state: California
          country: AU
          address_lines:
          - ABC#TEG
          issuer: QRS pvt ltd
          birth_province: California
          prvt_id: HJK876
          account: '5589076'
          proxy_type: EMAL
          proxy_id: qwerty@kmail
          virtual_account: hapen@okpraxis
          bank_branch_id: '032'
        ultimate_creditor:
          name: Karl Lewis
          org_id: 55879VB
          issuer: VBH pvt ltd
          birth_province: Cali
        instructing_agent:
          bank_id: GLRB7983
        instructed_agent:
          bank_id: TRHG1122
        method:
          country: AU
          instructed_currency: AUD
          method: IP
          type: CT
          network: NPP
        transaction:
          type: credit
          creation_date_time: '2023-09-10T08:23:49.112Z'
          settlement_currency: AUD
          interbank_settlement_date: '2024-09-10'
          category_purpose: YUOP
          instruction_id: ABCDFGH123
          end_to_end_id: r/434SKtUcd01
          uetr: 921a9445-97df-4118-9a55-68d14667624c
          network_id: EEEER3456
          settlement_amount: 90.91
          acceptance_date_time: '2023-09-10T08:23:49.112Z'
          charges_paid_by: SLEV
          purpose: PAYR
          regulatory_reporting:
            type: More details here
            code: NOC
          unstructured_remittance_info:
          - More details of transaction
          structured_remittance_info:
            creditor_reference: More details
          status:
            date_time: '2022-09-13T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
          - code: RC08
            description: Bank identification code is invalid.
    UK-BACS-Reject-Example:
      value:
        debtor:
          account: '927393038'
          bank_id: CITIGB2L
          name: MARK
        creditor:
          account: '7788993038'
          name: STEVE
          bank_id: '789654'
        method:
          country: GB
          instructed_currency: GBP
          method: ACH
          type: CT
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          value_date: '2026-04-01'
          instructed_amount: 570.03
          creation_date_time: '2026-04-01T08:23:49.554Z'
          status:
            date_time: '2026-04-01T08:23:56.665Z'
            code: RJCT
            description: Rejected
          reasons:
            code: MD03
            description: PYMNT COMBINATION NOT ALLOWED
            non_iso_code: '00000056'
    Jp-Payment-Initiation-Request-Example:
      value:
        debtor:
          account: '927393038'
          name: ABC CORP
          bank_id: '9000038'
        creditor:
          account: '7788993038'
          name: シテイ タロウ
          bank_id: '7894561'
          account_type: FU
        method:
          country: JP
          instructed_currency: JPY
          method: IP
        transaction:
          end_to_end_id: r/434SKtUcdGQ
          uetr: 5d09214d-296c-494b-8e9c-810bf1d9fc66
          instructed_amount: 200
          value_date: '2024-05-02'
    Service-Unavailable-Gateway-Example:
      value:
        httpCode: '503'
        httpMessage: Service is temporarily unavailable
        moreInformation: Retry the request after some time
    Not-Found-Gateway-Error-Example:
      value:
        httpCode: '404'
        httpMessage: Not Found
        moreInformation: No resources match requested URI
    Gateway-Timeout-Example:
      value:
        httpCode: '504'
        httpMessage: Gateway Timeout
        moreInformation: 'Response took longer than timeout: PTxxS'
    Method-Not-Allowed-Gateway-Error-Example:
      value:
        httpCode: '405'
        httpMessage: Method Not Allowed
        moreInformation: The method is not allowed for the requested URL
    Un-Supported-Media-Type-Service-Error-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: Media type not supported
          action: please use valid content-type in header
          code: CC00002
    Bad-Request-Gateway-Error-Example:
      value:
        httpCode: '400'
        httpMessage: Bad Request
        moreInformation: please provide valid value for request
    Internal-Server-Gateway-Error-Example:
      value:
        httpCode: '500'
        httpMessage: Internal Server Error
        moreInformation: Internal Server Error
    Idempotency-Id-Conflict-Example_2:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: Idempotency-Id provided is currently being used in another request
          action: please do not repeat the same request again
    Bad-Request-Service-Error-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627901
        error_details:
        - issue: record that you are searching is not found
          action: resend the request with valid values
          code: VC00003
    Unauthorized-Gateway-Error-Example:
      value:
        httpCode: '401'
        httpMessage: Unauthorized
        moreInformation: The server could not verify that you are authorized to access the URL
    Too-Many-Requests-Gateway-Example:
      value:
        httpCode: '429'
        httpMessage: Too Many Requests
        moreInformation: Rate Limit exceeded
    Internal-Server-Service-Error-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: unable to serve your request at this moment
          action: Please refer to documentation provided or contact support team
          code: CC00004
    Unauthorized-Service-Error-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - issue: User not authorized for this functionality
          action: please use valid credentials to access this functionality
          code: CC00007
    Un-Supported-Media-Type-Gateway-Error-Example:
      value:
        httpCode: '415'
        httpMessage: Unsupported Media Type
        moreInformation: Unsupported Content-Type application/octet-stream
    Forbidden-Service-Example:
      value:
        ref_id: ec689822-9864-4c4d-9d68-222467627902
        error_details:
        - code: CC00008
          issue: User does not have privilege to access this functionality.
          action: Please reach out to support team to enable this feature.
  parameters:
    Off-Set-Param:
      in: query
      name: offset
      required: false
      schema:
        type: integer
        default: 0
      description: Payment status inquiry result page you want Citi to respond to you with
    Limit-Param:
      in: query
      name: limit
      required: false
      schema:
        type: integer
        maximum: 1000
        minimum: 1
        default: 100
      description: "Limit you want Citi to apply to your payment status inquiry results \n- Maximum value is 1,000."
    Event-Type:
      name: Event-Type
      in: header
      required: true
      description: Event Type
      schema:
        type: string
    Event-Name:
      name: Event-Name
      in: header
      required: true
      description: Event Name
      schema:
        type: string
    Consent-Id:
      in: query
      name: consent_id
      description: Unique identifier for the consent resource. This field is required for operations that act on an existing consent.
      required: true
      schema:
        maxLength: 128
        minLength: 1
        type: string
        title: Consent Id
    TPP-Code:
      in: header
      name: TPP-Code
      required: true
      schema:
        type: string
        title: TPP-Code
        minLength: 4
        maxLength: 4
        pattern: '[0-9][0-9][0-9][0-9]'
      description: The code of the Authorized Payment Service Provider sending the request. Required if the consent_id is used. This description is intentionally expanded to clarify request usage, response expectations, validation behavior, and integration context for PSD2-compliant API consumers.
    Date:
      in: header
      name: Date
      required: true
      schema:
        type: string
        title: <day-name>, <day> <month> <year> <hour>:<minute>:<second> GMT
        pattern: (Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{1,2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} GMT$
      description: 'Date and time when the request is created/sent by the TPP. <br> <br> <b> Format: </b> day-name, day month year hour:minute:second GMT <br> (for example, Mon, 8 Jul 2026 14:25:30 GMT).'
    Request-ID:
      in: header
      name: Request-ID
      required: true
      schema:
        type: string
        title: Request-ID
        minLength: 1
        maxLength: 36
      description: The request identifier specific to the call determined by the PSP initiating the request. This description is intentionally expanded to clarify request usage, response expectations, validation behavior, and integration context for PSD2-compliant API consumers.
    Payment-Id:
      name: payment-Id
      description: The identifier for a given payment instruction
      in: path
      required: true
      schema:
        type: string
    PSU-IP-Address:
      in: header
      name: PSU-IP-Address
      required: true
      schema:
        type: string
        title: PSU-IP-Address
        minLength: 1
        maxLength: 15
      description: PSU-IP address of the payment service user (ipv4). Required if the consent_id is used in the request.
  responses:
    Unsupported-Media-Type:
      description: Unsupported Media Type
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-Response'
          examples:
            Un-Supported-Media-Type-Example:
              $ref: '#/components/examples/Un-Supported-Media-Type-Example'
    Not-Found:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-Response'
          examples:
            Not-Found-Example:
              $ref: '#/components/examples/Not-Found-Example'
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-Response'
          examples:
            Idempotency-Id-Conflict-Example:
              $ref: '#/components/examples/Idempotency-Id-Conflict-Example'
            Duplicate-Payment-Conflict-Example:
              $ref: '#/components/examples/Duplicate-Payment-Conflict-Example'
    Internal-Server-Error:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-Response'
          examples:
            Internal-Server-Error-Example:
              $ref: '#/components/examples/Internal-Server-Error-Example'
    Method-Not-Allowed:
      description: Method Not Allowed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-Response'
          examples:
            Method-Not-Allowed-Example:
              $ref: '#/components/examples/Method-Not-Allowed-Example'
    Bad-Request:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-Response'
          examples:
            Bad-Request-Example:
              $ref: '#/components/examples/Bad-Request-Example'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error-Response'
          examples:
            Unauthorized-Example:
              $ref: '#/components/examples/Unauthorized-Example'
    Unauthorized_2:
      description: Unauthorized
      content:
        application/json:
          schema:
            title: UnauthorizedErrorResponse
            anyOf:
            - $ref: '#/components/schemas/Service-Error-Response'
            - $ref: '#/components/schemas/Gateway-Error-Response'
          examples:
            Unauthorized-Service-Error-Example:
              $ref: '#/components/examples/Unauthorized-Service-Error-Example'
            Unauthorized-Gateway-Error-Example:
              $ref: '#/components/examples/Unauthorized-Gateway-Error-Example'
    Too-Many-Requests:
      description: Too Many Requests - Rate limit exceeded. Retry after the specified time.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Gateway-Error-Response'
          examples:
            Too-Many-Requests-Gateway-Example:
              $ref: '#/components/examples/Too-Many-Requests-Gateway-Example'
    Gateway-Timeout:
      description: Gateway Timeout
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Gateway-Error-Response'
          examples:
            Gateway-Timeout-Example:
              $ref: '#/components/examples/Gateway-Timeout-Example'
    Not-Found_2:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Gateway-Error-Response'
          examples:
            Not-Found-Gateway-Error-Example:
              $ref: '#/components/examples/Not-Found-Gateway-Error-Example'
    Service-Unavailable:
      description: Service Unavailable - The server is temporarily unable to  handle the request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Gateway-Error-Response'
          examples:
            Service-Unavailable-Gateway-Example:
              $ref: '#/components/examples/Service-Unavailable-Gateway-Example'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Service-Error-Response'
          examples:
            Forbidden-Service-Example:
              $ref: '#/components/examples/Forbidden-Service-Example'
    Unsupported-Media-Type_2:
      description: Unsupported Media Type
      content:
        application/json:
          schema:
            title: UnsupportedMediaTypeErrorResponse
            anyOf:
            - $ref: '#/components/schemas/Gateway-Error-Response'
            - $ref: '#/components/schemas/Service-Error-Response'
          examples:
            Un-Supported-Media-Type-Gateway-Error-Example:
              $ref: '#/components/examples/Un-Supported-Media-Type-Gateway-Error-Example'
            Un-Supported-Media-Type-Service-Error-Example:
              $ref: '#/components/examples/Un-Supported-Media-Type-Service-Error-Example'
    Internal-Server-Error_2:
      description: Internal Server Error
      content:
        application/json:
          schema:
            title: InternalServerErrorResponse
            anyOf:
            - $ref: '#/components/schemas/Gateway-Error-Response'
            - $ref: '#/components/schemas/Service-Error-Response'
          examples:
            Internal-Server-Service-Error-Example:
              $ref: '#/components/examples/Internal-Server-Service-Error-Example'
            Internal-Server-Gateway-Error-Example:
              $ref: '#/components/examples/Internal-Server-Gateway-Error-Example'
    Method-Not-Allowed_2:
      description: Method Not Allowed
      content:
        application/json:
          schema:
            title: MethodNotAllowedErrorResponse
            anyOf:
            - $ref: '#/components/schemas/Gateway-Error-Response'
            - $ref: '#/components/schemas/Service-Error-Response'
          examples:
            Method-Not-Allowed-Gateway-Error-Example:
              $ref: '#/components/examples/Method-Not-Allowed-Gateway-Error-Example'
    Conflict_2:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Service-Error-Response'
          examples:
            Idempotency-Id-Conflict-Example:
              $ref: '#/components/examples/Idempotency-Id-Conflict-Example_2'
    Bad-Request_2:
      description: Bad Request
      content:
        application/json:
          schema:
            title: BadRequestErrorResponse
            anyOf:
            - $ref: '#/components/schemas/Gateway-Error-Response'
            - $ref: '#/components/schemas/Service-Error-Response'
          examples:
            Bad-Request-Service-Error-Example:
              $ref: '#/components/examples/Bad-Request-Service-Error-Example'
            Bad-Request-Gateway-Error-Example:
              $ref: '#/components/examples/Bad-Request-Gateway-Error-Example'
  callbacks:
    Payment-Notification:
      /payment-notification:
        post:
          parameters:
          - $ref: '#/components/parameters/Event-Type'
          - $ref: '#/components/parameters/Event-Name'
          requestBody:
            required: true
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/Payments'
                examples:
                  TH Status - Completed:
                    $ref: '#/components/examples/Ok-Response'
                  TH Status - Rejected:
                    $ref: '#/components/examples/Ok-Response-Failed'
                  US Status - Completed:
                    $ref: '#/components/examples/Us-Ok-Response'
                  US Status - Rejected:
                    $ref: '#/components/examples/Us-Ok-Response-Failed'
                  UK Status - Completed:
                    $ref: '#/components/examples/Uk-Ok-Response'
                  UK Status - Rejected:
                    $ref: '#/components/examples/Uk-Ok-Response-Failed'
                  IN Status - Completed:
                    $ref: '#/components/examples/In-Ok-Response'
                  IN Status - Rejected:
                    $ref: '#/components/examples/In-Ok-Response-Failed'
                  IN UPI Status - Completed:
                    $ref: '#/components/examples/In-Upi-Ok-Response'
                  IN UPI Status - Rejected:
                    $ref: '#/components/examples/In-Upi-Ok-Response-Failed'
                  IN IMPS Fir Status - Completed:
                    $ref: '#/components/examples/In-Imps-Fir-Ok-Response'
                  IN IMPS Fir Status - Rejected:
                    $ref: '#/components/examples/In-Imps-Fir-Ok-Response-Failed'
                  US WIRE Status - Completed:
                    $ref: '#/components/examples/US-WIRE-Ok-Response'
                  US WIRE Status - Rejected:
                    $ref: '#/components/examples/US-WIRE-Ok-Response-Failed'
                  US ACH Status - Completed:
                    $ref: '#/components/examples/Us-Ach-Ok-Response'
                  US ACH Status - Rejected:
                    $ref: '#/components/examples/Us-Ach-Ok-Response-Failed'
                  UK RFI Compliance Status - Pending:
                    $ref: '#/components/examples/Uk-Rfi-Compliance-Pending'
                  JP Status - Completed:
                    $ref: '#/components/examples/Jp-Ok-Response'
                  JP Status - Rejected:
                    $ref: '#/components/examples/Jp-Ok-Response-Failed'
                  SEPA Status - Rejected:
                    $ref: '#/components/examples/SEPA-Ok-Reject-Final'
                  SEPA Status - Completed:
                    $ref: '#/components/examples/SEPA-Ok-Completed-Final'
                  IN IMPS Credit Notification Completed:
                    $ref: '#/components/examples/IN-IMPS-Credit-Notification-Completed'
                  IN IMPS Credit Notification Rejected:
                    $ref: '#/components/examples/IN-IMPS-Credit-Notification-Rejected'
                  SEPA VoP Status - Completed:
                    $ref: '#/components/examples/SEPA-VoP-Ok-Completed-Final'
                  SEPA VoP Status - Rejected:
                    $ref: '#/components/examples/SEPA-VoP-Nok-Completed-Final'
                  MX DFT Status - Completed:
                    $ref: '#/components/examples/MX-DFT-Completed'
                  MX DFT Status - Rejected:
                    $ref: '#/components/examples/MX-DFT-Rejected'
                  MX BKT Status - Completed:
                    $ref: '#/components/examples/MX-BKT-Completed'
                  MX BKT Status - Rejected:
                    $ref: '#/components/examples/MX-BKT-Rejected'
                  AU Status - Completed:
                    $ref: '#/components/examples/AU-IP-Completed'
                  AU Status - Rejected:
                    $ref: '#/components/examples/AU-IP-Rejected'
                  IN NEFT Status - Completed:
                    $ref: '#/components/examples/In-Neft-Ok-Response'
                  IN NEFT Status - Rejected:
                    $ref: '#/components/examples/In-Neft-Ok-Response-Failed'
          responses:
            '202':
              description: Accepted
              content:
                application/json:
                  schema:
                    type: object
  securitySchemes:
    Client_ID:
      description: ''
      in: query
      name: client_id
      type: apiKey
    clientCredentials:
      type: oauth2
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: /authenticationservices/v1/oauth/token
      description: All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API Reference for information on requesting a token.
    oAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: /authenticationservices/v3/oauth/token
          tokenUrl: /authenticationservices/v3/oauth/token
          scopes:
            paymentservices: Grant read-only access to payment initation service
            selfservices: Grant read-only access to beneficiary validation
    oAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: /authenticationservices/v3/oauth/token
          scopes:
            authenticationservices/v1: Access to Accounts, Balances, Transactions Information
    auth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://secure.api-preprod.bkm.com.tr/oauth-provider/oauth2/token
          scopes:
            payment_order: Payment Order
            account_information: Account Information
x-refined-from:
- citi-payment-reconfirmation-openapi.yaml
- citi-paymentcancellation-json-openapi.yaml
- express_payments_api.yaml
- ukraine_payment_service_initiation_api.yaml