openapi: 3.0.2 info: title: Instant Payments description: > Use the Citi Payments Express API to initiate these types of transaction and check their status: * Instant Payments * Payment Messages * Refunds * Beneficiary Validation **Note:** The Citi Payments Express API is for direct payments and refunds. To send payments or refunds to a third-party account or via a proxy, use the [CitiConnect Payments API](https://developer.citi.com/apim/go/home/X19OQVZJR0FUSU9OX0JBU0U2NF9fYXBpZG9jcy9vdXRnb2luZy1wYXltZW50cy9wYXltZW50cy9wYXltZW50cy1vdmVydmlldw..) contact: name: Standards & Developer Hub url: https://tts.sandbox.developer.citi.com/citiconnect/ email: developer-support@citi.com version: 1.0.0 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 ' tags: - name: Beneficiary Validation description: >- Before initiating payment, POST beneficiary validation details to confirm that you are sending to the correct beneficiary. Validating beneficiary information is a two-step process: 1. Make a POST request to the `/paymentservices/v1/beneficiaryvalidations` endpoint and include the required information inside the payload of the request to initiate the transaction.

You will receive an initial response, usually within 5 seconds, verifying that your request was received and indicating whether it was accepted. If your request was not accepted, check the request and resubmit it. 2. When you receive the response to your POST request, retrieve the beneficiary details by making a GET request to the `/paymentservices/v1/beneficiaryvalidations/UETR`value endpoint, using the UETR value from your initial response. - name: Payments description: >- Use the Payments endpoint to initiate and track instant payments. While all payments can be sent through a single CitiConnect API, it is important to observe local country requirements to avoid rejects and returned transactions. The table below shows the minimum fields required to initiate a Thailand Instant Payment transaction. For a full list of fields please refer to the swagger files shared by your Citi representative. To ensure that a payment is initiated correctly: * Ensure you have the required datapoints to initiate a transaction in the country where your payee is located. * Make a ``POST`` request to the `/paymentservices/v1/payments` endpoint and include the required information inside the payload of the request to initiate the transaction. - name: Non-Payment Messages - name: Refunds paths: /paymentservices/v1/beneficiaryvalidations: post: tags: - Beneficiary Validation summary: Validating the beneficiary account details operationId: expressBeneficiaryValidation 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 - Maximum length is 128. - 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. - 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 API allows the client to validate beneficiary details with the use of combination of fields content: application/json: schema: $ref: '#/components/schemas/Beneficiary-Validation-Request' examples: IN IMPS Beneficiary Validation Non Penny: $ref: >- #/components/examples/In-Beneficiary-Validation-Request-Non-Penny IN IMPS Beneficiary Validation Penny: $ref: '#/components/examples/In-Beneficiary-Validation-Request-Penny' UPI IN Beneficiary Validation: $ref: '#/components/examples/Upi-In-Beneficiary-Validation-Request' UPI IN Mobile Number Beneficiary Validation: $ref: >- #/components/examples/Upi-In-Mobile-Number-Beneficiary-Validation-Request UPI IN UPI ID Beneficiary Validation: $ref: >- #/components/examples/Upi-In-UPI-ID-Beneficiary-Validation-Request US EWS Beneficiary Validation: $ref: '#/components/examples/US-EWS-Beneficiary-Validation-Request' UK Beneficiary Validation: $ref: '#/components/examples/UK-Beneficiary-Validation-Request' IN PAN Validation: $ref: '#/components/examples/IN-PAN-Validation-Request' Pay2China Merchant Validation: $ref: '#/components/examples/Pay2China-Beneficiary-Validation-Request' application/xml: schema: $ref: '#/components/schemas/Beneficiary-Validation-Request' examples: Pay2China Merchant Validation: $ref: '#/components/examples/Pay2China-Beneficiary-Validation-Request' security: - oAuth2: - selfservices 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/Initial-Beneficiary-Validation-Response' examples: IN IMPS Initial Beneficiary Validation Response Non Penny: $ref: >- #/components/examples/In-Initial-Beneficiary-Validation-Response-Non-Penny IN IMPS Initial Beneficiary Validation Response Penny: $ref: >- #/components/examples/In-Initial-Beneficiary-Validation-Response-Penny UPI IN Initial Beneficiary Validation Response: $ref: >- #/components/examples/Upi-In-Initial-Beneficiary-Validation-Response UPI IN Mobile Number Initial Beneficiary Validation Response: $ref: >- #/components/examples/Upi-In-Mobile-Number-Initial-Beneficiary-Validation-Response UPI IN UPI ID Initial Beneficiary Validation Response: $ref: >- #/components/examples/Upi-In-UPI-ID-Initial-Beneficiary-Validation-Response US EWS Initial Beneficiary Validation Response: $ref: >- #/components/examples/US-EWS-Initial-Beneficiary-Validation-Response UK Initial Beneficiary Validation Response: $ref: >- #/components/examples/UK-Initial-Beneficiary-Validation-Response IN PAN Initial Validation Response: $ref: '#/components/examples/IN-PAN-Initial-Validation-Response' Pay2China Initial Validation Response: $ref: >- #/components/examples/Pay2China-Initial-Beneficiary-Validation-Response application/xml: schema: $ref: '#/components/schemas/Initial-Beneficiary-Validation-Response' examples: Pay2China Initial Validation Response: $ref: >- #/components/examples/Pay2China-Initial-Beneficiary-Validation-Response '400': $ref: '#/components/responses/Bad-Request-Pay2China' '401': $ref: '#/components/responses/Unauthorized-Pay2China' '404': $ref: '#/components/responses/Not-Found-Pay2China' '405': $ref: '#/components/responses/Method-Not-Allowed-Pay2China' '409': $ref: '#/components/responses/Conflict-Pay2China' '415': $ref: '#/components/responses/Unsupported-Media-Type-Pay2China' '500': $ref: '#/components/responses/Internal-Server-Error-Pay2China' default: $ref: '#/components/responses/Internal-Server-Error-Pay2China' /paymentservices/v1/beneficiaryvalidations/{uetr}: get: tags: - Beneficiary Validation summary: Inquire for the latest status of a beneficiary validation using UETR description: >- The API service responds with the latest beneficiary validation status of the unique end-to-end transaction reference (UETR) you inquire with. operationId: findBeneficiaryValidation 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: end_to_end_id in: query schema: type: string description: Client provided reference number - 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: - selfservices 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/Final-Beneficiary-Validation-Response' examples: IN IMPS Final Beneficiary Validation Response Non Penny: $ref: >- #/components/examples/In-Final-Beneficiary-Validation-Response-Non-Penny IN IMPS Final Beneficiary Validation Response Penny: $ref: >- #/components/examples/In-Final-Beneficiary-Validation-Response-Penny UPI IN Final Beneficiary Validation Response: $ref: >- #/components/examples/Upi-In-Final-Beneficiary-Validation-Response UPI IN Mobile Number Final Beneficiary Validation Response: $ref: >- #/components/examples/Upi-In-Final-Mobile-Number-Beneficiary-Validation-Response UPI IN Mobile Number Final Beneficiary Validation Penny Testing Response: $ref: >- #/components/examples/Upi-In-Final-Mobile-Number-Beneficiary-Validation-Penny-Testing-Response UPI IN UPI ID Final Beneficiary Validation Response: $ref: >- #/components/examples/Upi-In-Final-UPI-ID-Beneficiary-Validation-Response US EWS Final Beneficiary Validation Response: $ref: >- #/components/examples/US-EWS-Final-Beneficiary-Validation-Response UK Final Beneficiary Validation Response: $ref: >- #/components/examples/UK-Final-Beneficiary-Validation-Response IN PAN Final Validation Response: $ref: '#/components/examples/IN-PAN-Final-Validation-Response' Pay2China Final Validation Positive Response: $ref: >- #/components/examples/Pay2China-Final-Beneficiary-Validation-Positive-Response Pay2China Final Validation Negative Response: $ref: >- #/components/examples/Pay2China-Final-Beneficiary-Validation-Negative-Response application/xml: schema: $ref: '#/components/schemas/Final-Beneficiary-Validation-Response' examples: Pay2China Final Validation Positive Response: $ref: >- #/components/examples/Pay2China-Final-Beneficiary-Validation-Positive-Response Pay2China Final Validation Negative Response: $ref: >- #/components/examples/Pay2China-Final-Beneficiary-Validation-Negative-Response '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' /paymentservices/v1/refunds: post: tags: - Refunds summary: Initiate an outgoing instant refund credit transfer. description: >- Return an incoming payment transaction to the sender using either the “end_to_end_id” and "value_date”, or “UETR”. The response to a refund transaction is asynchronous, which is either through a GET Refund request or as a push notification via webhook. operationId: expressRefundInitiation 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: a44cbb60-6de4-4edb-9a7a-123414bba3bb description: >- Your unique identification for a POST request - Maximum length is 128. - 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. - 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: >- Return an incoming payment transaction to the sender using either the “end_to_end_id” and "value_date”, or “UETR”. The response to a refund transaction is asynchronous, which is either through a GET Refund request or as a push notification via webhook. content: application/json: schema: $ref: '#/components/schemas/Refunds-Initiation' examples: TH Refund Transfer: $ref: '#/components/examples/Th-Refund-Initiation-Request-Example' BR Refund Transfer: $ref: '#/components/examples/Br-Refund-Initiation-Request-Example' US Refund Transfer: $ref: '#/components/examples/Us-Refund-Initiation-Request-Example' SEPA Refund Transfer: $ref: '#/components/examples/SEPA-Refund-Initiation-Request-Example' security: - oAuth2: - paymentservices callbacks: Refund-Notification: $ref: '#/components/callbacks/Refund-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/Refunds' examples: OK: $ref: '#/components/examples/Refund-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: - Refunds summary: >- Inquire for the latest status of refund transations matching additional parameters. description: >- Get the latest refund transactions statuses initiated through the refund initiation endpoint using matching criteria. Currently, you can get the latest transactions statuses up to 90 days from the refund initiation date. If the latest transactions statuses date is 90+ days, the endpoint responds with HTTP status 404 (not found). operationId: findRefunds 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: end_to_end_id in: query description: The end to end ID included in the refund by the sender of the refund schema: $ref: '#/components/schemas/Restricted-Finx-Max-Text' examples: refund_transaction_details_1: value: 1L00IF2BCWUZF09 - name: original_payment_uetr in: query description: >- The unique ‘UETR’ reference assigned to the original incoming credit on your account for which a refund was initiated. If multiple refunds were initiated against an incoming credit, the response API will include all these refunds 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: refund_transaction_details_1: value: 0c4fb98b-d77a-4468-96bb-0c88b3b8f75a - name: creation_date_time_start in: query description: |- GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Start of date time, generated by CitiConnect API, when CitiConnect API accepted a refund initiation after validation schema: $ref: '#/components/schemas/Iso-Normalised-Date-Time' examples: refund_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) - end of date time, generated by CitiConnect API, when CitiConnect API accepted a refund initiation after validation schema: $ref: '#/components/schemas/Iso-Normalised-Date-Time' examples: refund_transaction_details_1: value: '2022-09-13T08:23:49.114Z' - name: instructed_amount in: query description: refund amount schema: type: number maximum: 1000000000000000 examples: refund_transaction_details_1: value: 73945.27 - name: status_code in: query description: ISO 20022 transaction status code schema: type: string enum: - ACCC - ACTC - RJCT examples: refund_transaction_details_1: value: ACCC - $ref: '#/components/parameters/Off-Set-Param' - $ref: '#/components/parameters/Limit-Param' security: - oAuth2: - paymentservices responses: '200': description: Refund 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/Refunds-Response' examples: Ok-ResponseExample: $ref: '#/components/examples/Ok-Refund-Response-Multiple-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' /paymentservices/v1/refunds/{refund_id}: get: tags: - Refunds summary: Inquire for the latest status of a transaction using refund_id. description: > "Get the latest refund transaction status initiated through the refund initiation endpoint. Currently, you can get the latest transaction status up to 90 days from the refund initiation date. If the latest transaction status date is 90+ days, the endpoint responds with HTTP status 404 (not found)" operationId: findRefundById 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: refund_id in: path description: >- Unique Refund reference Id, generated during refund initiation and provided to you in the synchronous response to your refund POST request 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/Refunds' examples: Refund Status - Completed: $ref: '#/components/examples/Ok-Refund-Response' Refund Status - Rejected: $ref: '#/components/examples/Ok-Refund-Response-Failed' '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' /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 - Maximum length is 128. - 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. - 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) - Instant Payment (Debit) - Start of date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation - 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) - Instant Payment (Debit) - End of date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation - 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) - 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) - 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' /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' /paymentservices/v1/payments/{uetr}/messages: post: tags: - Non-Payment Messages summary: Initiate a non payment message description: > This endpoint validates your request and 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 message initiation request. operationId: createMessage 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 required: true description: Unique end-to-end transaction reference 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}$ - name: Idempotency-Id in: header required: true schema: type: string maxLength: 128 example: a44cbb60-6de4-4edb-9a7a-123414bba3bb description: >- Your unique identification for a POST request - Maximum length is 128. - 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. - 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 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 message initiation request. content: application/json: schema: $ref: '#/components/schemas/Message-Request' examples: Response to Request For Refund: $ref: '#/components/examples/Response-To-Request-For-Refund-Example' Response to Payment Confirmation Request: $ref: >- #/components/examples/Response-To-Payment-Confirmation-Request-Example Accept Response to Incoming Payment Confirmation Request From CITI: $ref: >- #/components/examples/Th-Response-To-Payment-Confirmation-Sucess-Request-Example Reject Response to Incoming Payment Confirmation Request From CITI: $ref: >- #/components/examples/Th-Response-To-Payment-Confirmation-Reject-Request-Example Response to Request for Payment: $ref: '#/components/examples/Response-To-Request-For-Payment-Example' Outgoing Request for Refund: $ref: '#/components/examples/Outgoing-Request-For-Refund-Example' Response to Request for Information Compliance: $ref: >- #/components/examples/Response-To-Request-For-Information-Compliance-Example Uk Stop Request: $ref: '#/components/examples/Uk-Stop-Request-Example' In Stop Request: $ref: '#/components/examples/In-Stop-Request-Example' Br Stop Request: $ref: '#/components/examples/Br-Stop-Request-Example' security: - oAuth2: - paymentservices 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/Initial-Acknowledgement-Response' examples: Status - Initial-Response-To-Request-For-Refund: $ref: '#/components/examples/Initial-Response-To-Request-For-Refund' Status - Initial-Response-To-Payment-Confirmation-Request: $ref: >- #/components/examples/Initial-Response-To-Payment-Confirmation-Request Status - Initial-Response-To-Request-For-Payment: $ref: >- #/components/examples/Initial-Response-To-Request-For-Payment Status - Initial-Outgoing-Request-For-Refund: $ref: '#/components/examples/Initial-Outgoing-Request-For-Refund' Status - Initial-Response-To-Request-for-Information-Compliance: $ref: >- #/components/examples/Initial-Response-To-Request-for-Information-Compliance Uk Status - Stop Request: $ref: '#/components/examples/Uk-Stop-Request' In Status - Stop Request: $ref: '#/components/examples/In-Stop-Request' Br Status - Stop Request: $ref: '#/components/examples/Br-Stop-Request' '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' /paymentservices/v1/payments/{uetr}/messages/{message_id}: get: tags: - Non-Payment Messages summary: >- Inquire for the latest status of a transaction using UETR and Message Id. operationId: findMessageByMessageId 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}$ - name: message_id in: path description: Unique message id required: true schema: type: string maxLength: 35 examples: message_id_1: value: 0c4fb98bd77a446896bb0c88b3b8f75a 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/Final-Message-Response' examples: Status - ValidRequest-For-Refund: $ref: '#/components/examples/Ok-Request-For-Refund' Status - ValidRequest-For-Refund-SEPA: $ref: '#/components/examples/Ok-Request-For-Refund-SEPA' Status - ValidResponsetoRequest-For-Refund: $ref: '#/components/examples/Ok-Response-To-Request-For-Refund' Status - ValidResponsetoRequest-For-Refund-SEPA: $ref: '#/components/examples/Ok-Response-To-Request-For-Refund-SEPA' Status - InvalidResponsetoRequest-For-Refund: $ref: '#/components/examples/Not-Ok-Response-To-Request-For-Refund' Status - ValidPayment-Confirmation-Request: $ref: '#/components/examples/Ok-Payment-Confirmation-Request' Status - ValidPending-Payment-Confirmation-Request: $ref: '#/components/examples/Pending-Payment-Confirmation-Request' Status - ValidRequest-For-Payment: $ref: '#/components/examples/Ok-Request-For-Payment' Status - ValidRequest-for-Information-Compliance: $ref: '#/components/examples/OK-Request-For-Information-Compliance' Status - ValidResponsetoRequest-For-Information-Compliance: $ref: >- #/components/examples/OK-Response-To-Request-For-Information-Compliance Status - ValidRequest-For-Refund-Uk: $ref: '#/components/examples/Ok-Request-For-Refund-Uk' Status - ValidRequest-For-Refund-In: $ref: '#/components/examples/Ok-Request-For-Refund-In' Status - ValidRequest-For-Refund-Br: $ref: '#/components/examples/Ok-Request-For-Refund-Br' '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' components: 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 - Maximum value is 1,000. Event-Type: name: Event-Type in: header required: true description: Event Type schema: type: string Beneficiary-Event-Type: name: Event-Type in: header required: false description: Event Type schema: type: string Event-Name: name: Event-Name in: header required: true description: Event Name schema: type: string schemas: 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 - For Thailand PromptPay transaction.instruction_id field is not applicable - For United States transaction.instruction_id field is optional - For IN IMPS transaction.instruction_id field is not applicable - For UK FPS Instant payment transaction.instruction_id field is not applicable - For IN UPI transaction.instruction_id field is not applicable - For US WIRE, transaction.instruction_id field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.instruction_id field is not applicable - For Japan Instant payment transaction.instruction_id field is not applicable - 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. - For SEPA, TH Instant payment transaction.reference is not applicable - For US Instant payment transaction.reference field is not applicable - For IN IMPS transaction.reference is not applicable - For UK FPS Instant payment transaction.reference is not applicable - 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 . , () - - For IN UPI transaction.reference is not applicable - For US WIRE, transaction.reference field is not applicable - 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 - Thailand PromptPay - Maximum length is 20. - For SEPA, US Instant payment transaction.bill_id_1 field is not applicable - For IN IMPS transaction.bill_id_1 field is not applicable - For UK FPS Instant payment transaction.bill_id_1 field is not applicable - For IN UPI transaction.bill_id_1 field is not applicable - For US Wire, transaction.bill_id_1 field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.bill_id_1 field is not applicable - 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 - Thailand PromptPay - Maximum length is 20. - For SEPA, US Instant payment transaction.bill_id_2 field is not applicable - For IN IMPS transaction.bill_id_2 field is not applicable - For UK FPS Instant payment transaction.bill_id_2 field is not applicable - For IN UPI transaction.bill_id_2 field is not applicable - For US Wire, transaction.bill_id_2 field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.bill_id_2 field is not applicable - 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 - Thailand PromptPay - Maximum length is 20. - For SEPA, US Instant payment transaction.bill_id_3 field is not applicable - For IN IMPS transaction.bill_id_3 field is not applicable - For UK FPS Instant payment transaction.bill_id_3 field is not applicable - For IN UPI transaction.bill_id_3 field is not applicable - For US Wire, transaction.bill_id_3 field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.bill_id_3 field is not applicable - 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 - For Thailand PromptPay transaction.purpose field is optional - For US Instant payment transaction.purpose field is optional - For IN IMPS transaction.purpose field is optional - UK FPS Instant payment transaction.purpose field is optional - For IN UPI transaction.purpose field is optional - For India FIR IMPS Instant payment transaction.purpose field is mandatory - CASH for cash management - CNFL for confidential - COST for payment for business expenses - GDSV for payment related to purchase or sale of goods and services - GP2P for person-to-person payment - OTHR for other, if your payment doesn't fit any of the specific purpose codes - RCPT for payment of a receipt - SALA for salary payment - SUPP for supplier payment - TREA for treasury payment - REFU for refund payment - CLPO for Claim Payouts - LODI for Loan Disbursals - TIPO for Tips Payout - GIEO for Gig economy - VEPO for Vendor Payouts - INPO for Incentive Payouts - ISPO for Insurance Payouts - MPPO for Merchant/Marketplace Payouts - TXPO for Tax Payments - RDPO for Rider payout - GDDS for payment related to purchase or sale of goods - SCVE for payment related to purchase or sale of services - PAYR for payroll payment - NOWS for Not Otherwise Specified - INVS for Invoice Signed - INSC for Payment Of Insurance Claim - INSM for Installment - PDEP for Property Deposit - UBIL for Utilities Subscription Identification - ACCT for Account Management - CBLK for Bulk card transactions - MP2P for Mobile P2P Payment - For US Wire, transaction.purpose field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.purpose field is not applicable - For Japan Instant payment transaction.purpose field is not applicable - 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 - 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 - For US Instant payment transaction.tax_code field is not applicable - For IN IMPS transaction.tax_code field is not applicable - For UK FPS Instant payment transaction.tax_code field is not applicable - For IN UPI transaction.tax_code field is not applicable - For US Wire, transaction.tax_code field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.tax_code field is not applicable - 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 - 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. - For US Instant payment transaction.wht_code field is not applicable - For IN IMPS transaction.wht_code field is not applicable - For UK FPS Instant payment transaction.wht_code field is not applicable - For IN UPI transaction.wht_code field is not applicable - For US Wire, transaction.wht_code field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.wht_code field is not applicable - 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 - 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. - For US Instant payment transaction.income_type field is not applicable - For IN IMPS transaction.income_type field is not applicable - For UK FPS Instant payment transaction.income_type field is not applicable - For IN UPI transaction.income_type field is not applicable - For US Wire, transaction.income_type field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.income_type field is not applicable - 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 - For TH Instant Payent Range is 0 - 99.99 - For US Instant payment transaction.vat_rate field is not applicable - For IN IMPS transaction.vat_rate field is not applicable - For UK FPS Instant payment transaction.vat_rate field is not applicable - For IN UPI transaction.vat_rate field is not applicable - For US Wire, transaction.vat_rate field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.vat_rate field is not applicable - 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 - Thailand PromptPay - Maximum amount is 2000000.00. - For US Instant payment transaction.vat_amount field is not applicable - For IN IMPS transaction.vat_amount field is not applicable - For UK FPS Instant payment transaction.vat_amount field is not applicable - For IN UPI transaction.vat_amount field is not applicable - For US Wire, transaction.vat_amount field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.vat_amount field is not applicable - 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) - Thailand PromptPay - Maximum rate is 5.00. - For US Instant payment transaction.wht_rate field is not applicable - For IN IMPS transaction.wht_rate field is not applicable - For UK FPS Instant payment transaction.wht_rate field is not applicable - For IN UPI transaction.wht_rate field is not applicable - For US Wire, transaction.wht_rate field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.wht_rate field is not applicable - 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 - Thailand PromptPay - Maximum amount is 2000000.00. - For US Instant payment transaction.wht_amount field is not applicable - For IN IMPS transaction.wht_amount field is not applicable - For UK FPS Instant payment transaction.wht_amount field is not applicable - For IN UPI transaction.wht_amount field is not applicable - For US Wire, transaction.wht_amount field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.wht_amount field is not applicable - 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 - For TH Instant payment if client provides transaction.bill_id_1 value, require client to mandatorily provide bill_due_date value. - For US Instant payment transaction.bill_due_date field is not applicable - For IN IMPS transaction.bill_due_date field is not applicable - For UK FPS Instant payment transaction.bill_due_date field is not applicable - For IN UPI transaction.bill_due_date field is not applicable - For US Wire, transaction.bill_due_date field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.bill_due_date field is not applicable - 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 - 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 - For US Wire, transaction.value_date is a mandatory field - For US ACH CCD/PPD/IAT payment, transaction.value_date field is mandatory - For Japan Instant payment transaction.value_date field is mandatory, value date should be current calender date or current calender date -7 - 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 - 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 - Thailand PromptPay - Maximum amount is 2000000.00 - US RTP - Maximum amount is 1000000.00 - IN IMPS - Maximum amount is 500000.00 - UK FPS Instant Payment - Maximum amount is 1000000.00 and allowed only Maximum of Two digits after decimal - IN UPI - Maximum amount is 200000.00 - For US Wire, transaction.instructed_amount is a mandatory field. Maximum amount is $9999999999.99 - IN Japan - Maximum amount is 99,999,999 - 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 - Thailand PromptPay - Maximum length is 40. - For US Instant payment transaction.additional_info field is not applicable - For IN IMPS transaction.additional_info field is not applicable - For UK FPS Instant payment transaction.additional_info field is optional and allowed max length is 105 - For IN UPI transaction.additional_info field is not applicable - For US Wire, transaction.additional_info field is not applicable - 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 - For US ACH IAT payment, transaction.additional_info field is not applicable - For SEPA, Japan Instant payment transaction.additional_info field is not applicable title: additional_info unstructured_remittance_info: type: array description: >- Unstructured remitance information - For TH Instant payment transaction.unstructured_remittance_info field is not applicable - For US Instant payment transaction.unstructured_remittance_info field is optional - Maximum length is 140 and Single instance is allowed - 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 - For UK FPS Instant payment transaction.unstructured_remittance_info is optional and allowed only four instance with each line max length of 35 - 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 - 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 - For Japan Instant payment transaction.unstructured_remittance_info field is not applicable - For SEPA, transaction.unstructured_remittance_info field is optional and Maximum length is 140 and 1 instance is allowed - 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 - EMAL - EMail, FAXI - Fax, SMSM - SMS Phone Number, URID - UniformResourceIdentifier - For TH Instant payment transaction.advice_type field is not applicable - For US Instant payment transaction.advice_type field is not applicable - For IN IMPS transaction.advice_type field is optional with max length 4 - For UK FPS Instant payment transaction.advice_type field is not applicable - For IN UPI transaction.advice_type field is optional, applicable values are SMSM or EMAL - For US Wire, transaction.advice_type field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.advice_type field is not applicable - For SEPA, Japan Instant payment transaction.advice_type field is not applicable - 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 - For SEPA, TH Instant payment transaction.advice_address field is not applicable - For US Instant payment transaction.advice_address field is not applicable - For IN IMPS transaction.advice_address field is optional - For UK FPS Instant payment transaction.advice_address field is not applicable - For IN UPI transaction.advice_address field is mandatory, if transaction.advice_type is EMAL - For US Wire, transaction.advice_address field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.advice_address field is not applicable - 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 - For SEPA, Thailand PromptPay transaction.category field is not applicable - For United States transaction.category field is optional - For IN IMPS transaction.category field is not applicable - For UK FPS Instant payment transaction.category field is not applicable - For IN UPI transaction.category field is not applicable - For US Wire, transaction.category field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.category field is mandatory and allowed value is CCD, PPD and IAT - For Japan Instant payment transaction.category field is not applicable - 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. - For SEPA, Thailand PromptPay transaction.priority field is not applicable - For United States transaction.priority field is not applicble - For IN IMPS transaction.priority field is not applicable - For UK FPS Instant payment transaction.priority field is not applicable - For IN UPI transaction.priority field is not applicable - For US Wire, transaction.priority is an optional field - For US ACH CCD/PPD/IAT payment, transaction.priority field is not applicable - 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. - For Thailand PromptPay transaction.charges_paid_by field is not applicable - For United States transaction.charges_paid_by field is not applicble - For IN IMPS transaction.charges_paid_by field is not applicable - For UK FPS Instant payment transaction.charges_paid_by field is not applicable - For US Wire, transaction.charges_paid_by is an optional field with allowed values CRED,DEBT,SHAR - For US ACH CCD/PPD/IAT payment, transaction.charges_paid_by field is not applicable - For Japan Instant payment transaction.charges_paid_by field is not applicable - 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 - For SEPA, Thailand PromptPay transaction.payment_information_id field is not applicable - For United States transaction.payment_information_id field is not applicable - For IN IMPS transaction.payment_information_id field is not applicable - For UK FPS Instant payment transaction.payment_information_id field is not applicable - For US Wire, transaction.payment_information_id is an mandatory field and allowed max length is 34 Numeric (0-9). - For US ACH CCD/PPD/IAT payment, transaction.payment_information_id field is mandatory and allowed max length is 10 Numeric (0-9). - 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 - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments transaction.category_purpose is not applicable - 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 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 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 Iso-Normalised-Date-Time: type: string format: date-time description: an ISODateTime whereby all timezoned dateTime values are UTC. title: IsoNormalisedDateTime Proxy-Id: maxLength: 255 type: string description: |- Specifies a character string with a maximum length of 128 characters. - For TH Instant payment debtor.proxy_id is optional - For US Instant payment debtor.proxy_id is not applicable - For IN IMPS debtor.proxy_id is not applicable - For UK FPS Instant payment debtor.proxy_id is not applicable - For JP Instant payment debtor.proxy_id is not applicable - For IN UPI Instant payment debtor.proxy_id is mandatory, applicable value VPA ID - For US Wire and ACH CCD/PPD/IAT debtor.proxy_id is not applicable - For SEPA IDP payment debtor.proxy_id is optional - For SEPA, debtor.proxy_id is optional - For Japan Instant payment debtor.proxy_id is not applicable title: Proxy-Id Address: type: string maxLength: 70 minLength: 1 maxItems: 7 description: Address title: Address Field-level-Responses-For-RRFICS: type: object description: “FieldlevelResponsesForRRFICS” title: Field-level-Responses-For-RRFICS properties: field_id: type: string description: Field ID. minLength: 1 maxLength: 16 title: field_id field_name: type: string description: Field name. minLength: 1 maxLength: 70 title: field_name field_value: type: string description: Field value. minLength: 1 maxLength: 70 title: field_value individual: type: object description: |- Input type selected as Individual. When individual is selected any one of the fields displayed under individual object are mandatory title: individual properties: name: type: string description: |- Name of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 140 title: name street_name: type: string description: |- Street Name of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 70 title: street_name building_number: type: string description: |- Building Number of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 16 title: building_number postal_code: type: string description: |- Postal Code of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 16 title: postal_code city: type: string description: |- City of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 35 title: city state: type: string description: |- State of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 35 title: state country: type: string description: |- Country of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 2 title: country birth_date: type: string format: date description: |- Birth Date of individual Format is YYYY-MM-DD. If selected input type = individual, at least 1 field from individual object must be provided. title: birth_date city_of_birth: type: string description: |- City Of Birth of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 35 title: city_of_birth country_of_birth: type: string description: |- Country Of Birth of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 2 title: country_of_birth nationality: type: string description: |- Nationality of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 35 title: nationality occupation: type: string description: |- Occupation of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 35 title: occupation country_of_residence: type: string description: |- Country of Residence of individual. If selected input type = individual, at least 1 field from individual object must be provided. minLength: 1 maxLength: 2 title: country_of_residence entity: type: object description: >- Input type selected as Entity. When Entity is selected any one of the fields displayed under entity object are mandatory title: entity properties: name: type: string description: |- Name of Entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 140 title: name street_name: type: string description: |- Street Name of Entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 70 title: street_name building_number: type: string description: |- Building Number of Entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 16 title: building_number postal_code: type: string description: |- Postal Code of Entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 16 title: postal_code city: type: string description: |- City of Entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 35 title: city state: type: string description: |- State of Entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 35 title: state country: type: string description: |- Country of Entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 2 title: country line_of_business: type: string description: |- Line of business of Entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 35 title: line_of_business ownership_details: type: string description: |- Ownership Details of entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 560 title: ownership_details global_presence: type: string description: |- Global Presence of entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 140 title: global_presence website: type: string description: |- Website of entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 140 title: website registration_number: type: string description: |- Registration Number of entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 35 title: registration_number country_of_incorporation: type: string description: |- Country of incorporation of entity. If selected input type = entity, at least 1 field from entity object must be provided. minLength: 1 maxLength: 2 title: country_of_incorporation vessel: type: object description: >- Input type selected as vessel. When vessel is selected any one of the fields displayed under vessel object are mandatory title: vessel properties: name: type: string description: |- Name of vessel. If selected input type = vessel, at least 1 field from vessel object must be provided. minLength: 1 maxLength: 140 title: name flag: type: string description: |- Flag of vessel. If selected input type = vessel, at least 1 field from vessel object must be provided. minLength: 1 maxLength: 35 title: flag ownership_details: type: string description: |- Ownership Details of vessel. If selected input type = vessel, at least 1 field from vessel object must be provided. minLength: 1 maxLength: 560 title: ownership_details imo_number: type: string description: |- Imo Number of vessel. If selected input type = vessel, at least 1 field from vessel object must be provided. minLength: 1 maxLength: 35 title: imo_number gross_registered_tonnage: type: string description: |- Gross registered tonnage of vessel. If selected input type = vessel, at least 1 field from vessel object must be provided. minLength: 1 maxLength: 10 title: gross_registered_tonnage vessel_type: type: string description: |- Type of vessel. If selected input type = vessel, at least 1 field from vessel object must be provided. minLength: 1 maxLength: 35 title: vessel_type aircraft: type: object description: >- Input type selected as aircraft. When aircraft is selected any one of the fields displayed under aircraft object are mandatory title: aircraft properties: call_sign: type: string description: |- Call Sign of aircraft. If selected input type = aircraft, at least 1 field from aircraft object must be provided. minLength: 1 maxLength: 140 title: call_sign flag: type: string description: |- Flag of aircraft. If selected input type = aircraft, at least 1 field from aircraft object must be provided. minLength: 1 maxLength: 35 title: flag ownership_details: type: string description: |- Ownership Details of aircraft. If selected input type = aircraft, at least 1 field from aircraft object must be provided. minLength: 1 maxLength: 560 title: ownership_details msn_number: type: string description: |- Msn Number of aircraft. If selected input type = aircraft, at least 1 field from aircraft object must be provided. minLength: 1 maxLength: 35 title: msn_number model: type: string description: |- Model of aircraft. If selected input type = aircraft, at least 1 field from aircraft object must be provided. minLength: 1 maxLength: 35 title: model operator: type: string description: |- Operator of aircraft. If selected input type = aircraft, at least 1 field from aircraft object must be provided. minLength: 1 maxLength: 35 title: operator Field-level-Requests-For-RFICS: type: object description: “FieldlevelRequestsForRFICS” title: Field-level-Requests-For-RFICS properties: field_id: type: string description: Field ID. minLength: 1 maxLength: 16 title: field_id field_name: type: string description: 'Field name. ' minLength: 1 maxLength: 70 title: field_name field_value: type: string description: 'Field value. ' minLength: 1 maxLength: 70 title: field_value input_type: type: string description: >- The Input type or template to provide the response against the field. It will be one the following - individual / entity / aircraft / vessel / unknown. If requested input type is unknown, populate fields from any of the other 4 input types in the response. minLength: 1 maxLength: 16 title: input_type required: - field_id - field_name - field_value - input_type Unstructured: type: string maxLength: 140 minLength: 1 description: Unstructured remitance information title: Unstructured 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) - For TH Instant payment debtor.proxy_id is optional - For US Instant payment debtor.proxy_id is not applicable - For IN IMPS debtor.proxy_id is not applicable - For UK FPS Instant payment debtor.proxy_id is not applicable - For IN UPI Instant payment debtor.proxy_id is mandatory, applicable value VPA ID - For US Wire payment, debtor.proxy_id field is not applicable - For US ACH CCD/PPD/IAT payment, debtor.proxy_id field is not applicable - For Japan Instant payment, debtor.proxy_id field is not applicable - 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) - For TH Instant payment debtor.proxy_type is optional - For US Instant payment debtor.proxy_type is not applicable - For IN IMPS debtor.proxy_type is not applicable - For UK FPS Instant payment debtor.proxy_type is not applicable - For IN UPI Instant payment debtor.proxy_type is not applicable - For US Wire payment, proxy_type field is not applicable - For US ACH CCD/PPD/IAT payment, debtor.proxy_type field is not applicable - For Japan Instant payment, debtor.proxy_type field is not applicable - For SEPA, debtor.proxy_type field is optional title: proxy_type account: maxLength: 40 minLength: 1 type: string description: >- Debtor's bank account - For IN IMPS, debtor.account max length is 34 - For UK FPS Instant payment debtor.account field allowed max length is 34 and either account number or IBAN/BBAN number can be passed - For IN UPI Instant payment debtor.account field allowed max length is 34 - For US Instant payment, debtor.account is a mandatory field with max length 34 and allowed value is Virtual account number and DDA. - For US Wire payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. - For US ACH CCD/PPD payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. - For US ACH IAT payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. - For Japan Instant payment debtor.account field is mandatory and allowed max length is 34 - 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 - For TH Instant payment debtor.name is not applicable - For US Instant payment debtor.name is mandatory - For IN IMPS Instant payment debtor.name is mandatory with max length 99 - For UK FPS Instant payment debtor.name field is optional with max length 40 - For IN UPI Instant payment debtor.name is mandatory with max length 99 - For US Wire payment, debtor.name field is mandatory with max length 35. Name cannot contains only NUMERIC values - For US ACH CCD/PPD payment, debtor.name field is mandatory with max length 16 - For US ACH IAT payment, debtor.name field is mandatory with max length 35 - 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 . , () - - 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 - For TH Instant payment debtor.address_lines is not applicable - For US Instant payment debtor.address_lines is optional - For IN IMPS debtor.address_lines is optional and allowed seven instance with each line max length of 70 - For UK FPS Instant payment debtor.address_lines is optional and allowed only four instance with each line max length of 35 - For IN UPI debtor.address_lines is optional and allowed seven instance with each line max length of 70 - 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 - 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 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\ - For Japan Instant payment debtor.address_lines is not applicable - 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 - For TH Instant payment debtor.street_name is not applicable - For US Instant payment debtor.street_name is optional - For IN IMPS, SEPA debtor.street_name is optional and max length is 70 - For UK FPS Instant payment debtor.street_name is not applicable - For IN UPI debtor.street_name is optional - 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 - 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 - For Japan Instant payment debtor.street_name is not applicable - 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 - For TH Instant payment debtor.building_number is not applicable - For US Instant payment debtor.building_number field is optional - For IN IMPS debtor.building_number field is optional - For UK FPS Instant payment debtor.building_number is not applicable - For IN UPI debtor.building_number field is optional - 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. - 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 - For Japan Instant payment debtor.building_number is not applicable - 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 - For TH Instant payment debtor.postal_code is not applicable - For US Instant payment debtor.postal_code field is optional - For IN IMPS debtor.postal_code is optional - For UK FPS Instant payment debtor.postal_code is not applicable - For IN UPI debtor.postal_code is optional - 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. - 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 - For Japan Instant payment debtor.postal_code is not applicable - 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 - For TH Instant payment city is not applicable - For US Instant payment city field is optional - For IN IMPS debtor.city is optional - For UK FPS Instant payment debtor.city is not applicable - For IN UPI debtor.city is optional - 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. - 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 - For Japan Instant payment debtor.city is not applicable - For SEPA, debtor.city is optional with max length 35 title: city state: maxLength: 35 minLength: 1 type: string description: |- Debtor's State - For TH Instant payment debtor.state is not applicable - For US Instant payment debtor.state field is optional - For IN IMPS debtor.state is optional - For UK FPS Instant payment debtor.state is not applicable - For IN UPI debtor.state is optional - 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. - 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 - For Japan Instant payment debtor.state is not applicable - For SEPA, debtor.state is optional and allowed max length is 35 title: state country: type: string description: |- Debtor's Country - For TH Instant payment debtor.country is not applicable - For US Instant payment debtor.country field is optional - For IN IMPS debtor.country is optional - For UK FPS Instant payment debtor.country field is mandatory, if debtor.address_line is provided by client - For IN UPI debtor.country is optional - For US Wire, debtor.country field is mandatory with max length 2. - 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 - For Japan Instant payment debtor.country is not applicable - 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 - For TH Instant payment debtor.org_id is not applicable - 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 - For IN IMPS debtor.org_id is not applicable - For UK FPS Instant payment debtor.org_id is not applicable - For IN UPI debtor.org_id is not applicable - For US Wire, debtor.org_id is not applicable - For US ACH CCD/PPD/IAT payments, debtor.org_id field is optional - For Japan Instant payment debtor.org_id is not applicable - 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 - For TH Instant payment debtor.birth_date is not applicable - For US Instant payment debtor.birth_date field is optional - For IN IMPS debtor.birth_date is not applicable - For UK FPS Instant payment debtor.birth_date is not applicable - For IN UPI debtor.birth_date is not applicable - For Stripe_US Wire, debtor.birth_date is not applicable - For US ACH CCD/PPD/IAT payment, debtor.birth_date field is not applicable - For Japan Instant payment debtor.birth_date is not applicable - For SEPA IDP, debtor.birth_date is optional - For SEPA, debtor.birth_date is optional title: birth_date birth_city: maxLength: 35 minLength: 1 type: string description: |- Debtor's birth_city - For TH Instant payment debtor.birth_city is not applicable - For US Instant payment debtor.birth_city field is optional - For IN IMPS debtor.birth_city is not applicable - For UK FPS Instant payment debtor.birth_city is not applicable - For IN UPI debtor.birth_city is not applicable - For Stripe_US Wire, debtor.birth_city is not applicable - For US ACH CCD/PPD/IAT payment, debtor.birth_city field is not applicable - For Japan Instant payment debtor.birth_city is not applicable - 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 - For TH Instant payment debtor.birth_country is not applicable - For US Instant payment debtor.birth_country field is optional - For IN IMPS debtor.birth_country is not applicable - For UK FPS Instant payment debtor.birth_country is not applicable - For IN UPI debtor.birth_country is not applicable - For Stripe_US Wire, debtor.birth_country is not applicable - For US ACH CCD/PPD/IAT payment, debtor.birth_country field is not applicable - For Japan Instant payment debtor.birth_country is not applicable - 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: |2- Debtor Province Of Birth - For TH Instant payment debtor.birth_province is not applicable - For US Instant payment debtor.birth_province is not applicable - For IN IMPS debtor.birth_province is not applicable - For UK FPS Instant payment debtor.birth_province is not applicable - For IN UPI debtor.birth_province is not applicable - For US Wire, debtor.birth_province is not applicable - For US ACH CCD/PPD payment, debtor.birth_province is not applicable - For US ACH IAT payment, debtor.birth_province is not applicable - For US ACH IAT payment, debtor.birth_province is not applicable - For SEPA, debtor.birth_province is optional with max length 35 - 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) - For TH Instant payment debtor.virtual_account field is optional - For US Instant payment debtor.virtual_account field is not applicable - For IN IMPS debtor.virtual_account field is not applicable - For UK FPS Instant payment debtor.virtual_account is not applicable - For IN UPI debtor.virtual_account field is not applicable - For Stripe_US Wire, debtor.vitual_account is not applicable - For US ACH CCD/PPD/IAT payment, debtor.virtual_account field is not applicable - For Japan Instant payment debtor.virtual_account is not applicable - 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) - For TH Instant payment debtor.bank_id field is optional and allowed maxlength is 3 - For US Instant payment debtor.bank_id field is mandatory - For IN IMPS Instant payment debtor.bank_id field is mandatory and client should pass IFSC code (including branch code) - For UK FPS Instant payment debtor.bank_id field is optional and allowed maxlength is 11 - For IN UPI Instant payment debtor.bank_id field is mandatory with max length 11 - 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 - For US ACH CCD/PPD/IAT payment, debtor.bank_id field is optional and allowed max length is 9 - For Japan Instant payment debtor.bank_id is optional - 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 - For TH Instant payment debtor.mobile_number field is not applicable - For US Instant payment debtor.mobile_number field is not applicable - For IN IMPS debtor.mobile_number field is optional - For UK FPS Instant payment debtor.mobile_number is not applicable - For IN UPI debtor.mobile_number field is mandatory, if transaction.advice_type is SMSM - For Stripe_US Wire, debtor.mobile_number is not applicable - For US ACH CCD/PPD/IAT payment, debtor.mobile_number field is not applicable - For Japan Instant payment debtor.mobile_number is not applicable - 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 - For TH Instant payment debtor.prvt_id is not applicable - 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 - For IN IMPS debtor.prvt_id is not applicable - For UK FPS Instant payment debtor.prvt_id is not applicable - For IN UPI debtor.prvt_id is not applicable - For Stripe_US Wire, debtor.prvt_id is not applicable - For US ACH CCD/PPD/IAT payments, debtor.prvt_id field is optional and applicable value is tax identification - For Japan Instant payment debtor.prvt_id is not applicable - 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. - For Thailand PromptPay debtor.bank_instructions field is not applicable - For United States debtor.bank_instructions field is not applicble - For IN IMPS debtor.bank_instructions field is not applicable - For UK FPS Instant payment debtor.bank_instructions field is not applicable - For IN UPI debtor.bank_instructions field is not applicable - 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/ - 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. - For Japan Instant payment debtor.bank_instructions is not applicable - 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 - For TH Instant payment debtor.bank_name is not applicable - For US Instant payment debtor.bank_name is not applicable - For IN IMPS Instant payment debtor.bank_name is not applicable - For UK FPS Instant payment debtor.bank_name is not applicable - For IN UPI Instant payment debtor.bank_name is not applicable - For US Wire payment, debtor.bank_name is not applicable - For US ACH CCD/PPD/IAT payment, debtor.bank_name is optional with max length 35 - For Japan Instant payment debtor.bank_name is not applicable - For India FIR IMPS payment, debtor.bank_name is mandatory with max length 100 - 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 - 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 - For India FIR IMPS payment, debtor.bank_account field is mandatory - 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 - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments debtor.scheme_name is not applicable - 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 - For TH Instant payment debtor.department is not applicable - For US Instant payment debtor.department is not applicable - For IN IMPS debtor.department is not applicable - For UK FPS Instant payment debtor.department is not applicable - For IN UPI debtor.department is not applicable - For US Wire, debtor.department is not applicable - For US ACH CCD/PPD payment, debtor.department is not applicable - For US ACH IAT payment, debtor.department is not applicable - For US ACH IAT payment, debtor.department is not applicable - For SEPA IDP, debtor.department is optional with max length 70 - For Japan Instant payment debtor.department field is not applicable - 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 - For TH Instant payment debtor.sub_department is not applicable - For US Instant payment debtor.sub_department is not applicable - For IN IMPS debtor.sub_department is not applicable - For UK FPS Instant payment debtor.sub_department is not applicable - For IN UPI debtor.sub_department is not applicable - For US Wire, debtor.sub_department is not applicable - For US ACH CCD/PPD payment, debtor.sub_department is not applicable - For US ACH IAT payment, debtor.sub_department is not applicable - For US ACH IAT payment, debtor.sub_department is not applicable - For SEPA IDP, debtor.sub_department is optional with max length 70 - For Japan Instant payment debtor.sub_department field is not applicable - 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 - For TH Instant payment debtor.building_name is not applicable - For US Instant payment debtor.building_name is not applicable - For IN IMPS debtor.building_name is not applicable - For UK FPS Instant payment debtor.building_name is not applicable - For IN UPI debtor.building_name is not applicable - For US Wire, debtor.building_name is not applicable - For US ACH CCD/PPD payment, debtor.building_name is not applicable - For US ACH IAT payment, debtor.building_name is not applicable - For US ACH IAT payment, debtor.building_name is not applicable - For SEPA IDP, debtor.building_name is optional with max length 35 - For Japan Instant payment debtor.building_name field is not applicable - 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 - For TH Instant payment debtor.floor is not applicable - For US Instant payment debtor.floor is not applicable - For IN IMPS debtor.floor is not applicable - For UK FPS Instant payment debtor.floor is not applicable - For IN UPI debtor.floor is not applicable - For US Wire, debtor.floor is not applicable - For US ACH CCD/PPD payment, debtor.floor is not applicable - For US ACH IAT payment, debtor.floor is not applicable - For US ACH IAT payment, debtor.floor is not applicable - For SEPA IDP, debtor.floor is optional with max length 70 - For Japan Instant payment debtor.floor field is not applicable - 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 - For TH Instant payment debtor.post_box is not applicable - For US Instant payment debtor.post_box is not applicable - For IN IMPS debtor.post_box is not applicable - For UK FPS Instant payment debtor.post_box is not applicable - For IN UPI debtor.post_box is not applicable - For US Wire, debtor.post_box is not applicable - For US ACH CCD/PPD payment, debtor.post_box is not applicable - For US ACH IAT payment, debtor.post_box is not applicable - For US ACH IAT payment, debtor.post_box is not applicable - For SEPA IDP, debtor.post_box is optional with max length 16 - For Japan Instant payment debtor.post_box field is not applicable - 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 - For TH Instant payment debtor.room is not applicable - For US Instant payment debtor.room is not applicable - For IN IMPS debtor.room is not applicable - For UK FPS Instant payment debtor.room is not applicable - For IN UPI debtor.room is not applicable - For US Wire, debtor.room is not applicable - For US ACH CCD/PPD payment, debtor.room is not applicable - For US ACH IAT payment, debtor.room is not applicable - For US ACH IAT payment, debtor.room is not applicable - For SEPA IDP, debtor.room is optional with max length 70 - For Japan Instant payment debtor.room field is not applicable - 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 - For TH Instant payment debtor.town_location_name is not applicable - For US Instant payment debtor.town_location_name is not applicable - For IN IMPS debtor.town_location_name is not applicable - For UK FPS Instant payment debtor.town_location_name is not applicable - For IN UPI debtor.town_location_name is not applicable - For US Wire, debtor.town_location_name is not applicable - For US ACH CCD/PPD payment, debtor.town_location_name is not applicable - For US ACH IAT payment, debtor.town_location_name is not applicable - For US ACH IAT payment, debtor.town_location_name is not applicable - For SEPA IDP, debtor.town_location_name is optional with max length 35 - For Japan Instant payment debtor.town_location_name field is not applicable - 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 - For TH Instant payment debtor.district_name is not applicable - For US Instant payment debtor.district_name is not applicable - For IN IMPS debtor.district_name is not applicable - For UK FPS Instant payment debtor.district_name is not applicable - For IN UPI debtor.district_name is not applicable - For US Wire, debtor.district_name is not applicable - For US ACH CCD/PPD payment, debtor.district_name is not applicable - For US ACH IAT payment, debtor.district_name is not applicable - For US ACH IAT payment, debtor.district_name is not applicable - For SEPA IDP, debtor.district_name is optional with max length 35 - For Japan Instant payment debtor.district_name field is not applicable - For SEPA, debtor.district_name is optional with max length 35 title: district_name anybic: maxLength: 35 minLength: 1 type: string description: |- debtor BIC - For TH Instant payment debtor.anybic is not applicable - For US Instant payment debtor.anybic is not applicable - For IN IMPS debtor.anybic is not applicable - For UK FPS Instant payment debtor.anybic is not applicable - For IN UPI debtor.anybic is not applicable - For US Wire, debtor.anybic is not applicable - For US ACH CCD/PPD payment, debtor.anybic is not applicable - For US ACH IAT payment, debtor.anybic is not applicable - For US ACH IAT payment, debtor.anybic is not applicable - For SEPA IDP, debtor.anybic is optional with max length 11 - For Japan Instant payment debtor.anybic field is not applicable - 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 - For TH Instant payment debtor.lei is not applicable - For US Instant payment debtor.lei is not applicable - For IN IMPS debtor.lei is not applicable - For UK FPS Instant payment debtor.lei is not applicable - For IN UPI debtor.lei is not applicable - For US Wire, debtor.lei is not applicable - For US ACH CCD/PPD payment, debtor.lei is not applicable - For US ACH IAT payment, debtor.lei is not applicable - For US ACH IAT payment, debtor.lei is not applicable - For SEPA IDP, debtor.lei is optional with max length 20 - For Japan Instant payment debtor.lei field is not applicable - 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 - For TH Instant payment debtor.issuer is not applicable - For US Instant payment debtor.issuer is not applicable - For IN IMPS debtor.issuer is not applicable - For UK FPS Instant payment debtor.issuer is not applicable - For IN UPI debtor.issuer is not applicable - For US Wire, debtor.issuer is not applicable - For US ACH CCD/PPD payment, debtor.issuer is not applicable - For US ACH IAT payment, debtor.issuer is not applicable - For US ACH IAT payment, debtor.issuer is not applicable - For SEPA IDP, debtor.issuer is optional with max length 35 - For Japan Instant payment debtor.issuer field is not applicable - 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 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) - For TH Instant payment debtor.proxy_type is optional - For US Instant payment debtor.proxy_type is not applicable - For IN IMPS debtor.proxy_type is not applicable - For UK FPS Instant payment debtor.proxy_type is not applicable - For JP Instant payment debtor.proxy_type is not applicable - For IN UPI Instant payment debtor.proxy_type is not applicable - For US Wire payment, debtor.proxy_type field is not applicable - For US ACH CCD/PPD/IAT payment, debtor.proxy_type field is not applicable - For SEPA IDP, this field is optional with max length 35 - 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 - For TH Instant payment debtor.tax_id is optional - For US Instant payment debtor.tax_id is not applicable - For IN IMPS debtor.tax_id field is not applicable - For UK FPS Instant payment debtor.tax_id is not applicable - For JP Instant payment debtor.tax_id is not applicable - For IN UPI debtor.tax_id field is not applicable - For US Wire, debtor.tax_id is not applicable - For US ACH CCD/PPD/IAT payment, debtor.tax_id field is not applicable - For SEPA IDP, this field is not applicable - For SEPA, this field is not applicable title: tax_id account: maxLength: 40 minLength: 1 type: string description: |- Debtor's bank account - For IN IMPS debtor.account field, allowed max length is 34 - For UK FPS Instant payment debtor.account field allowed max length is 34 and either account number or IBAN/BBAN number can be passed - For IN UPI Instant payment debtor.account field allowed max length is 34 - For US Instant payment, debtor.account is a mandatory field with and max length 34 and allowed value is Virtual account number and DDA. - For US Wire payment, debtor.account is a mandatory field with and max length 17 and allowed value is Virtual account number. - For US ACH CCD/PPD payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. - For US ACH IAT payment, debtor.account is a mandatory field with max length 17 and allowed value is Virtual account number. - For SEPA IDP, this field is mandatory with max length 34 - For Japan Instant payment debtor.account field is mandatory and allowed max length is 34 - 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 - For TH Instant payment debtor.account_name is not applicable - For US Instant payment debtor.account_name is optional - For IN IMPS debtor.account_name is not applicable - For UK FPS Instant payment debtor.account_name is not applicable - For JP Instant payment debtor.account_name is not applicable - For IN UPI debtor.account_name is not applicable - For US Wire, debtor.account_name is not applicable - For US ACH CCD/PPD/IAT payment, debtor.account_name is not applicable - For SEPA IDP, this field is not applicable - For SEPA, this field is not applicable title: account_name virtual_account: maxLength: 40 minLength: 1 type: string description: |- Debtor's virtual account - For TH Instant payment debtor.virtual_account is optional - For US Instant payment virtual_account is not applicable - For IN IMPS virtual_account is not applicable - For UK FPS Instant payment virtual_account is not applicable - For JP Instant payment debtor.virtual_account field is applicable - For IN UPI virtual_account is not applicable - For US Wire, debtor.vitual_account is not applicable - For US ACH CCD/PPD/IAT payment, debtor.virtual_account field is not applicable - For SEPA IDP, this field is not applicable - For SEPA, this field is not applicable title: virtual_account name: maxLength: 140 minLength: 1 type: string description: |- Debtor's bank account name - For TH Instant payment debtor.name is not applicable - For US Instant payment debtor.name is mandatory - For IN IMPS Instant payment debtor.name is mandatory with max length 99 - For UK FPS Instant payment debtor.name field is optional with max length 40 - For IN UPI Instant payment debtor.name is mandatory with max length 99 - For US Wire payment, debtor.name field is mandatory with max length 35. Name cannot contains only NUMERIC values - For US ACH CCD/PPD payment, debtor.name field is mandatory with max length 16 - For US ACH IAT payment, debtor.name field is mandatory with max length 35 - For SEPA IDP payment debtor.name is mandatory with max length 70 - For Japan Instant payment debtor.name field is optional - For SEPA, debtor.name is mandatory with max length 70 title: name address_lines: type: array description: |- Debtor's address_lines - For TH Instant payment debtor.address_lines is not applicable - For US Instant payment debtor.address_lines is optional - For IN IMPS debtor.address_lines is optional and allowed seven instance with each line max length of 70 - For UK FPS Instant payment debtor.address_lines is optional and allowed only four instance with each line max length of 35 - For IN UPI debtor.address_lines is optional and allowed seven instance with each line max length of 70 - 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 - 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 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\ - For SEPA IDP debtor.address_lines is optional and allowed two instance with each line max length of 70 - For Japan Instant payment debtor.address_lines is not applicable - 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 - For TH Instant payment debtor.street_name is not applicable - For US Instant payment debtor.street_name is optional - For IN IMPS debtor.street_name is optional - For UK FPS Instant payment debtor.street_name is not applicable - For IN UPI debtor.street_name is optional - 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. - 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 - For SEPA IDP, debtor.street_name is optional with max length 70 - For Japan Instant payment debtor.street_name is not applicable - 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 - For TH Instant payment debtor.building_number is not applicable - For US Instant payment debtor.building_number field is optional - For IN IMPS debtor.building_number field is optional - For UK FPS Instant payment debtor.building_number is not applicable - For IN UPI debtor.building_number field is optional - 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. - 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 - For SEPA IDP, debtor.building_number is optional with max length 16 - For Japan Instant payment debtor.building_number is not applicable - 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 - For TH Instant payment debtor.postal_code is not applicable - For US Instant payment debtor.postal_code field is optional - For IN IMPS debtor.postal_code is optional - For UK FPS Instant payment debtor.postal_code is not applicable - For IN UPI debtor.postal_code is optional - 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. - 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 - For SEPA IDP, debtor.postal_code is optional with max length 16 - For Japan Instant payment debtor.postal_code is not applicable - 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 - For TH Instant payment city is not applicable - For US Instant payment city field is optional - For IN IMPS debtor.city is optional - For UK FPS Instant payment debtor.city is not applicable - For IN UPI debtor.city is optional - 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. - 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 - For SEPA IDP, debtor.city is optional with max length 35 - For Japan Instant payment debtor.city is not applicable - For SEPA, debtor.city is optional with max length 35 title: city state: maxLength: 35 minLength: 1 type: string description: |- Debtor's State - For TH Instant payment debtor.state is not applicable - For US Instant payment debtor.state field is optional - For IN IMPS debtor.state is optional - For UK FPS Instant payment debtor.state is not applicable - For IN UPI debtor.state is optional - 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. - 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 - For SEPA IDP, debtor.state is optional with max length 35 - For Japan Instant payment debtor.state is not applicable - For SEPA, debtor.state is optional with max length 35 title: state country: type: string description: |- Debtor's Country - For TH Instant payment debtor.country is not applicable - For US Instant payment debtor.country field is optional - For IN IMPS debtor.country is optional - For UK FPS Instant payment debtor.country field is mandatory, if debtor.address_line is provided by client - For IN UPI debtor.country is optional - For US Wire, debtor.country field is mandatory with max length 2. - 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 - For SEPA IDP, debtor.country is optional - For Japan Instant payment debtor.country is not applicable - 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 - For TH Instant payment debtor.org_id is not applicable - 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 - For IN IMPS debtor.org_id is not applicable - For UK FPS Instant payment debtor.org_id is not applicable - For IN UPI debtor.org_id is not applicable - For US Wire, debtor.org_id is not applicable - For US ACH CCD/PPD/IAT payments, debtor.org_id field is optional - For SEPA IDP, debtor.org_id is optional with max length 35 - For Japan Instant payment debtor.org_id is not applicable - 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 - For TH Instant payment debtor.birth_date is not applicable - For US Instant payment debtor.birth_date field is optional - For IN IMPS debtor.birth_date is not applicable - For UK FPS Instant payment debtor.birth_date is not applicable - For IN UPI debtor.birth_date is not applicable - For US Wire, debtor.birth_date is not applicable - For US ACH CCD/PPD/IAT payment, debtor.birth_date field is not applicable - For SEPA IDP debtor.birth_date field is optional - For Japan Instant payment debtor.birth_date is not applicable - For SEPA, debtor.birth_date field is optional title: birth_date birth_city: maxLength: 35 minLength: 1 type: string description: |- Debtor's birth_city - For TH Instant payment debtor.birth_city is not applicable - For US Instant payment debtor.birth_city field is optional - For IN IMPS debtor.birth_city is not applicable - For UK FPS Instant payment debtor.birth_city is not applicable - For IN UPI debtor.birth_city is not applicable - For US Wire, debtor.birth_city is not applicable - For US ACH CCD/PPD/IAT payment, debtor.birth_city field is not applicable - For SEPA IDP debtor.birth_city field is optional with max length 35 - For Japan Instant payment debtor.birth_city is not applicable - For SEPA, debtor.birth_city field is optional with max length 35 title: birth_city birth_country: type: string description: |- Debtor's birth_country - For TH Instant payment debtor.birth_country is not applicable - For US Instant payment debtor.birth_country field is optional - For IN IMPS debtor.birth_country is not applicable - For UK FPS Instant payment debtor.birth_country is not applicable - For IN UPI debtor.birth_country is not applicable - For US Wire, debtor.birth_country is not applicable - For US ACH CCD/PPD/IAT payment, debtor.birth_country field is not applicable - For SEPA IDP debtor.birth_country field is optional - For Japan Instant payment debtor.birth_country is not applicable - 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) - For TH Instant payment debtor.bank_id field is optional and allowed maxlength is 3 - For US Instant payment debtor.bank_id field is mandatory - For IN IMPS Instant payment debtor.bank_id field is mandatory and client should pass IFSC code (including branch code) - For UK FPS Instant payment debtor.bank_id field is optional and allowed maxlength is 11 - For IN UPI Instant payment debtor.bank_id field is mandatory with max length 11 - 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 - For US ACH CCD/PPD/IAT payment, debtor.bank_id field is optional and allowed max length is 9. - For SEPA IDP debtor.bank_id field is mandatory with max length 11 - For SEPA IDP debtor.bank_id field is mandatory with max length 11 - For Japan Instant payment debtor.bank_id is optional - 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 - For TH Instant payment debtor.bank_branch_id field is not applicable - For US Instant payment debtor.bank_branch_id field is not applicable - For UK Instant payment debtor.bank_branch_id field is not applicable - For JP Instant payment debtor.bank_branch_id is applicable - For IN IMPS Instant payment debtor.bank_branch_id field is not applicable - For IN UPI Instant payment debtor.bank_branch_id field is not applicable - For US Wire, debtor.bank_branch_id is not applicable - For Stripe_US ACH CCD/PPD/IAT payment, debtor.bank_branch_id is not applicable - For SEPA IDP, this field is not applicable - 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 - For TH Instant payment debtor.mobile_number field is not applicable - For US Instant payment debtor.mobile_number field is not applicable - For IN IMPS debtor.mobile_number field is optional - For UK FPS Instant payment debtor.mobile_number is not applicable - For IN UPI debtor.mobile_number field is mandatory, if transaction.advice_type is SMSM - For US Wire, debtor.mobile_number is not applicable - For US ACH CCD/PPD/IAT payment, debtor.mobile_number field is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment debtor.mobile_number is not applicable - 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 - For TH Instant payment debtor.prvt_id is not applicable - 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 - For IN IMPS debtor.prvt_id is not applicable - For UK FPS Instant payment debtor.prvt_id is not applicable - For IN UPI debtor.prvt_id is not applicable - For US Wire, debtor.prvt_id is not applicable - For US ACH CCD/PPD/IAT payments, debtor.prvt_id field is optional and applicable value is tax identification - For SEPA IDP debtor.prvt_id field is optional with max length 35 - For Japan Instant payment debtor.prvt_id is not applicable - 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. - For Thailand PromptPay debtor.bank_instructions field is not applicable - For United States debtor.bank_instructions field is not applicble - For IN IMPS debtor.bank_instructions field is not applicable - For UK FPS Instant payment debtor.bank_instructions field is not applicable - For IN UPI debtor.bank_instructions field is not applicable - 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/ - 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. - For SEPA IDP, this field is not applicable - For Japan Instant payment debtor.bank_instructions is not applicable - For SEPA, this field is not applicable title: bank_instructions department: maxLength: 70 minLength: 1 type: string description: |- Debtor Address Department - For TH Instant payment debtor.department is not applicable - For US Instant payment debtor.department is not applicable - For IN IMPS debtor.department is not applicable - For UK FPS Instant payment debtor.department is not applicable - For IN UPI debtor.department is not applicable - For US Wire, debtor.department is not applicable - For US ACH CCD/PPD payment, debtor.department is not applicable - For US ACH IAT payment, debtor.department is not applicable - For US ACH IAT payment, debtor.department is not applicable - For SEPA IDP, debtor.department is optional with max length 70 - For Japan Instant payment debtor.department is not applicable - 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 - For TH Instant payment debtor.sub_department is not applicable - For US Instant payment debtor.sub_department is not applicable - For IN IMPS debtor.sub_department is not applicable - For UK FPS Instant payment debtor.sub_department is not applicable - For IN UPI debtor.sub_department is not applicable - For US Wire, debtor.sub_department is not applicable - For US ACH CCD/PPD payment, debtor.sub_department is not applicable - For US ACH IAT payment, debtor.sub_department is not applicable - For US ACH IAT payment, debtor.sub_department is not applicable - For SEPA IDP, debtor.sub_department is optional with max length 70 - For Japan Instant payment debtor.sub_department is not applicable - 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 - For TH Instant payment debtor.building_name is not applicable - For US Instant payment debtor.building_name is not applicable - For IN IMPS debtor.building_name is not applicable - For UK FPS Instant payment debtor.building_name is not applicable - For IN UPI debtor.building_name is not applicable - For US Wire, debtor.building_name is not applicable - For US ACH CCD/PPD payment, debtor.building_name is not applicable - For US ACH IAT payment, debtor.building_name is not applicable - For US ACH IAT payment, debtor.building_name is not applicable - For SEPA IDP, debtor.building_name is optional with max length 35 - For Japan Instant payment debtor.building_name is not applicable - 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 - For TH Instant payment debtor.floor is not applicable - For US Instant payment debtor.floor is not applicable - For IN IMPS debtor.floor is not applicable - For UK FPS Instant payment debtor.floor is not applicable - For IN UPI debtor.floor is not applicable - For US Wire, debtor.floor is not applicable - For US ACH CCD/PPD payment, debtor.floor is not applicable - For US ACH IAT payment, debtor.floor is not applicable - For US ACH IAT payment, debtor.floor is not applicable - For SEPA IDP, debtor.floor is optional with max length 70 - For Japan Instant payment debtor.floor is not applicable - 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 - For TH Instant payment debtor.post_box is not applicable - For US Instant payment debtor.post_box is not applicable - For IN IMPS debtor.post_box is not applicable - For UK FPS Instant payment debtor.post_box is not applicable - For IN UPI debtor.post_box is not applicable - For US Wire, debtor.post_box is not applicable - For US ACH CCD/PPD payment, debtor.post_box is not applicable - For US ACH IAT payment, debtor.post_box is not applicable - For US ACH IAT payment, debtor.post_box is not applicable - For SEPA IDP, debtor.post_box is optional with max length 16 - For Japan Instant payment debtor.post_box is not applicable - 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 - For TH Instant payment debtor.room is not applicable - For US Instant payment debtor.room is not applicable - For IN IMPS debtor.room is not applicable - For UK FPS Instant payment debtor.room is not applicable - For IN UPI debtor.room is not applicable - For US Wire, debtor.room is not applicable - For US ACH CCD/PPD payment, debtor.room is not applicable - For US ACH IAT payment, debtor.room is not applicable - For US ACH IAT payment, debtor.room is not applicable - For SEPA IDP, debtor.room is optional with max length 70 - For Japan Instant payment debtor.room is not applicable - 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 - For TH Instant payment debtor.town_location_name is not applicable - For US Instant payment debtor.town_location_name is not applicable - For IN IMPS debtor.town_location_name is not applicable - For UK FPS Instant payment debtor.town_location_name is not applicable - For IN UPI debtor.town_location_name is not applicable - For US Wire, debtor.town_location_name is not applicable - For US ACH CCD/PPD payment, debtor.town_location_name is not applicable - For US ACH IAT payment, debtor.town_location_name is not applicable - For US ACH IAT payment, debtor.town_location_name is not applicable - For SEPA IDP, debtor.town_location_name is optional with max length 35 - For Japan Instant payment debtor.town_location_name is not applicable - 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 - For TH Instant payment debtor.district_name is not applicable - For US Instant payment debtor.district_name is not applicable - For IN IMPS debtor.district_name is not applicable - For UK FPS Instant payment debtor.district_name is not applicable - For IN UPI debtor.district_name is not applicable - For US Wire, debtor.district_name is not applicable - For US ACH CCD/PPD payment, debtor.district_name is not applicable - For US ACH IAT payment, debtor.district_name is not applicable - For US ACH IAT payment, debtor.district_name is not applicable - For SEPA IDP, debtor.district_name is optional with max length 35 - For Japan Instant payment debtor.district_name is not applicable - For SEPA, debtor.district_name is optional with max length 35 title: district_name anybic: maxLength: 35 minLength: 1 type: string description: |- Debtor BIC - For TH Instant payment debtor.anybic is not applicable - For US Instant payment debtor.anybic is not applicable - For IN IMPS debtor.anybic is not applicable - For UK FPS Instant payment debtor.anybic is not applicable - For IN UPI debtor.anybic is not applicable - For US Wire, debtor.anybic is not applicable - For US ACH CCD/PPD payment, debtor.anybic is not applicable - For US ACH IAT payment, debtor.anybic is not applicable - For US ACH IAT payment, debtor.anybic is not applicable - For SEPA IDP, debtor.anybic is optional with max length 11 - For Japan Instant payment debtor.anybic is not applicable - 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 - For TH Instant payment debtor.lei is not applicable - For US Instant payment debtor.lei is not applicable - For IN IMPS debtor.lei is not applicable - For UK FPS Instant payment debtor.lei is not applicable - For IN UPI debtor.lei is not applicable - For US Wire, debtor.lei is not applicable - For US ACH CCD/PPD payment, debtor.lei is not applicable - For US ACH IAT payment, debtor.lei is not applicable - For US ACH IAT payment, debtor.lei is not applicable - For SEPA IDP, debtor.lei is optional with max length 20 - For Japan Instant payment debtor.lei is not applicable - 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 - For TH Instant payment debtor.issuer is not applicable - For US Instant payment debtor.issuer is not applicable - For IN IMPS debtor.issuer is not applicable - For UK FPS Instant payment debtor.issuer is not applicable - For IN UPI debtor.issuer is not applicable - For US Wire, debtor.issuer is not applicable - For US ACH CCD/PPD payment, debtor.issuer is not applicable - For US ACH IAT payment, debtor.issuer is not applicable - For US ACH IAT payment, debtor.issuer is not applicable - For SEPA IDP, debtor.issuer is optional with max length 35 - For Japan Instant payment debtor.issuer is not applicable - For SEPA, debtor.issuer is optional with max length 35 title: issuer birth_province: maxLength: 35 minLength: 1 type: string description: >2- Debtor Province Of Birth - For TH Instant payment debtor.birth_province is not applicable - For US Instant payment debtor.birth_province is not applicable - For IN IMPS debtor.birth_province is not applicable - For UK FPS Instant payment debtor.birth_province is not applicable - For IN UPI debtor.birth_province is not applicable - For US Wire, debtor.birth_province is not applicable - For US ACH CCD/PPD payment, debtor.birth_province is not applicable - For US ACH IAT payment, debtor.birth_province is not applicable - For US ACH IAT payment, debtor.birth_province is not applicable - For SEPA IDP, debtor.birth_province is optional with max length 35 - For Japan Instant payment debtor.birth_province is not applicable - 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 - 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 - 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 - For TH Instant payment debtor.bank_name is not applicable - For US Instant payment debtor.bank_name is not applicable - For IN IMPS Instant payment debtor.bank_name is not applicable - For UK FPS Instant payment debtor.bank_name is not applicable - For IN UPI Instant payment debtor.bank_name is not applicable - For US Wire payment, debtor.bank_name is not applicable - For US ACH CCD/PPD/IAT payment, debtor.bank_name is optional with max length 35 - For SEPA IDP debtor.bank_name is not applicable - For Japan Instant payment debtor.bank_name is not applicable - For India FIR IMPS payment, debtor.bank_name is mandatory with max length 100 - 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 Ultimate-Debtor-Initiation: type: object title: UltimateDebtorInitiation properties: name: maxLength: 140 minLength: 1 type: string description: |- Ultimate Debtor's bank account name - For SEPA, ultimate_debtor.name is optional and allowed max length is 70 - For TH Instant payment ultimate_debtor.name is not applicable - For US Instant payment ultimate_debtor.name is optional - For IN IMPS ultimate_debtor.name is not applicable - For UK FPS Instant payment ultimate_debtor.name is optional with max length 40 - For IN UPI ultimate_debtor.name is not applicable - 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. - For US ACH CCD/PPD/IAT payment, ultimate_debtor.name field is mandatory and allowed max length is 16 - 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 . , () - - For TH NRBA Instant remittances payment ultimate_debtor.name is mandatory - 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 - 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 - 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 - For SEPA, ultimate_debtor.address_lines field is optional with maximum of 2 lines allowed and upto 70 chars each line - For TH Instant payment ultimate_debtor.address_lines is not applicable - For US Instant payment ultimate_debtor.address_lines is optional - For IN IMPS ultimate_debtor.address_lines is not applicable - For UK FPS Instant payment ultimate_debtor.address_lines is optional with max 4 instances allowed and each line max length 35 - For IN UPI ultimate_debtor.address_lines is not applicable - 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 - 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 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\ - For Japan Instant payment ultimate_debtor.address_lines is optional with max 7 instances allowed and each line max length 70 - 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 - For SEPA, ultimate_debtor.street_name field is not applicable - For TH Instant payment ultimate_debtor.street_name is not applicable - For US Instant payment ultimate_debtor.street_name is optional - For IN IMPS ultimate_debtor.street_name is not applicable - For UK FPS Instant payment ultimate_debtor.street_name is optional with max length 70 - For IN UPI ultimate_debtor.street_name is not applicable - For US Wire ultimate_debtor.street_name is not applicable - 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 - For Japan Instant payment ultimate_debtor.street_name field is optional - 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 - 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 - 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 - For SEPA, TH Instant payment ultimate_debtor.building_number is not applicable - For US Instant payment ultimate_debtor.building_number field is optional - For IN IMPS ultimate_debtor.building_number is not applicable - For UK FPS Instant payment ultimate_debtor.building_number is optional with max length 16 - For IN UPI ultimate_debtor.building_number is not applicable - For US Wire ultimate_debtor.building_number is not applicable - 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 - For Japan Instant payment ultimate_debtor.building_number field is optional - 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 - For SEPA, TH Instant payment ultimate_debtor.postal_code is not applicable - For US Instant payment ultimate_debtor.postal_code field is optional - For IN IMPS ultimate_debtor.postal_code is not applicable - For UK FPS Instant payment ultimate_debtor.postal_code is optional with max length 16 - For IN UPI ultimate_debtor.postal_code is not applicable - For US Wire ultimate_debtor.postal_code is not applicable - 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 - For Japan Instant payment ultimate_debtor.postal_code field is optional - 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 - For TH, SEPA, US, IN IMPS, UK FPS, IN UPI, US Wire, US ACH, JP payments ultimate_debtor.town_name is not applicable - 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 - For SEPA, TH Instant payment ultimate_debtor.city is not applicable - For US Instant payment ultimate_debtor.city field is optional - For IN IMPS ultimate_debtor.city is not applicable - For UK FPS Instant payment ultimate_debtor.city is optional with max length 35 - For IN UPI ultimate_debtor.city is not applicable - For US Wire ultimate_debtor.city is not applicable - 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 - For Japan Instant payment ultimate_debtor.city field is optional - 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 - For SEPA, TH Instant payment ultimate_debtor.state is not applicable - For US Instant payment ultimate_debtor.state field is optional - For IN IMPS ultimate_debtor.state is not applicable - For UK FPS Instant payment ultimate_debtor.state is optional with max length 35 - For IN UPI ultimate_debtor.state is not applicable - For US Wire ultimate_debtor.state is not applicable - 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 - For Japan Instant payment ultimate_debtor.state field is optional - For India FIR IMPS payment, ultimate_debtor.state field is optional title: state country: type: string description: |- Ultimate Debtor's country - For TH Instant payment ultimate_debtor.country is not applicable - For US Instant payment ultimate_debtor.country field is optional - For IN IMPS ultimate_debtor.country is not applicable - For UK FPS Instant payment ultimate_debtor.country is conditional and becomes mandatory if ultimate_debtor.name is provided - For IN UPI ultimate_debtor.country is not applicable - For US Wire ultimate_debtor.country is not applicable - 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 - For TH NRBA Instant remittances payment ultimate_debtor.country field is mandatory, if client provided ultimate_debtor.town_name field - For India FIR IMPS payment, ultimate_debtor.country field is mandatory - 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 - For TH Instant payment ultimate_debtor.org_id is not applicable - 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 - For IN IMPS ultimate_debtor.org_id is not applicable - For UK FPS Instant payment ultimate_debtor.org_id is optional with max length 35 - For IN UPI ultimate_debtor.org_id is not applicable - 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 - 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/) - 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 - For Japan Instant payment ultimate_debtor.org_id field is optional - For India FIR IMPS payment, ultimate_debtor.org_id field is mandatory - 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 - For TH Instant payment ultimate_debtor.birth_date is not applicable - For US Instant payment ultimate_debtor.birth_date field is optional - For IN IMPS ultimate_debtor.birth_date is not applicable - For UK FPS Instant payment ultimate_debtor.birth_date field is optional - For IN UPI ultimate_debtor.birth_date is not applicable - For US Wire ultimate_debtor.birth_date is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_date is not applicable - For Japan Instant payment ultimate_debtor.birth_date field is not applicable - 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 - For TH Instant payment ultimate_debtor.birth_city is not applicable - For US Instant payment ultimate_debtor.birth_city field is optional - For IN IMPS ultimate_debtor.birth_city is not applicable - For UK FPS Instant payment ultimate_debtor.birth_city is optional with max length 35 - For IN UPI ultimate_debtor.birth_city is not applicable - For US Wire ultimate_debtor.birth_city is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_city is not applicable - For Japan Instant payment ultimate_debtor.birth_city field is not applicable - 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 - For TH Instant payment ultimate_debtor.birth_country is not applicable - For US Instant payment ultimate_debtor.birth_country field is optional - For IN IMPS ultimate_debtor.birth_country is not applicable - For UK FPS Instant payment ultimate_debtor.birth_country is optional with max length 2 - For IN UPI ultimate_debtor.birth_country is not applicable - For US Wire ultimate_debtor.birth_country is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_country is not applicable - For Japan Instant payment ultimate_debtor.birth_country field is not applicable - 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 - For TH Instant payment ultimate_debtor.birth_province is not applicable - For US Instant payment ultimate_debtor.birth_province is not applicable - For IN IMPS ultimate_debtor.birth_province is not applicable - For UK FPS Instant payment ultimate_debtor.birth_province is not applicable - For IN UPI ultimate_debtor.birth_province is not applicable - For US Wire, ultimate_debtor.birth_province is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.birth_province is not applicable - For US ACH IAT payment, ultimate_debtor.birth_province is not applicable - For US ACH IAT payment, ultimate_debtor.birth_province is not applicable - For SEPA IDP, ultimate_debtor.birth_province is optional with max length 35 - For Japan Instant payment ultimate_debtor.birth_province field is not applicable - 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 - For TH Instant payment ultimate_debtor.prvt_id is not applicable - 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 - For IN IMPS ultimate_debtor.prvt_id is not applicable - For UK FPS Instant payment ultimate_debtor.prvt_id is not applicable - For IN UPI ultimate_debtor.prvt_id is not applicable - 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 - 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 - 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 - For Japan Instant payment ultimate_debtor.prvt_id field is not applicable - 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 - For TH Instant payment ultimate_debtor.department is not applicable - For US Instant payment ultimate_debtor.department is not applicable - For IN IMPS ultimate_debtor.department is not applicable - For UK FPS Instant payment ultimate_debtor.department is not applicable - For IN UPI ultimate_debtor.department is not applicable - For US Wire, ultimate_debtor.department is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.department is not applicable - For US ACH IAT payment, ultimate_debtor.department is not applicable - For US ACH IAT payment, ultimate_debtor.department is not applicable - For SEPA IDP, ultimate_debtor.department is optional with max length 70 - For Japan Instant payment ultimate_debtor.department field is not applicable - 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 - For TH Instant payment ultimate_debtor.sub_department is not applicable - For US Instant payment ultimate_debtor.sub_department is not applicable - For IN IMPS ultimate_debtor.sub_department is not applicable - For UK FPS Instant payment ultimate_debtor.sub_department is not applicable - For IN UPI ultimate_debtor.sub_department is not applicable - For US Wire, ultimate_debtor.sub_department is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.sub_department is not applicable - For US ACH IAT payment, ultimate_debtor.sub_department is not applicable - For US ACH IAT payment, ultimate_debtor.sub_department is not applicable - For SEPA IDP, ultimate_debtor.sub_department is optional with max length 70 - For Japan Instant payment ultimate_debtor.sub_department field is not applicable - 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 - For TH Instant payment ultimate_debtor.building_name is not applicable - For US Instant payment ultimate_debtor.building_name is not applicable - For IN IMPS ultimate_debtor.building_name is not applicable - For UK FPS Instant payment ultimate_debtor.building_name is not applicable - For IN UPI ultimate_debtor.building_name is not applicable - For US Wire, ultimate_debtor.building_name is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.building_name is not applicable - For US ACH IAT payment, ultimate_debtor.building_name is not applicable - For US ACH IAT payment, ultimate_debtor.building_name is not applicable - For SEPA IDP, ultimate_debtor.building_name is optional with max length 35 - For Japan Instant payment ultimate_debtor.building_name field is not applicable - 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 - For TH Instant payment ultimate_debtor.floor is not applicable - For US Instant payment ultimate_debtor.floor is not applicable - For IN IMPS ultimate_debtor.floor is not applicable - For UK FPS Instant payment ultimate_debtor.floor is not applicable - For IN UPI ultimate_debtor.floor is not applicable - For US Wire, ultimate_debtor.floor is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.floor is not applicable - For US ACH IAT payment, ultimate_debtor.floor is not applicable - For US ACH IAT payment, ultimate_debtor.floor is not applicable - For SEPA IDP, ultimate_debtor.floor is optional with max length 70 - For Japan Instant payment ultimate_debtor.floor field is not applicable - 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 - For TH Instant payment ultimate_debtor.post_box is not applicable - For US Instant payment ultimate_debtor.post_box is not applicable - For IN IMPS ultimate_debtor.post_box is not applicable - For UK FPS Instant payment ultimate_debtor.post_box is not applicable - For IN UPI ultimate_debtor.post_box is not applicable - For US Wire, ultimate_debtor.post_box is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.post_box is not applicable - For US ACH IAT payment, ultimate_debtor.post_box is not applicable - For US ACH IAT payment, ultimate_debtor.post_box is not applicable - For SEPA IDP, ultimate_debtor.post_box is optional with max length 16 - For Japan Instant payment ultimate_debtor.post_box field is not applicable - 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 - For TH Instant payment ultimate_debtor.room is not applicable - For US Instant payment ultimate_debtor.room is not applicable - For IN IMPS ultimate_debtor.room is not applicable - For UK FPS Instant payment ultimate_debtor.room is not applicable - For IN UPI ultimate_debtor.room is not applicable - For US Wire, ultimate_debtor.room is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.room is not applicable - For US ACH IAT payment, ultimate_debtor.room is not applicable - For US ACH IAT payment, ultimate_debtor.room is not applicable - For SEPA IDP, ultimate_debtor.room is optional with max length 70 - For Japan Instant payment ultimate_debtor.room field is not applicable - 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 - For TH Instant payment ultimate_debtor.town_location_name is not applicable - For US Instant payment ultimate_debtor.town_location_name is not applicable - For IN IMPS ultimate_debtor.town_location_name is not applicable - For UK FPS Instant payment ultimate_debtor.town_location_name is not applicable - For IN UPI ultimate_debtor.town_location_name is not applicable - For US Wire, ultimate_debtor.town_location_name is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.town_location_name is not applicable - For US ACH IAT payment, ultimate_debtor.town_location_name is not applicable - For US ACH IAT payment, ultimate_debtor.town_location_name is not applicable - For SEPA IDP, ultimate_debtor.town_location_name is optional with max length 35 - For Japan Instant payment ultimate_debtor.town_location_name field is not applicable - 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 - For TH Instant payment ultimate_debtor.district_name is not applicable - For US Instant payment ultimate_debtor.district_name is not applicable - For IN IMPS ultimate_debtor.district_name is not applicable - For UK FPS Instant payment ultimate_debtor.district_name is not applicable - For IN UPI ultimate_debtor.district_name is not applicable - For US Wire, ultimate_debtor.district_name is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.district_name is not applicable - For US ACH IAT payment, ultimate_debtor.district_name is not applicable - For US ACH IAT payment, ultimate_debtor.district_name is not applicable - For SEPA IDP, ultimate_debtor.district_name is optional with max length 35 - For Japan Instant payment ultimate_debtor.district_name field is not applicable - 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 - For TH Instant payment ultimate_debtor.anybic is not applicable - For US Instant payment ultimate_debtor.anybic is not applicable - For IN IMPS ultimate_debtor.anybic is not applicable - For UK FPS Instant payment ultimate_debtor.anybic is not applicable - For IN UPI ultimate_debtor.anybic is not applicable - For US Wire, ultimate_debtor.anybic is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.anybic is not applicable - For US ACH IAT payment, ultimate_debtor.anybic is not applicable - For US ACH IAT payment, ultimate_debtor.anybic is not applicable - For SEPA IDP, ultimate_debtor.anybic is optional with max length 11 - For Japan Instant payment ultimate_debtor.anybic field is not applicable - 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 - For TH Instant payment ultimate_debtor.lei is not applicable - For US Instant payment ultimate_debtor.lei is not applicable - For IN IMPS ultimate_debtor.lei is not applicable - For UK FPS Instant payment ultimate_debtor.lei is not applicable - For IN UPI ultimate_debtor.lei is not applicable - For US Wire, ultimate_debtor.lei is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.lei is not applicable - For US ACH IAT payment, ultimate_debtor.lei is not applicable - For US ACH IAT payment, ultimate_debtor.lei is not applicable - For SEPA IDP, ultimate_debtor.lei is optional with max length 20 - For Japan Instant payment ultimate_debtor.lei field is not applicable - 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 - For TH Instant payment ultimate_debtor.issuer is not applicable - For US Instant payment ultimate_debtor.issuer is not applicable - For IN IMPS ultimate_debtor.issuer is not applicable - For UK FPS Instant payment ultimate_debtor.issuer is not applicable - For IN UPI ultimate_debtor.issuer is not applicable - For US Wire, ultimate_debtor.issuer is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.issuer is not applicable - For US ACH IAT payment, ultimate_debtor.issuer is not applicable - For US ACH IAT payment, ultimate_debtor.issuer is not applicable - For SEPA IDP, ultimate_debtor.issuer is optional with max length 35 - For Japan Instant payment ultimate_debtor.issuer field is not applicable - For SEPA, ultimate_debtor.issuer is optional with max length 35 title: issuer additionalProperties: false description: Ultimate Debtor information Ultimate-Debtor-Status: type: object title: UltimateDebtorStatus properties: name: maxLength: 140 minLength: 1 type: string description: |- Ultimate Debtor's bank account name - For TH Instant payment ultimate_debtor.name is not applicable - For US Instant payment ultimate_debtor.name is optional - For IN IMPS ultimate_debtor.name is not applicable - For UK FPS Instant payment ultimate_debtor.name is optional with max length 40 - For IN UPI ultimate_debtor.name is not applicable - 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. - For US ACH CCD/PPD/IAT payment, ultimate_debtor.name field is mandatory and allowed max length is 16 - For Japan Instant payment ultimate_debtor.name field is optional - For TH NRBA Instant remittances payment ultimate_debtor.name is mandatory - For India FIR IMPS payment, ultimate_debtor.name field is mandatory with max length 50 - For SEPA, ultimate_debtor.name is optional with max length 70 - For SEPA IDP ultimate_debtor.name is optional with max length 70 title: name address_lines: type: array description: >- Ultimate Debtor's address_lines - For TH Instant payment ultimate_debtor.address_lines is not applicable - For US Instant payment ultimate_debtor.address_lines is optional - For IN IMPS ultimate_debtor.address_lines is not applicable - For UK FPS Instant payment ultimate_debtor.address_lines is optional with max 4 instances allowed and each line max length 35 - For IN UPI ultimate_debtor.address_lines is not applicable - 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 - 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 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\ - For Japan Instant payment ultimate_debtor.address_lines is optional with max 7 instances allowed and each line max length 70 - For India FIR IMPS payment ultimate_debtor.address_lines is optional - For SEPA IDP, ultimate_debtor.address_lines field is optional with maximum of 2 lines allowed and upto 70 chars each line - 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 - For TH Instant payment ultimate_debtor.street_name is not applicable - For US Instant payment ultimate_debtor.street_name is optional - For IN IMPS ultimate_debtor.street_name is not applicable - For UK FPS Instant payment ultimate_debtor.street_name is optional with max length 70 - For IN UPI ultimate_debtor.street_name is not applicable - For US Wire ultimate_debtor.street_name is not applicable - 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 - For Japan Instant payment ultimate_debtor.street_name field is optional - For India FIR IMPS payment, ultimate_debtor.street_name field is mandatory with max length 35 - For SEPA, ultimate_debtor.street_name field is not applicable - 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 - For TH Instant payment ultimate_debtor.building_number is not applicable - For US Instant payment ultimate_debtor.building_number field is optional - For IN IMPS ultimate_debtor.building_number is not applicable - For UK FPS Instant payment ultimate_debtor.building_number is optional with max length 16 - For IN UPI ultimate_debtor.building_number is not applicable - For US Wire ultimate_debtor.building_number is not applicable - 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 - For Japan Instant payment ultimate_debtor.building_number field is optional - For India FIR IMPS payment, ultimate_debtor.building_number field is mandatory with max length 16 - For SEPA, ultimate_debtor.street_name field is not applicable - 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 - For TH Instant payment ultimate_debtor.postal_code is not applicable - For US Instant payment ultimate_debtor.postal_code field is optional - For IN IMPS ultimate_debtor.postal_code is not applicable - For UK FPS Instant payment ultimate_debtor.postal_code is optional with max length 16 - For IN UPI ultimate_debtor.postal_code is not applicable - For US Wire ultimate_debtor.postal_code is not applicable - 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 - For Japan Instant payment ultimate_debtor.postal_code field is optional - For India FIR IMPS payment, ultimate_debtor.postal_code field is mandatory - For SEPA, ultimate_debtor.postal_code is not applicable - 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 - For SEPA,TH, US, IN IMPS, UK FPS, IN UPI, US Wire, JP payments ultimate_debtor.town_name is not applicable - For TH NRBA Instant remittances payment ultimate_debtor.town_name field is mandatory, if client provided ultimate_debtor.country field - For SEPA IDP, this field is not applicable title: town_name city: maxLength: 35 minLength: 1 type: string description: |- Ultimate Debtor's city - For TH Instant payment ultimate_debtor.city is not applicable - For US Instant payment ultimate_debtor.city field is optional - For IN IMPS ultimate_debtor.city is not applicable - For UK FPS Instant payment ultimate_debtor.city is optional with max length 35 - For IN UPI ultimate_debtor.city is not applicable - For US Wire ultimate_debtor.city is not applicable - 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 - For Japan Instant payment ultimate_debtor.city field is optional - For India FIR IMPS payment, ultimate_debtor.city field is mandatory - For SEPA, ultimate_debtor.postal_code is not applicable - For SEPA IDP, ultimate_debtor.postal_code is not applicable title: city state: maxLength: 35 minLength: 1 type: string description: |- Ultimate Debtor's state - For TH Instant payment ultimate_debtor.state is not applicable - For US Instant payment ultimate_debtor.state field is optional - For IN IMPS ultimate_debtor.state is not applicable - For UK FPS Instant payment ultimate_debtor.state is optional with max length 35 - For IN UPI ultimate_debtor.state is not applicable - For US Wire ultimate_debtor.state is not applicable - 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 - For Japan Instant payment ultimate_debtor.state field is optional - For India FIR IMPS payment, ultimate_debtor.state field is optional - For SEPA, ultimate_debtor.postal_code is not applicable - For SEPA IDP, ultimate_debtor.postal_code is not applicable title: state country: type: string description: |- Ultimate Debtor's country - For TH Instant payment ultimate_debtor.country is not applicable - For US Instant payment ultimate_debtor.country field is optional - For IN IMPS ultimate_debtor.country is not applicable - For UK FPS Instant payment ultimate_debtor.country is conditional and becomes mandatory if ultimate_debtor.name is provided - For IN UPI ultimate_debtor.country is not applicable - For US Wire ultimate_debtor.country is not applicable - 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 - For TH NRBA Instant remittances payment ultimate_debtor.country field is mandatory, if client provided ultimate_debtor.town_name field - For India FIR IMPS payment, ultimate_debtor.country field is mandatory - For SEPA ultimate_debtor.country is conditional and becomes mandatory if ultimate_debtor.name is provided - 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 - For TH Instant payment ultimate_debtor.org_id is not applicable - 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 - For IN IMPS ultimate_debtor.org_id is not applicable - For UK FPS Instant payment ultimate_debtor.org_id is optional with max length 35 - For IN UPI ultimate_debtor.org_id is not applicable - 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 - 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/) - 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 - For SEPA IDP ultimate_debtor.org_id is optional with max length 35 - For Japan Instant payment ultimate_debtor.org_id field is not applicable - For India FIR IMPS payment, ultimate_debtor.org_id field is mandatory - For SEPA, ultimate_debtor.org_id is optional with max length 35 - 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 - For TH Instant payment ultimate_debtor.birth_date is not applicable - For US Instant payment ultimate_debtor.birth_date field is optional - For IN IMPS ultimate_debtor.birth_date is not applicable - For UK FPS Instant payment ultimate_debtor.birth_date field is optional - For IN UPI ultimate_debtor.birth_date is not applicable - For US Wire ultimate_debtor.birth_date is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_date is not applicable - For SEPA IDP ultimate_debtor.birth_date field is optional - For Japan Instant payment ultimate_debtor.birth_date field is not applicable - 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 - For TH Instant payment ultimate_debtor.birth_city is not applicable - For US Instant payment ultimate_debtor.birth_city field is optional - For IN IMPS ultimate_debtor.birth_city is not applicable - For UK FPS Instant payment ultimate_debtor.birth_city is optional with max length 35 - For IN UPI ultimate_debtor.birth_city is not applicable - For US Wire ultimate_debtor.birth_city is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_city is not applicable - For SEPA IDP ultimate_debtor.birth_city is optional with max length 35 - For Japan Instant payment ultimate_debtor.birth_city field is not applicable - 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 - For TH Instant payment ultimate_debtor.birth_country is not applicable - For US Instant payment ultimate_debtor.birth_country field is optional - For IN IMPS ultimate_debtor.birth_country is not applicable - For UK FPS Instant payment ultimate_debtor.birth_country is optional with max length 2 - For IN UPI ultimate_debtor.birth_country is not applicable - For US Wire ultimate_debtor.birth_country is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_debtor.birth_country is not applicable - For SEPA IDP ultimate_debtor.birth_country field is optional - For Japan Instant payment ultimate_debtor.birth_country field is not applicable - 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 - For TH Instant payment ultimate_debtor.prvt_id is not applicable - 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 - For IN IMPS ultimate_debtor.prvt_id is not applicable - For UK FPS Instant payment ultimate_debtor.prvt_id is not applicable - For IN UPI ultimate_debtor.prvt_id is not applicable - 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 - 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 - 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 - For SEPA IDP ultimate_debtor.prvt_id field is optional with max length 35 - For SEPA, ultimate_debtor.prvt_id field is optional with max length 35 - For Japan Instant payment ultimate_debtor.prvt_id field is not applicable - 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 - For TH Instant payment ultimate_debtor.anybic is not applicable - For US Instant payment ultimate_debtor.anybic is not applicable - For IN IMPS ultimate_debtor.anybic is not applicable - For UK FPS Instant payment ultimate_debtor.anybic is not applicable - For IN UPI ultimate_debtor.anybic is not applicable - For US Wire, ultimate_debtor.anybic is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.anybic is not applicable - For US ACH IAT payment, ultimate_debtor.anybic is not applicable - For US ACH IAT payment, ultimate_debtor.anybic is not applicable - For SEPA IDP, ultimate_debtor.anybic is optional with max length 11 - For Japan Instant payment ultimate_debtor.anybic field is not applicable - 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 - For TH Instant payment ultimate_debtor.lei is not applicable - For US Instant payment ultimate_debtor.lei is not applicable - For IN IMPS ultimate_debtor.lei is not applicable - For UK FPS Instant payment ultimate_debtor.lei is not applicable - For IN UPI ultimate_debtor.lei is not applicable - For US Wire, ultimate_debtor.lei is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.lei is not applicable - For US ACH IAT payment, ultimate_debtor.lei is not applicable - For US ACH IAT payment, ultimate_debtor.lei is not applicable - For SEPA IDP, ultimate_debtor.lei is optional with max length 20 - For Japan Instant payment ultimate_debtor.lei field is not applicable - 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 - For TH Instant payment ultimate_debtor.issuer is not applicable - For US Instant payment ultimate_debtor.issuer is not applicable - For IN IMPS ultimate_debtor.issuer is not applicable - For UK FPS Instant payment ultimate_debtor.issuer is not applicable - For IN UPI ultimate_debtor.issuer is not applicable - For US Wire, ultimate_debtor.issuer is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.issuer is not applicable - For US ACH IAT payment, ultimate_debtor.issuer is not applicable - For US ACH IAT payment, ultimate_debtor.issuer is not applicable - For SEPA IDP, ultimate_debtor.issuer is optional with max length 35 - For Japan Instant payment ultimate_debtor.issuer field is not applicable - 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 - For TH Instant payment ultimate_debtor.birth_province is not applicable - For US Instant payment ultimate_debtor.birth_province is not applicable - For IN IMPS ultimate_debtor.birth_province is not applicable - For UK FPS Instant payment ultimate_debtor.birth_province is not applicable - For IN UPI ultimate_debtor.birth_province is not applicable - For US Wire, ultimate_debtor.birth_province is not applicable - For US ACH CCD/PPD payment, ultimate_debtor.birth_province is not applicable - For US ACH IAT payment, ultimate_debtor.birth_province is not applicable - For US ACH IAT payment, ultimate_debtor.birth_province is not applicable - For SEPA IDP, ultimate_debtor.birth_province is optional with max length 35 - For Japan Instant payment ultimate_debtor.birth_province field is not applicable - 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 - 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 - 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 Intermediary-Initiation: title: IntermediaryInitiation description: Intermediary agent information type: array maxItems: 3 items: $ref: '#/components/schemas/Intermediary-Details' 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) - For TH Instant payment Intermediary.bank_id field is not applicable - For US Instant payment Intermediary.bank_id field is not applicable - For IN IMPS Instant payment Intermediary.bank_id field is not applicable - For UK FPS Instant payment Intermediary.bank_id field is not applicable - For IN UPI Instant payment Intermediary.bank_id field is not applicable - 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 - For US ACH CCD/PPD payment, Intermediary.bank_id is not applicable - For US ACH IAT payment, Intermediary.bank_id is mandatory and allowed max length is 11 - 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 - For TH Instant payment Intermediary.bank_name is not applicable - For US Instant payment Intermediary.bank_name is not applicable - For IN IMPS Instant payment Intermediary.bank_name is not applicable - For UK FPS Instant payment Intermediary.bank_name is not applicable - For IN UPI Instant payment Intermediary.bank_name is not applicable - For US Wire, Intermediary.bank_name field is conditional with max length 35. Mandaotry if payment is 3 and 4 credit party payment - For US ACH CCD/PPD payment, Intermediary.bank_name is not applicable - For US ACH IAT payment, Intermediary.bank_name is optional and allowed max length is 35 - For Japan Instant payment Intermediary.bank_name field is not applicable title: name bank_country: type: string description: |- intermediary agent Country - For TH Instant payment intermediary.bank_country is not applicable - For US Instant payment intermediary.bank_country is not applicable - For IN IMPS intermediary.bank_country is not applicable - For UK FPS Instant payment intermediary.bank_country is not applicable - For IN UPI intermediary.bank_country is not applicable - For US Wire, intermediary.bank_country field is mandatory with max length 2. - For US ACH CCD/PPD payment, Intermediary.bank_country is not applicable - For US ACH IAT payment, Intermediary.bank_country is mandatory - 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 - For TH Instant payment intermediary.bank_address_lines is not applicable - For US Instant payment intermediary.bank_address_lines is not applicable - For IN IMPS intermediary.bank_address_lines is not applicable - For UK FPS Instant payment intermediary.bank_address_lines is not applicable - For IN UPI intermediary.bank_address_lines is not applicable - For US Wire payment, intermediary.bank_.address_lines field is optional and upto 3 lines of min 1 and max 35 characters are allowed. - For US ACH CCD/PPD/IAT payment, Intermediary.bank_address_lines is not applicable - 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 - For TH Instant payment intermediary.bank_account_id is not applicable - For US Instant payment intermediary.bank_account_id is not applicable - For IN IMPS intermediary.bank_account_id is not applicable - For UK FPS Instant payment intermediary.bank_account_id is not applicable - For IN UPI intermediary.bank_account_id is not applicable - For US Wire, intermediary.bank_account_id is an optional field with max length is 34 - For US ACH CCD/PPD/IAT payment, Intermediary.bank_account_id is not applicable - 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 Intermediary-Status: title: IntermediaryStatus description: Intermediary agent information status type: array maxItems: 3 items: $ref: '#/components/schemas/Intermediary-Details-Status' 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) - For TH Instant payment Intermediary.bank_id field is not applicable - For US Instant payment Intermediary.bank_id field is not applicable - For IN IMPS Instant payment Intermediary.bank_id field is not applicable - For UK FPS Instant payment Intermediary.bank_id field is not applicable - For IN UPI Instant payment Intermediary.bank_id field is not applicable - 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 - For US ACH CCD/PPD payment, Intermediary.bank_id is not applicable - For US ACH IAT payment, Intermediary.bank_id is mandatory and allowed max length is 11 - For SEPA IDP, this field is not applicable - 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 - For TH Instant payment Intermediary.bank_name is not applicable - For US Instant payment Intermediary.bank_name is not applicable - For IN IMPS Instant payment Intermediary.bank_name is not applicable - For UK FPS Instant payment Intermediary.bank_name is not applicable - For IN UPI Instant payment Intermediary.bank_name is not applicable - For US Wire, Intermediary.bank_name field is conditional with max length 35. Mandaotry if payment is 3 and 4 credit party payment - For US ACH CCD/PPD payment, Intermediary.bank_name is not applicable - For US ACH IAT payment, Intermediary.bank_name is optional and allowed max length is 35 - For SEPA IDP, this field is not applicable - For Japan Instant payment Intermediary.bank_name field is not applicable title: name bank_country: type: string description: |- intermediary agent Country - For TH Instant payment intermediary.bank_country is not applicable - For US Instant payment intermediary.bank_country is not applicable - For IN IMPS intermediary.bank_country is not applicable - For UK FPS Instant payment intermediary.bank_country is not applicable - For IN UPI intermediary.bank_country is not applicable - For US Wire, intermediary.bank_country field is mandatory with max length 2. - For US ACH CCD/PPD payment, Intermediary.bank_country is not applicable - For US ACH IAT payment, Intermediary.bank_country is mandatory - For SEPA IDP, this field is not applicable - 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 - For TH Instant payment intermediary.bank_address_lines is not applicable - For US Instant payment intermediary.bank_address_lines is not applicable - For IN IMPS intermediary.bank_address_lines is not applicable - For UK FPS Instant payment intermediary.bank_address_lines is not applicable - For IN UPI intermediary.bank_address_lines is not applicable - For US Wire payment, intermediary.bank_.address_lines field is optional and upto 3 lines of min 1 and max 35 characters are allowed. - For US ACH CCD/PPD/IAT payment, Intermediary.bank_address_lines is not applicable - For SEPA IDP, this field is not applicable - 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 - For TH Instant payment intermediary.bank_account_id is not applicable - For US Instant payment intermediary.bank_account_id is not applicable - For IN IMPS intermediary.bank_account_id is not applicable - For UK FPS Instant payment intermediary.bank_account_id is not applicable - For IN UPI intermediary.bank_account_id is not applicable - For US Wire, intermediary.bank_account_id is an optional field with max length is 34 - For US ACH CCD/PPD/IAT payment, Intermediary.bank_account_id is not applicable - For SEPA IDP, this field is not applicable - 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 Creditor-Initiation: type: object title: CreditorInitiation properties: proxy_id: maxLength: 255 minLength: 1 type: string description: >- Creditor's proxy identification (e.g., email address) - Thailand PromptPay - If you don't provide account, proxy_id is required. - For US Instant payment creditor.proxy_id field is not applicable - For IN IMPS creditor.proxy_id field is not applicable - For UK FPS Instant payment creditor.proxy_id field is not applicable - 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 - For US Wire, creditor.proxy_id field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.proxy_id is not applicable - For Japan Instant payment creditor.proxy_id field is not applicable - 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) - 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. - For US Instant payment creditor.proxy_type field is not applicable - For IN IMPS creditor.proxy_type field is not applicable - For UK FPS Instant payment creditor.proxy_type field is not applicable - For IN UPI creditor.proxy_type field is not applicable - For US Wire, creditor.proxy_type field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.proxy_type is not applicable - For Japan Instant payment creditor.proxy_type field is not applicable - 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 - Thailand PromptPay - If you don't provide proxy_id, account and bank_id is required - For US Instant payment creditor.account field is mandatory - For IN IMPS creditor.account field is mandatory with max length 34 - 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 - For IN UPI creditor.account field is mandatory with max length 34, if creditor.proxy_id is not provided by client - For US Wire, creditor.account is a mandatory field with max length is 34 and allowed value is Virtual account number. - 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. - For Japan Instant payment creditor.proxy_type field is mandatory and allowed max length is 7 - 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 - Thailand PromptPay - Maximum length is 50. - For US Instant payment creditor.name is manadtory - Maximum length is 140 - For IN IMPS creditor.name is mandatory - Maximum length is 50 - For UK FPS Instant payment creditor.name field is mandatory - Maximum length is 40 - For IN UPI creditor.name is mandatory - Maximum length is 99 - For US Wire, creditor.name is a mandatory field with max length 35 - For US ACH CCD/PPD payment, creditor.name is a mandatory field with max length is 22 - For US ACH IAT payment, creditor.name is a mandatory field with max length is 35 - 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 . , () - - For SEPA, creditor.name is mandatory and allowed max length is 70 title: name address_lines: type: array description: |- Creditor's address_lines - For TH Instant payment creditor.address_lines is not applicable - For US Instant payment creditor.address_lines is optional - For IN IMPS creditor.address_lines field is optional and allowed seven instance with each line max length of 70 - For UK FPS Instant payment creditor.address_lines field is optional and allowed only four instance with each line max length of 35 - For IN UPI creditor.address_lines field is optional and allowed seven instance with each line max length of 70 - 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 - 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 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\ - For Japan Instant payment creditor.address_lines field is not applicable - 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 - For TH Instant payment creditor.street_name is not applicable - For US Instant payment creditor.street_name is optional - For IN IMPS creditor.street_name is optional - For UK FPS Instant payment creditor.street_name field is not applicable - For IN UPI creditor.street_name is optional - 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. - 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 - For Japan Instant payment creditor.street_name field is not applicable - 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 - For TH Instant payment creditor.building_number is not applicable - For US Instant payment creditor.building_number field is optional - For IN IMPS creditor.building_number field is optional - For UK FPS Instant payment creditor.building_number field is not applicable - For IN UPI creditor.building_number field is optional - 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. - 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 - For Japan Instant payment creditor.building_number field is not applicable - 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 - For TH Instant payment creditor.postal_code is not applicable - For US Instant payment creditor.postal_code field is optional - For IN IMPS creditor.postal_code field is optional - For UK FPS Instant payment creditor.postal_code field is not applicable - For IN UPI creditor.postal_code field is optional - 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. - 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 - For Japan Instant payment creditor.postal_code field is not applicable - 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 - For TH Instant payment creditor.city is not applicable - For US Instant payment creditor.city field is optional - For IN IMPS creditor.city field is optional - For UK FPS Instant payment creditor.city field is not applicable - For IN UPI creditor.city field is optionaloptional - 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. - 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 - For Japan Instant payment creditor.city field is not applicable - 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 - For TH Instant payment creditor.state is not applicable - For US Instant payment creditor.state field is optional - For IN IMPS creditor.state field is optional - For UK FPS Instant payment creditor.state is not applicable - For IN UPI creditor.state field is optional - 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. - 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 - For Japan Instant payment creditor.state field is not applicable - For SEPA, creditor.state is optional and allowed max length is 35 title: state country: type: string description: |- Creditor's country - For TH Instant payment creditor.country is not applicable - For US Instant payment creditor.country field is optional - For IN IMPS creditor.country field is optional - For UK FPS Instant payment creditor.country field is mandatory, if creditor.address_line is provided by client - For IN UPI creditor.country field is optional - For US Wire, creditor.country field is mandatory with max length 2 - 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 - For Japan Instant payment creditor.country field is not applicable - 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 - For TH Instant payment creditor.org_id is not applicable - 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 - For IN IMPS creditor.org_id is not applicable - For UK FPS Instant payment creditor.org_id field is not applicable - For IN UPI creditor.org_id is not applicable - For US Wire, creditor.org_id is not applicable - For US ACH CCD/PPD/IAT payment, creditor.org_id is not applicable - For Japan Instant payment creditor.org_id field is not applicable - 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 - For TH Instant payment creditor.prvt_id field is not applicable - 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. - For IN IMPS creditor.prvt_id field is not applicable - For UK FPS Instant payment creditor.prvt_id field is optional, Additional identification of Beneficiary Customer’s account with the receiving organisation. - For IN UPI creditor.prvt_id field is not applicable - For US Wire, creditor.prvt_id is not applicable - For US ACH CCD/PPD/IAT payment, creditor.prvt_id is not applicable - For Japan Instant payment creditor.prvt_id field is not applicable - 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 - For TH Instant payment creditor.birth_date is not applicable - For US Instant payment creditor.birth_date field is optional - For IN IMPS creditor.birth_date is not applicable - For UK FPS Instant payment creditor.birth_date field is optional - For IN UPI creditor.birth_date is not applicable - For US Wire, creditor.birth_date field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.birth_date is not applicable - For Japan Instant payment creditor.birth_date field is not applicable - 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 - For TH Instant payment creditor.birth_city is not applicable - For US Instant payment creditor.birth_city field is optional - For IN IMPS creditor.birth_city is not applicable - For UK FPS Instant payment creditor.birth_city is not applicable - For IN UPI creditor.birth_city is not applicable - For US Wire, creditor.birth_city field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.birth_city is not applicable - For Japan Instant payment creditor.birth_city field is not applicable - 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 - For TH Instant payment creditor.birth_country is not applicable - For US Instant payment creditor.birth_country field is optional - For IN IMPS creditor.birth_country is not applicable - For UK FPS Instant payment creditor.birth_country is not applicable - For IN UPI creditor.birth_country is not applicable - For US Wire, creditor.birth_country field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.birth_country is not applicable - For Japan Instant payment creditor.birth_country field is not applicable - 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 - For TH Instant payment creditor.birth_province is not applicable - For US Instant payment creditor.birth_province is not applicable - For IN IMPS creditor.birth_province is not applicable - For UK FPS Instant payment creditor.birth_province is not applicable - For IN UPI creditor.birth_province is not applicable - For US Wire, creditor.birth_province is not applicable - For US ACH CCD/PPD payment, creditor.birth_province is not applicable - For US ACH IAT payment, creditor.birth_province is not applicable - For US ACH IAT payment, creditor.birth_province is not applicable - For SEPA, creditor.birth_province is optional with max length 35 - 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) - For TH Instant payment creditor.bank_id field is optional and allowed maxlength is 3 - For US Instant payment creditor.bank_id field is mandatory - For IN IMPS Instant payment creditor.bank_id field is mandatory and client should pass IFSC code (including branch code) - 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 - For IN UPI Instant payment creditor.bank_id field is mandatory with max length 11, if creditor.proxy_id is not provided by client - 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 - For US ACH CCD/PPD payment, creditor.bank_id is mandatory field with max length is 9 - For US ACH IAT payment, creditor.bank_id is mandatory field with max length is 34 - For Japan Instant payment creditor.bank_id field is mandatory and allowed max length is 7 - 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 - For Thailand PromptPay creditor.bank_name field is not applicable - For United States creditor.bank_name field is not applicble - For IN IMPS creditor.bank_name field is not applicable - For UK FPS Instant payment creditor.bank_name field is not applicable - For IN UPI creditor.bank_name field is not applicable - For US Wire, creditor.bank_name is optional field with max length 35 - For US ACH CCD/PPD/IAT payment, creditor.bank_name field is optional and allowed maxlength is 35 characters. - For Japan Instant payment creditor.bank_name field is not applicable - For SEPA, creditor.bank_name field is not applicable title: name bank_address_lines: type: array description: >- Creditor's bank address_lines - For Thailand PromptPay creditor.bank_address_lines field is not applicable - For United States creditor.bank_address_lines field is not applicble - For IN IMPS creditor.bank_address_lines field is not applicable - For UK FPS Instant payment creditor.bank_address_lines field is not applicable - For IN UPI creditor.bank_address_lines field is not applicable - For US Wire payment, creditor.bank_address_lines field is optional and upto 3 lines of min 1 and max 35 characters are allowed. - For US ACH CCD/PPD/IAT payment, creditor.bank_address_lines is not applicable - For Japan Instant payment creditor.bank_address_lines field is not applicable - 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 - For TH Instant payment creditor.account_type field is not applicable - For US Instant payment creditor.account_type field is not applicable - For IN IMPS creditor.account_type field is mandatory and possible values are 01,02,04 - For UK FPS Instant payment creditor.account_type field is not applicable - For IN UPI creditor.account_type field is mandatory and possible values are 01 for Current,02 for Savings,04 for Cash Credit - For US Wire, creditor.account_type is an optional field and possible values are CACC for Current and SVGS for Savings - For US ACH CCD/PPD/IAT payment, creditor.account_type field is mandatory and possible values are CACC for Current and SVGS for Savings - For JP Instant payment creditor.account_type field is mandatory and allowed values are FU, TO, CHI and SO - 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 - For Thailand PromptPay creditor.account_name field is not applicable - For United States creditor.account_name field is not applicble - For IN IMPS creditor.account_name field is not applicable - For UK FPS Instant payment creditor.account_name field is not applicable - For IN UPI creditor.account_name field is not applicable - For US Wire, creditor.account_name is an optional field with max length 35.Provide only if it is different than Beneficiary name - For US ACH CCD/PPD/IAT payment, creditor.account_name is not applicable - For Japan Instant payment creditor.account_name field is not applicable - 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 - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments creditor.scheme_name is not applicable - 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 - For Thailand PromptPay creditor.bank_instructions field is not applicable - For United States creditor.bank_instructions field is not applicble - For IN IMPS creditor.bank_instructions field is not applicable - For UK FPS Instant payment creditor.bank_instructions field is not applicable - For IN UPI creditor.bank_instructions field is not applicable - 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. - For US ACH CCD/PPD/IAT payment, creditor.bank_instructions is not applicable - For Japan Instant payment creditor.bank_instructions field is not applicable - 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 - For TH Instant payment creditor.name_conversion_flag field is not applicable - For US Instant payment creditor.name_conversion_flag field is not applicable - For IN IMPS creditor.name_conversion_flag field is not applicable - For UK FPS Instant payment creditor.name_conversion_flag field is not applicable - For IN UPI creditor.name_conversion_flag field is not applicable - For US Wire, creditor.name_conversion_flag field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.name_conversion_flag is not applicable - For Japan Instant payment creditor.name_conversion_flag field is optional - 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 - For TH Instant payment creditor.department is not applicable - For US Instant payment creditor.department is not applicable - For IN IMPS creditor.department is not applicable - For UK FPS Instant payment creditor.department is not applicable - For IN UPI creditor.department is not applicable - For US Wire, creditor.department is not applicable - For US ACH CCD/PPD payment, creditor.department is not applicable - For US ACH IAT payment, creditor.department is not applicable - For US ACH IAT payment, creditor.department is not applicable - For SEPA IDP, creditor.department is optional with max length 70 - For Japan Instant payment creditor.department field is not applicable - 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 - For TH Instant payment creditor.sub_department is not applicable - For US Instant payment creditor.sub_department is not applicable - For IN IMPS creditor.sub_department is not applicable - For UK FPS Instant payment creditor.sub_department is not applicable - For IN UPI creditor.sub_department is not applicable - For US Wire, creditor.sub_department is not applicable - For US ACH CCD/PPD payment, creditor.sub_department is not applicable - For US ACH IAT payment, creditor.sub_department is not applicable - For US ACH IAT payment, creditor.sub_department is not applicable - For SEPA IDP, creditor.sub_department is optional with max length 70 - For Japan Instant payment creditor.sub_department field is not applicable - 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 - For TH Instant payment creditor.building_name is not applicable - For US Instant payment creditor.building_name is not applicable - For IN IMPS creditor.building_name is not applicable - For UK FPS Instant payment creditor.building_name is not applicable - For IN UPI creditor.building_name is not applicable - For US Wire, creditor.building_name is not applicable - For US ACH CCD/PPD payment, creditor.building_name is not applicable - For US ACH IAT payment, creditor.building_name is not applicable - For US ACH IAT payment, creditor.building_name is not applicable - For SEPA IDP, creditor.building_name is optional with max length 35 - For Japan Instant payment creditor.building_name field is not applicable - 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 - For TH Instant payment creditor.floor is not applicable - For US Instant payment creditor.floor is not applicable - For IN IMPS creditor.floor is not applicable - For UK FPS Instant payment creditor.floor is not applicable - For IN UPI creditor.floor is not applicable - For US Wire, creditor.floor is not applicable - For US ACH CCD/PPD payment, creditor.floor is not applicable - For US ACH IAT payment, creditor.floor is not applicable - For US ACH IAT payment, creditor.floor is not applicable - For SEPA IDP, creditor.floor is optional with max length 70 - For Japan Instant payment creditor.floor field is not applicable - 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 - For TH Instant payment creditor.post_box is not applicable - For US Instant payment creditor.post_box is not applicable - For IN IMPS creditor.post_box is not applicable - For UK FPS Instant payment creditor.post_box is not applicable - For IN UPI creditor.post_box is not applicable - For US Wire, creditor.post_box is not applicable - For US ACH CCD/PPD payment, creditor.post_box is not applicable - For US ACH IAT payment, creditor.post_box is not applicable - For US ACH IAT payment, creditor.post_box is not applicable - For SEPA IDP, creditor.post_box is optional with max length 16 - For Japan Instant payment creditor.post_box field is not applicable - 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 - For TH Instant payment creditor.room is not applicable - For US Instant payment creditor.room is not applicable - For IN IMPS creditor.room is not applicable - For UK FPS Instant payment creditor.room is not applicable - For IN UPI creditor.room is not applicable - For US Wire, creditor.room is not applicable - For US ACH CCD/PPD payment, creditor.room is not applicable - For US ACH IAT payment, creditor.room is not applicable - For US ACH IAT payment, creditor.room is not applicable - For SEPA IDP, creditor.room is optional with max length 70 - For Japan Instant payment creditor.room field is not applicable - 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 - For TH Instant payment creditor.town_location_name is not applicable - For US Instant payment creditor.town_location_name is not applicable - For IN IMPS creditor.town_location_name is not applicable - For UK FPS Instant payment creditor.town_location_name is not applicable - For IN UPI creditor.town_location_name is not applicable - For US Wire, creditor.town_location_name is not applicable - For US ACH CCD/PPD payment, creditor.town_location_name is not applicable - For US ACH IAT payment, creditor.town_location_name is not applicable - For US ACH IAT payment, creditor.town_location_name is not applicable - For SEPA IDP, creditor.town_location_name is optional with max length 35 - For Japan Instant payment creditor.town_location_name field is not applicable - 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 - For TH Instant payment creditor.district_name is not applicable - For US Instant payment creditor.district_name is not applicable - For IN IMPS creditor.district_name is not applicable - For UK FPS Instant payment creditor.district_name is not applicable - For IN UPI creditor.district_name is not applicable - For US Wire, creditor.district_name is not applicable - For US ACH CCD/PPD payment, creditor.district_name is not applicable - For US ACH IAT payment, creditor.district_name is not applicable - For US ACH IAT payment, creditor.district_name is not applicable - For SEPA IDP, creditor.district_name is optional with max length 35 - For Japan Instant payment creditor.district_name field is not applicable - For SEPA, creditor.district_name is optional with max length 35 title: district_name anybic: maxLength: 35 minLength: 1 type: string description: |- creditor BIC - For TH Instant payment creditor.anybic is not applicable - For US Instant payment creditor.anybic is not applicable - For IN IMPS creditor.anybic is not applicable - For UK FPS Instant payment creditor.anybic is not applicable - For IN UPI creditor.anybic is not applicable - For US Wire, creditor.anybic is not applicable - For US ACH CCD/PPD payment, creditor.anybic is not applicable - For US ACH IAT payment, creditor.anybic is not applicable - For US ACH IAT payment, creditor.anybic is not applicable - For SEPA IDP, creditor.anybic is optional with max length 11 - For Japan Instant payment creditor.anybic field is not applicable - 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 - For TH Instant payment creditor.lei is not applicable - For US Instant payment creditor.lei is not applicable - For IN IMPS creditor.lei is not applicable - For UK FPS Instant payment creditor.lei is not applicable - For IN UPI creditor.lei is not applicable - For US Wire, creditor.lei is not applicable - For US ACH CCD/PPD payment, creditor.lei is not applicable - For US ACH IAT payment, creditor.lei is not applicable - For US ACH IAT payment, creditor.lei is not applicable - For SEPA IDP, creditor.lei is optional with max length 20 - For Japan Instant payment creditor.lei field is not applicable - 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 - For TH Instant payment creditor.issuer is not applicable - For US Instant payment creditor.issuer is not applicable - For IN IMPS creditor.issuer is not applicable - For UK FPS Instant payment creditor.issuer is not applicable - For IN UPI creditor.issuer is not applicable - For US Wire, creditor.issuer is not applicable - For US ACH CCD/PPD payment, creditor.issuer is not applicable - For US ACH IAT payment, creditor.issuer is not applicable - For US ACH IAT payment, creditor.issuer is not applicable - For SEPA IDP, creditor.issuer is optional with max length 35 - For Japan Instant payment creditor.issuer field is not applicable - 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 - 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 - 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 - For US,UK FPS,IN UPI ,US Wire,US ACH CCD/PPD/IAT payment, Japan, SEPA, this field is not applicable - 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 Creditor-Status: type: object title: CreditorStatus properties: proxy_id: maxLength: 255 minLength: 1 type: string description: >- Creditor's proxy identification (e.g., email address) - Thailand PromptPay - If you don't provide account, proxy_id is required. - For US Instant payment creditor.proxy_id field is not applicable - For IN IMPS creditor.proxy_id field is not applicable - For UK FPS Instant payment creditor.proxy_id field is not applicable - 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 - For US Wire, creditor.proxy_id field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.proxy_id is not applicable - For SEPA, creditor.proxy_id is optional - 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 - For SEPA, creditor.payer_id is optional and maxLength is 40 - Thailand PromptPay creditor.payer_id field is not applicable - For US Instant payment creditor.payer_id field is not applicable - For IN IMPS creditor.payer_id field is not applicable - For UK FPS Instant payment creditor.payer_id field is not applicable - For IN UPI Instant payment creditor.payer_id is not applicable - For US Wire, creditor.payer_id field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.payer_id is not applicable - 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) - 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. - For US Instant payment creditor.proxy_type field is not applicable - For IN IMPS creditor.proxy_type field is not applicable - For UK FPS Instant payment creditor.proxy_type field is not applicable - For IN UPI creditor.proxy_type field is not applicable - For US Wire, creditor.proxy_type field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.proxy_type is not applicable - For SEPA IDP, creditor.proxy_type is optional - For Japan Instant payment creditor.proxy_type field is not applicable - For SEPA, creditor.proxy_type is optional title: proxy_type tax_id: maxLength: 128 minLength: 1 type: string description: |- Creditor's tax identification - For TH Instant payment creditor.tax_id field is optional - For US Instant payment creditor.tax_id field is not applicable - For IN IMPS creditor.tax_id field is not applicable - For UK FPS Instant payment creditor.tax_id field is not applicable - For JP Instant payment creditor.tax_id field is not applicable - For IN UPI creditor.tax_id field is not applicable - For US Wire, creditor.tax_id is not appliable - For US ACH CCD/PPD/IAT payment, creditor.tax_id is not applicable - For SEPA IDP, this field is not applicable - For SEPA, this field is not applicable title: tax_id account: maxLength: 40 minLength: 1 type: string description: >- Creditor's bank account - Thailand PromptPay - If you don't provide proxy_id, account and bank_id is required - For US Instant payment creditor.account field is mandatory - For IN IMPS creditor.account field is mandatory with max length 34 - 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 - For IN UPI creditor.account field is mandatory with max length 34, if creditor.proxy_id is not provided by client - For US Wire, creditor.account is a mandatory field with max length is 34 and allowed value is Virtual account number. - 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. - For SEPA IDP creditor.account field is mandatory with max length 34 - For Japan Instant payment creditor.proxy_type field is mandatory and allowed max length is 7 - 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) - For TH Instant payment creditor.virtual_account field is optional - For US Instant payment creditor.virtual_account field is not applicable - For IN IMPS creditor.virtual_account field is not applicable - For UK FPS Instant payment creditor.virtual_account field is not applicable - For JP Instant payment creditor.virtual_account field is applicable - For IN UPI creditor.virtual_account field is not applicable - For US Wire, creditor.virtual_account is not applicable - For US ACH CCD/PPD/IAT payment, creditor.virtual_account is not applicable - For SEPA IDP, this field is not applicable - For SEPA, this field is not applicable title: virtual_account name: maxLength: 140 minLength: 1 type: string description: >- Creditor's name - Thailand PromptPay - Maximum length is 50. - For US Instant payment creditor.name is manadtory - Maximum length is 140 - For IN IMPS creditor.name is mandatory - Maximum length is 50 - For UK FPS Instant payment creditor.name field is mandatory - Maximum length is 40 - For IN UPI creditor.name is mandatory - Maximum length is 99 - For-US Wire, creditor.name is a mandatory field with max length 35 - For US ACH CCD/PPD payment, creditor.name is a mandatory field with max length is 22 - For US ACH IAT payment, creditor.name is a mandatory field with max length is 35 - For SEPA IDP creditor.name is mandatory with max length 70 - For Japan Instant payment creditor.name field is mandatory - For SEPA, creditor.name is mandatory with max length 70 title: name address_lines: type: array description: |- Creditor's address_lines - For TH Instant payment creditor.address_lines is not applicable - For US Instant payment creditor.address_lines is optional - For IN IMPS creditor.address_lines field is optional and allowed seven instance with each line max length of 70 - For UK FPS Instant payment creditor.address_lines field is optional and allowed only four instance with each line max length of 35 - For IN UPI creditor.address_lines field is optional and allowed seven instance with each line max length of 70 - 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 - 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 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\ - For SEPA IDP creditor.address_lines is optional - For Japan Instant payment creditor.address_lines field is not applicable - 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 - For TH Instant payment creditor.street_name is not applicable - For US Instant payment creditor.street_name is optional - For IN IMPS creditor.street_name is optional - For UK FPS Instant payment creditor.street_name field is not applicable - For IN UPI creditor.street_name is optional - 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. - 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 - For SEPA IDP, creditor.street_name is optional with max length 70 - For Japan Instant payment creditor.street_name field is not applicable - 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 - For TH Instant payment creditor.building_number is not applicable - For US Instant payment creditor.building_number field is optional - For IN IMPS creditor.building_number field is optional - For UK FPS Instant payment creditor.building_number field is not applicable - For IN UPI creditor.building_number field is optional - 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. - 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 - For SEPA IDP, creditor.building_number is optional with max length 16 - For Japan Instant payment creditor.building_number field is not applicable - For SEPA IDP, creditor.building_number is optional with max length 16 - 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 - For TH Instant payment creditor.postal_code is not applicable - For US Instant payment creditor.postal_code field is optional - For IN IMPS creditor.postal_code field is optional - For UK FPS Instant payment creditor.postal_code field is not applicable - For IN UPI creditor.postal_code field is optional - 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. - 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 - For SEPA IDP, creditor.postal_code is optional with max length 16 - For Japan Instant payment creditor.postal_code field is not applicable - 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 - For TH Instant payment creditor.city is not applicable - For US Instant payment creditor.city field is optional - For IN IMPS creditor.city field is optional - For UK FPS Instant payment creditor.city field is not applicable - For IN UPI creditor.city field is optionaloptional - 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. - 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 - For SEPA IDP creditor.city field is optional - For Japan Instant payment creditor.city field is not applicable - For SEPA, creditor.city field is optional and maxLength is 35 title: city state: maxLength: 35 minLength: 1 type: string description: |- Creditor's state - For TH Instant payment creditor.state is not applicable - For US Instant payment creditor.state field is optional - For IN IMPS creditor.state field is optional - For UK FPS Instant payment creditor.state is not applicable - For IN UPI creditor.state field is optional - 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. - 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 - For SEPA IDP creditor.state field is optional with max length 35 - For Japan Instant payment creditor.state field is not applicable - For SEPA, creditor.state field is optional with max length 35 title: state country: type: string description: |- Creditor's country - For TH Instant payment creditor.country is not applicable - For US Instant payment creditor.country field is optional - For IN IMPS creditor.country field is optional - For UK FPS Instant payment creditor.country field is mandatory, if creditor.address_line is provided by client - For IN UPI creditor.country field is optional - For US Wire, creditor.country field is mandatory with max length 2 - 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 - For SEPA IDP creditor.country field is optional - For Japan Instant payment creditor.country field is not applicable - 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 - For TH Instant payment creditor.org_id is not applicable - 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 - For IN IMPS creditor.org_id is not applicable - For UK FPS Instant payment creditor.org_id field is not applicable - For IN UPI creditor.org_id is not applicable - For US Wire, creditor.org_id is not applicable - For US ACH CCD/PPD/IAT payment, creditor.org_id is not applicable - For SEPA IDP creditor.org_id field is optional with max length 35 - For Japan Instant payment creditor.org_id field is not applicable - 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 - For TH Instant payment creditor.prvt_id field is not applicable - 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 - For IN IMPS creditor.prvt_id field is not applicable - For UK FPS Instant payment creditor.prvt_id field is optional, Additional identification of Beneficiary Customer’s account with the receiving organisation. - For IN UPI creditor.prvt_id field is not applicable - For US Wire, creditor.prvt_id is not applicable - For US ACH CCD/PPD/IAT payment, creditor.prvt_id is not applicable - For SEPA IDP creditor.prvt_id field is optional with max length 35 - For Japan Instant payment creditor.prvt_id field is not applicable - 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 - For TH Instant payment creditor.birth_date is not applicable - For US Instant payment creditor.birth_date field is optional - For IN IMPS creditor.birth_date is not applicable - For UK FPS Instant payment creditor.birth_date field is optional - For IN UPI creditor.birth_date is not applicable - For US Wire, creditor.birth_date field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.birth_date is not applicable - For SEPA IDP creditor.birth_date field is optional - For Japan Instant payment creditor.birth_date field is not applicable - For SEPA, creditor.birth_date field is optional title: birth_date birth_city: maxLength: 35 minLength: 1 type: string description: |- Creditor's birth_city - For TH Instant payment creditor.birth_city is not applicable - For US Instant payment creditor.birth_city field is optional - For IN IMPS creditor.birth_city is not applicable - For UK FPS Instant payment creditor.birth_city is not applicable - For IN UPI creditor.birth_city is not applicable - For US Wire, creditor.birth_city field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.birth_city is not applicable - For SEPA IDP creditor.birth_city field is optional - For Japan Instant payment creditor.birth_city field is not applicable - For SEPA, creditor.birth_city field is optional title: birth_city birth_country: type: string description: |- Creditor's birth_country - For TH Instant payment creditor.birth_country is not applicable - For US Instant payment creditor.birth_country field is optional - For IN IMPS creditor.birth_country is not applicable - For UK FPS Instant payment creditor.birth_country is not applicable - For IN UPI creditor.birth_country is not applicable - For US Wire, creditor.birth_country field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.birth_country is not applicable - For SEPA IDP creditor.birth_country field is optional - For Japan Instant payment creditor.birth_country field is not applicable - 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) - For TH Instant payment creditor.bank_id field is optional and allowed maxlength is 3 - For US Instant payment creditor.bank_id field is mandatory - For IN IMPS Instant payment creditor.bank_id field is mandatory and client should pass IFSC code (including branch code) - 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 - For IN UPI Instant payment creditor.bank_id field is mandatory with max length 11, if creditor.proxy_id is not provided by client - 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 - For US ACH CCD/PPD payment, creditor.bank_id is mandatory field with max length is 9 - For US ACH IAT payment, creditor.bank_id is mandatory field with max length is 34 - For SEPA IDP creditor.bank_id field is mandatory with max length 11 - For Japan Instant payment creditor.bank_id field is mandatory and allowed max length is 7 - 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 - For Thailand PromptPay creditor.bank_name field is not applicable - For United States creditor.bank_name field is not applicble - For IN IMPS creditor.bank_name field is not applicable - For UK FPS Instant payment creditor.bank_name field is not applicable - For IN UPI creditor.bank_name field is not applicable - For US Wire, creditor.bank_name is optional field with max length 35 - For US ACH CCD/PPD/IAT payment, creditor.bank_name field is optional and allowed maxlength is 35 characters. - For SEPA IDP, this field is not applicable - For Japan Instant payment creditor.bank_name field is not applicable - For SEPA, this field is not applicable title: bank_name bank_address_lines: type: array description: >- Creditor's bank address_lines - For Thailand PromptPay creditor.bank_address_lines field is not applicable - For United States creditor.bank_address_lines field is not applicble - For IN IMPS creditor.bank_address_lines field is not applicable - For UK FPS Instant payment creditor.bank_address_lines field is not applicable - For IN UPI creditor.bank_address_lines field is not applicable - For US Wire payment, creditor.bank_address_lines field is optional and upto 3 lines of min 1 and max 35 characters are allowed. - For US ACH CCD/PPD/IAT payment, creditor.bank_address_lines is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment creditor.bank_address_lines field is not applicable - 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 - For TH Instant payment creditor.account_type field is not applicable - For US Instant payment creditor.account_type field is not applicable - For IN IMPS creditor.account_type field is not applicable - For UK FPS Instant payment creditor.account_type field is not applicable - For IN UPI creditor.account_type field is mandatory and possible values are 01 for Current,02 for Savings,04 for Cash Credit - For US Wire, creditor.account_type is an optional field and possible values are CACC for Current and SVGS for Savings - For US ACH CCD/PPD/IAT payment, creditor.account_type field is mandatory and possible values are CACC for Current and SVGS for Savings - For SEPA IDP, this field is not applicable - For JP Instant payment creditor.account_type field is not applicable - For SEPA, this field is not applicable title: account_type redirect_account: maxLength: 40 minLength: 1 type: string description: |- Redirected Beneficiary Account Number - For TH creditor.redirect_account field is not applicable - For US creditor.redirect_account field is not applicable - For IN IMPS creditor.redirect_account field is not applicable - For UK creditor.redirect_account field is optional and max Field length is 34 - For JP Instant payment creditor.redirect_account field is not applicable - For IN UPI creditor.redirect_account field is not applicable - For US Wire, creditor.redirect_account field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.redirect_account is not applicable - For SEPA IDP, this field is not applicable - For SEPA, this field is not applicable title: redirect_account redirect_bank_id: maxLength: 35 minLength: 1 type: string description: |- Redirected Beneficiary Sort Code - For TH creditor.redirect_bank_id field is not applicable - For US creditor.redirect_bank_id field is not applicable - For IN IMPS creditor.redirect_bank_id field is not applicable - For UK creditor.redirect_bank_id field is optional and max Field length is 6 - For UK FPS Instant payment creditor.redirect_bank_id field is not applicable - For IN UPI creditor.redirect_bank_id field is not applicable - For US Wire, creditor.redirect_bank_id field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.redirect_bank_id is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment creditor.redirect_bank_id field is not applicable - For SEPA, this field is not applicable title: redirect_bank_id account_name: maxLength: 140 minLength: 1 type: string description: >- Creditor account name - For Thailand PromptPay creditor.account_name field is not applicable - For United States creditor.account_name field is optional - For IN IMPS creditor.account_name field is not applicable - For UK FPS Instant payment creditor.account_name field is not applicable - For IN UPI creditor.account_name field is not applicable - For US Wire, creditor.account_name is an optional field with max length 35.Provide only if it is different than Beneficiary name - For US ACH CCD/PPD/IAT payment, creditor.account_name is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment creditor.account_name field is not applicable - For SEPA, this field is not applicable title: account_name bank_instructions: maxLength: 140 minLength: 1 type: string description: >- Instructions for creditor agent - For Thailand PromptPay creditor.bank_instructions field is not applicable - For United States creditor.bank_instructions field is not applicble - For IN IMPS creditor.bank_instructions field is not applicable - For UK FPS Instant payment creditor.bank_instructions field is not applicable - For IN UPI creditor.bank_instructions field is not applicable - 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 - For US ACH CCD/PPD/IAT payment, creditor.bank_instructions field is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment creditor.bank_instructions field is not applicable - For SEPA, this field is not applicable title: bank_instructions department: maxLength: 70 minLength: 1 type: string description: |- creditor Address Department - For TH Instant payment creditor.department is not applicable - For US Instant payment creditor.department is not applicable - For IN IMPS creditor.department is not applicable - For UK FPS Instant payment creditor.department is not applicable - For IN UPI creditor.department is not applicable - For US Wire, creditor.department is not applicable - For US ACH CCD/PPD payment, creditor.department is not applicable - For US ACH IAT payment, creditor.department is not applicable - For US ACH IAT payment, creditor.department is not applicable - For SEPA IDP, creditor.department is optional with max length 70 - For Japan Instant payment creditor.department field is not applicable - 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 - For TH Instant payment creditor.sub_department is not applicable - For US Instant payment creditor.sub_department is not applicable - For IN IMPS creditor.sub_department is not applicable - For UK FPS Instant payment creditor.sub_department is not applicable - For IN UPI creditor.sub_department is not applicable - For US Wire, creditor.sub_department is not applicable - For US ACH CCD/PPD payment, creditor.sub_department is not applicable - For US ACH IAT payment, creditor.sub_department is not applicable - For US ACH IAT payment, creditor.sub_department is not applicable - For SEPA IDP, creditor.sub_department is optional with max length 70 - For Japan Instant payment creditor.sub_department field is not applicable - 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 - For TH Instant payment creditor.building_name is not applicable - For US Instant payment creditor.building_name is not applicable - For IN IMPS creditor.building_name is not applicable - For UK FPS Instant payment creditor.building_name is not applicable - For IN UPI creditor.building_name is not applicable - For US Wire, creditor.building_name is not applicable - For US ACH CCD/PPD payment, creditor.building_name is not applicable - For US ACH IAT payment, creditor.building_name is not applicable - For US ACH IAT payment, creditor.building_name is not applicable - For SEPA IDP, creditor.building_name is optional with max length 35 - For Japan Instant payment creditor.building_name field is not applicable - 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 - For TH Instant payment creditor.floor is not applicable - For US Instant payment creditor.floor is not applicable - For IN IMPS creditor.floor is not applicable - For UK FPS Instant payment creditor.floor is not applicable - For IN UPI creditor.floor is not applicable - For US Wire, creditor.floor is not applicable - For US ACH CCD/PPD payment, creditor.floor is not applicable - For US ACH IAT payment, creditor.floor is not applicable - For US ACH IAT payment, creditor.floor is not applicable - For SEPA IDP, creditor.floor is optional with max length 70 - For Japan Instant payment creditor.floor field is not applicable - 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 - For TH Instant payment creditor.post_box is not applicable - For US Instant payment creditor.post_box is not applicable - For IN IMPS creditor.post_box is not applicable - For UK FPS Instant payment creditor.post_box is not applicable - For IN UPI creditor.post_box is not applicable - For US Wire, creditor.post_box is not applicable - For US ACH CCD/PPD payment, creditor.post_box is not applicable - For US ACH IAT payment, creditor.post_box is not applicable - For US ACH IAT payment, creditor.post_box is not applicable - For SEPA IDP, creditor.post_box is optional with max length 16 - For Japan Instant payment creditor.post_box field is not applicable - 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 - For TH Instant payment creditor.room is not applicable - For US Instant payment creditor.room is not applicable - For IN IMPS creditor.room is not applicable - For UK FPS Instant payment creditor.room is not applicable - For IN UPI creditor.room is not applicable - For US Wire, creditor.room is not applicable - For US ACH CCD/PPD payment, creditor.room is not applicable - For US ACH IAT payment, creditor.room is not applicable - For US ACH IAT payment, creditor.room is not applicable - For SEPA IDP, creditor.room is optional with max length 70 - For Japan Instant payment creditor.room field is not applicable - 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 - For TH Instant payment creditor.town_location_name is not applicable - For US Instant payment creditor.town_location_name is not applicable - For IN IMPS creditor.town_location_name is not applicable - For UK FPS Instant payment creditor.town_location_name is not applicable - For IN UPI creditor.town_location_name is not applicable - For US Wire, creditor.town_location_name is not applicable - For US ACH CCD/PPD payment, creditor.town_location_name is not applicable - For US ACH IAT payment, creditor.town_location_name is not applicable - For US ACH IAT payment, creditor.town_location_name is not applicable - For SEPA IDP, creditor.town_location_name is optional with max length 35 - For Japan Instant payment creditor.town_location_name field is not applicable - 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 - For TH Instant payment creditor.district_name is not applicable - For US Instant payment creditor.district_name is not applicable - For IN IMPS creditor.district_name is not applicable - For UK FPS Instant payment creditor.district_name is not applicable - For IN UPI creditor.district_name is not applicable - For US Wire, creditor.district_name is not applicable - For US ACH CCD/PPD payment, creditor.district_name is not applicable - For US ACH IAT payment, creditor.district_name is not applicable - For US ACH IAT payment, creditor.district_name is not applicable - For SEPA IDP, creditor.district_name is optional with max length 35 - For Japan Instant payment creditor.district_name field is not applicable - For SEPA, creditor.district_name is optional with max length 35 title: district_name anybic: maxLength: 35 minLength: 1 type: string description: |- creditor BIC - For TH Instant payment creditor.anybic is not applicable - For US Instant payment creditor.anybic is not applicable - For IN IMPS creditor.anybic is not applicable - For UK FPS Instant payment creditor.anybic is not applicable - For IN UPI creditor.anybic is not applicable - For US Wire, creditor.anybic is not applicable - For US ACH CCD/PPD payment, creditor.anybic is not applicable - For US ACH IAT payment, creditor.anybic is not applicable - For US ACH IAT payment, creditor.anybic is not applicable - For SEPA IDP, creditor.anybic is optional with max length 11 - For Japan Instant payment creditor.anybic field is not applicable - 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 - For TH Instant payment creditor.lei is not applicable - For US Instant payment creditor.lei is not applicable - For IN IMPS creditor.lei is not applicable - For UK FPS Instant payment creditor.lei is not applicable - For IN UPI creditor.lei is not applicable - For US Wire, creditor.lei is not applicable - For US ACH CCD/PPD payment, creditor.lei is not applicable - For US ACH IAT payment, creditor.lei is not applicable - For US ACH IAT payment, creditor.lei is not applicable - For SEPA IDP, creditor.lei is optional with max length 20 - For Japan Instant payment creditor.lei field is not applicable - 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 - For TH Instant payment creditor.issuer is not applicable - For US Instant payment creditor.issuer is not applicable - For IN IMPS creditor.issuer is not applicable - For UK FPS Instant payment creditor.issuer is not applicable - For IN UPI creditor.issuer is not applicable - For US Wire, creditor.issuer is not applicable - For US ACH CCD/PPD payment, creditor.issuer is not applicable - For US ACH IAT payment, creditor.issuer is not applicable - For US ACH IAT payment, creditor.issuer is not applicable - For SEPA IDP, creditor.issuer is optional with max length 35 - For Japan Instant payment creditor.issuer field is not applicable - 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 - For TH Instant payment creditor.birth_province is not applicable - For US Instant payment creditor.birth_province is not applicable - For IN IMPS creditor.birth_province is not applicable - For UK FPS Instant payment creditor.birth_province is not applicable - For IN UPI creditor.birth_province is not applicable - For US Wire, creditor.birth_province is not applicable - For US ACH CCD/PPD payment, creditor.birth_province is not applicable - For US ACH IAT payment, creditor.birth_province is not applicable - For US ACH IAT payment, creditor.birth_province is not applicable - For SEPA IDP, creditor.birth_province is optional with max length 35 - For Japan Instant payment creditor.birth_province field is not applicable - 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 - For TH Instant payment creditor.bank_branch_id field is applicable - For US Instant payment creditor.bank_branch_id field is not applicable - For UK Instant payment creditor.bank_branch_id field is not applicable - For JP Instant payment creditor.bank_branch_id is not applicable - For IN IMPS Instant payment creditor.bank_branch_id field is not applicable - For IN UPI Instant payment creditor.bank_branch_id field is not applicable - For US Wire, creditor.bank_branch_id is not applicable - For Stripe_US ACH CCD/PPD/IAT payment, creditor.bank_branch_id is not applicable - For SEPA IDP, this field is not applicable - 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 - For TH Instant payment creditor.name_conversion_flag field is not applicable - For US Instant payment creditor.name_conversion_flag field is not applicable - For IN IMPS creditor.name_conversion_flag field is not applicable - For UK FPS Instant payment creditor.name_conversion_flag field is not applicable - For IN UPI creditor.name_conversion_flag field is not applicable - For US Wire, creditor.name_conversion_flag field is not applicable - For US ACH CCD/PPD/IAT payment, creditor.name_conversion_flag is not applicable - For Japan Instant payment creditor.name_conversion_flag field is optional - 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 - 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 - 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 - For US,UK FPS,IN UPI ,US Wire,US ACH CCD/PPD/IAT payment, Japan, SEPA, this field is not applicable - 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. - 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. 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 Ultimate-Creditor-Initiation: type: object title: UltimateCreditorInitiation properties: name: maxLength: 140 minLength: 1 type: string description: |- Ultimate Creditor's bank account name - For TH Instant payment ultimate_creditor.name is not applicable - For US Instant payment ultimate_creditor.name is optional - For IN IMPS ultimate_creditor.name is not applicable - For UK FPS Instant payment ultimate_creditor.name field is optional with max length 140 - For IN UPI ultimate_creditor.name is not applicable - US Wire, ultimate_creditor.name is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.name field is mandatory and allowed max length is 22 - For US ACH IAT payment, ultimate_creditor.name field is mandatory and allowed max length is 35 - For Japan Instant payment ultimate_creditor.name field is not applicable - 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 - For TH Instant payment ultimate_creditor.address_lines is not applicable - For US Instant payment ultimate_creditor.address_lines is optional - For IN IMPS ultimate_creditor.address_lines is not applicable - For UK FPS Instant payment ultimate_creditor.address_lines field is optional - For IN UPI ultimate_creditor.address_lines is not applicable - For US Wire, ultimate_creditor.address_lines is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.address_lines field is not applicable - 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 - For TH Instant payment ultimate_creditor.street_name is not applicable - For US Instant payment ultimate_creditor.street_name is optional - For IN IMPS ultimate_creditor.street_name is not applicable - For UK FPS Instant payment ultimate_creditor.street_name field is optional with max length 70 - For IN UPI ultimate_creditor.street_name is not applicable - For US Wire, ultimate_creditor.street_name is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.street_name field is not applicable - 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 - For TH Instant payment ultimate_creditor.building_number is not applicable - For US Instant payment ultimate_creditor.building_number field is optional - For IN IMPS ultimate_creditor.building_number is not applicable - For UK FPS Instant payment ultimate_creditor.building_number field is optional with max length 16 - For IN UPI ultimate_creditor.building_number is not applicable - For US Wire, ultimate_creditor.building_number is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.building_number field is not applicable - 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 - For TH Instant payment ultimate_creditor.postal_code is not applicable - For US Instant payment ultimate_creditor.postal_code field is optional - For IN IMPS ultimate_creditor.postal_code is not applicable - For UK FPS Instant payment ultimate_creditor.postal_code field is optional with max length 16 - For IN UPI ultimate_creditor.postal_code is not applicable - For US Wire, ultimate_creditor.postal_code is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.postal_code field is not applicable - 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 - For TH Instant payment ultimate_creditor.city is not applicable - For US Instant payment ultimate_creditor.city field is optional - For IN IMPS ultimate_creditor.city is not applicable - For UK FPS Instant payment ultimate_creditor.city field is optional with max length 35 - For IN UPI ultimate_creditor.city is not applicable - For US Wire, ultimate_creditor.city is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.city field is not applicable - 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 - For TH Instant payment ultimate_creditor.state is not applicable - For US Instant payment ultimate_creditor.state field is optional - For IN IMPS ultimate_creditor.state is not applicable - For UK FPS Instant payment ultimate_creditor.state field is optional with max length 35 - For IN UPI ultimate_creditor.state is not applicable - For US Wire, ultimate_creditor.state is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.state field is not applicable - For SEPA, Japan Instant payment ultimate_creditor.state field is not applicable title: state country: type: string description: |- Ultimate Creditor's country - For TH Instant payment ultimate_creditor.country is not applicable - For US Instant payment ultimate_creditor.country field is optional - For IN IMPS ultimate_creditor.country is not applicable - For UK FPS Instant payment ultimate_creditor.country field is optional - For IN UPI ultimate_creditor.country is not applicable - For US Wire, ultimate_creditor.country is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.country field is not applicable - 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 - For TH Instant payment ultimate_creditor.org_id is not applicable - 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 - For IN IMPS ultimate_creditor.org_id is not applicable - For UK FPS Instant payment ultimate_creditor.org_id field is optional with max length 35 - For IN UPI ultimate_creditor.org_id is not applicable - US Wire, ultimate_creditor.org_id is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.org_id field is not applicable - For Japan Instant payment ultimate_creditor.org_id field is not applicable - 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 - For TH Instant payment ultimate_creditor.prvt_id is not applicable - 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 - For IN IMPS ultimate_creditor.prvt_id is not applicable - For UK FPS Instant payment ultimate_creditor.prvt_id is not applicable - For IN UPI ultimate_creditor.prvt_id is not applicable - US Wire, ultimate_creditor.prvt_id is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.prvt_id field is not applicable - For Japan Instant payment ultimate_creditor.prvt_id field is not applicable - 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 - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.anybic is not applicable - 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 - For TH, US,IN IMPS,UK FPS,IN UPI,US Wire,US ACH CCD/PPD/IAT,Japan Payments ultimate_creditor.lei is not applicable - 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 - 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 - 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 - 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 - For SEPA, ultimate_creditor.issuer field is optional with max length as 35 title: issuer birth_date: type: string format: date description: |2- - 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 - 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: |2- - 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 - 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: |2- - 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 - 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: |2- - 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 - 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 - For TH Instant payment ultimate_creditor.department is not applicable - For US Instant payment ultimate_creditor.department is not applicable - For IN IMPS ultimate_creditor.department is not applicable - For UK FPS Instant payment ultimate_creditor.department is not applicable - For IN UPI ultimate_creditor.department is not applicable - For US Wire, ultimate_creditor.department is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.department is not applicable - For US ACH IAT payment, ultimate_creditor.department is not applicable - For US ACH IAT payment, ultimate_creditor.department is not applicable - For SEPA IDP, ultimate_creditor.department is optional with max length 70 - For Japan Instant payment ultimate_creditor.department field is not applicable - 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 - For TH Instant payment ultimate_creditor.sub_department is not applicable - For US Instant payment ultimate_creditor.sub_department is not applicable - For IN IMPS ultimate_creditor.sub_department is not applicable - For UK FPS Instant payment ultimate_creditor.sub_department is not applicable - For IN UPI ultimate_creditor.sub_department is not applicable - For US Wire, ultimate_creditor.sub_department is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.sub_department is not applicable - For US ACH IAT payment, ultimate_creditor.sub_department is not applicable - For US ACH IAT payment, ultimate_creditor.sub_department is not applicable - For SEPA IDP, ultimate_creditor.sub_department is optional with max length 70 - For Japan Instant payment ultimate_creditor.sub_department field is not applicable - 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 - For TH Instant payment ultimate_creditor.building_name is not applicable - For US Instant payment ultimate_creditor.building_name is not applicable - For IN IMPS ultimate_creditor.building_name is not applicable - For UK FPS Instant payment ultimate_creditor.building_name is not applicable - For IN UPI ultimate_creditor.building_name is not applicable - For US Wire, ultimate_creditor.building_name is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.building_name is not applicable - For US ACH IAT payment, ultimate_creditor.building_name is not applicable - For US ACH IAT payment, ultimate_creditor.building_name is not applicable - For SEPA IDP, ultimate_creditor.building_name is optional with max length 35 - For Japan Instant payment ultimate_creditor.building_name field is not applicable - 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 - For TH Instant payment ultimate_creditor.floor is not applicable - For US Instant payment ultimate_creditor.floor is not applicable - For IN IMPS ultimate_creditor.floor is not applicable - For UK FPS Instant payment ultimate_creditor.floor is not applicable - For IN UPI ultimate_creditor.floor is not applicable - For US Wire, ultimate_creditor.floor is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.floor is not applicable - For US ACH IAT payment, ultimate_creditor.floor is not applicable - For US ACH IAT payment, ultimate_creditor.floor is not applicable - For SEPA IDP, ultimate_creditor.floor is optional with max length 70 - For Japan Instant payment ultimate_creditor.floor field is not applicable - 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 - For TH Instant payment ultimate_creditor.post_box is not applicable - For US Instant payment ultimate_creditor.post_box is not applicable - For IN IMPS ultimate_creditor.post_box is not applicable - For UK FPS Instant payment ultimate_creditor.post_box is not applicable - For IN UPI ultimate_creditor.post_box is not applicable - For US Wire, ultimate_creditor.post_box is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.post_box is not applicable - For US ACH IAT payment, ultimate_creditor.post_box is not applicable - For US ACH IAT payment, ultimate_creditor.post_box is not applicable - For SEPA IDP, ultimate_creditor.post_box is optional with max length 16 - For Japan Instant payment ultimate_creditor.post_box field is not applicable - 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 - For TH Instant payment ultimate_creditor.room is not applicable - For US Instant payment ultimate_creditor.room is not applicable - For IN IMPS ultimate_creditor.room is not applicable - For UK FPS Instant payment ultimate_creditor.room is not applicable - For IN UPI ultimate_creditor.room is not applicable - For US Wire, ultimate_creditor.room is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.room is not applicable - For US ACH IAT payment, ultimate_creditor.room is not applicable - For US ACH IAT payment, ultimate_creditor.room is not applicable - For SEPA IDP, ultimate_creditor.room is optional with max length 70 - For Japan Instant payment ultimate_creditor.room field is not applicable - 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 - For TH Instant payment ultimate_creditor.town_location_name is not applicable - For US Instant payment ultimate_creditor.town_location_name is not applicable - For IN IMPS ultimate_creditor.town_location_name is not applicable - For UK FPS Instant payment ultimate_creditor.town_location_name is not applicable - For IN UPI ultimate_creditor.town_location_name is not applicable - For US Wire, ultimate_creditor.town_location_name is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.town_location_name is not applicable - For US ACH IAT payment, ultimate_creditor.town_location_name is not applicable - For US ACH IAT payment, ultimate_creditor.town_location_name is not applicable - For SEPA IDP, ultimate_creditor.town_location_name is optional with max length 35 - For Japan Instant payment ultimate_creditor.town_location_name field is not applicable - 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 - For TH Instant payment ultimate_creditor.district_name is not applicable - For US Instant payment ultimate_creditor.district_name is not applicable - For IN IMPS ultimate_creditor.district_name is not applicable - For UK FPS Instant payment ultimate_creditor.district_name is not applicable - For IN UPI ultimate_creditor.district_name is not applicable - For US Wire, ultimate_creditor.district_name is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.district_name is not applicable - For US ACH IAT payment, ultimate_creditor.district_name is not applicable - For US ACH IAT payment, ultimate_creditor.district_name is not applicable - For SEPA IDP, ultimate_creditor.district_name is optional with max length 35 - For Japan Instant payment ultimate_creditor.district_name field is not applicable - For SEPA, ultimate_creditor.district_name is optional with max length 35 title: district_name additionalProperties: false description: Ultimate Creditor information Ultimate-Creditor-Status: type: object title: UltimateCreditorStatus properties: name: maxLength: 140 minLength: 1 type: string description: |- Ultimate Creditor's bank account name - For TH Instant payment ultimate_creditor.name is not applicable - For US Instant payment ultimate_creditor.name is optional - For IN IMPS ultimate_creditor.name is not applicable - For UK FPS Instant payment ultimate_creditor.name field is optional with max length 140 - For IN UPI ultimate_creditor.name is not applicable - US Wire, ultimate_creditor.name is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.name field is mandatory and allowed max length is 22 - For US ACH IAT payment, ultimate_creditor.name field is mandatory and allowed max length is 35 - For SEPA IDP ultimate_creditor.name is optional - For Japan Instant payment ultimate_creditor.name field is not applicable - For SEPA, ultimate_creditor.name is optional and maxLength is 70 title: name address_lines: type: array description: |- Ultimate Creditor's address_lines - For TH Instant payment ultimate_creditor.address_lines is not applicable - For US Instant payment ultimate_creditor.address_lines is optional - For IN IMPS ultimate_creditor.address_lines is not applicable - For UK FPS Instant payment ultimate_creditor.address_lines field is optional - For IN UPI ultimate_creditor.address_lines is not applicable - For US Wire, ultimate_creditor.address_lines is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.address_lines field is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment ultimate_creditor.address_lines field is not applicable - 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 - For TH Instant payment ultimate_creditor.street_name is not applicable - For US Instant payment ultimate_creditor.street_name is optional - For IN IMPS ultimate_creditor.street_name is not applicable - For UK FPS Instant payment ultimate_creditor.street_name field is optional with max length 70 - For IN UPI ultimate_creditor.street_name is not applicable - For US Wire, ultimate_creditor.street_name is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.street_name field is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment ultimate_creditor.street_name field is not applicable - For SEPA, this field is not applicable title: street_name building_number: maxLength: 16 minLength: 1 type: string description: |- Ultimate Creditor's building_number - For TH Instant payment ultimate_creditor.building_number is not applicable - For US Instant payment ultimate_creditor.building_number field is optional - For IN IMPS ultimate_creditor.building_number is not applicable - For UK FPS Instant payment ultimate_creditor.building_number field is optional with max length 16 - For IN UPI ultimate_creditor.building_number is not applicable - For US Wire, ultimate_creditor.building_number is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.building_number field is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment ultimate_creditor.building_number field is not applicable - For SEPA, this field is not applicable title: building_number postal_code: maxLength: 16 minLength: 1 type: string description: |- Ultimate Creditor's postal_code - For TH Instant payment ultimate_creditor.postal_code is not applicable - For US Instant payment ultimate_creditor.postal_code field is optional - For IN IMPS ultimate_creditor.postal_code is not applicable - For UK FPS Instant payment ultimate_creditor.postal_code field is optional with max length 16 - For IN UPI ultimate_creditor.postal_code is not applicable - For US Wire, ultimate_creditor.postal_code is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.postal_code field is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment ultimate_creditor.postal_code field is not applicable - For SEPA, this field is not applicable title: postal_code city: maxLength: 35 minLength: 1 type: string description: |- Ultimate Creditor's city - For TH Instant payment ultimate_creditor.city is not applicable - For US Instant payment ultimate_creditor.city field is optional - For IN IMPS ultimate_creditor.city is not applicable - For UK FPS Instant payment ultimate_creditor.city field is optional with max length 35 - For IN UPI ultimate_creditor.city is not applicable - For US Wire, ultimate_creditor.city is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.city field is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment ultimate_creditor.city field is not applicable - For SEPA, this field is not applicable title: city state: maxLength: 35 minLength: 1 type: string description: |- Ultimate Creditor's state - For TH Instant payment ultimate_creditor.state is not applicable - For US Instant payment ultimate_creditor.state field is optional - For IN IMPS ultimate_creditor.state is not applicable - For UK FPS Instant payment ultimate_creditor.state field is optional with max length 35 - For IN UPI ultimate_creditor.state is not applicable - For US Wire, ultimate_creditor.state is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.state field is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment ultimate_creditor.state field is not applicable - For SEPA, this field is not applicable title: state country: type: string description: |- Ultimate Creditor's country - For TH Instant payment ultimate_creditor.country is not applicable - For US Instant payment ultimate_creditor.country field is optional - For IN IMPS ultimate_creditor.country is not applicable - For UK FPS Instant payment ultimate_creditor.country field is optional - For IN UPI ultimate_creditor.country is not applicable - For US Wire, ultimate_creditor.country is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.country field is not applicable - For SEPA IDP, this field is not applicable - For Japan Instant payment ultimate_creditor.country field is not applicable - For SEPA, this field is not applicable pattern: ^[A-Z]{2,2}$ title: country org_id: maxLength: 35 minLength: 1 type: string description: |2- Ultimate Creditor's org_id - For TH Instant payment ultimate_creditor.org_id is not applicable - 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 - For IN IMPS ultimate_creditor.org_id is not applicable - For UK FPS Instant payment ultimate_creditor.org_id field is optional with max length 35 - For IN UPI ultimate_creditor.org_id is not applicable - US Wire, ultimate_creditor.org_id is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.org_id field is not applicable - For SEPA IDP ultimate_creditor.org_id field is optional with max length 35 - For Japan Instant payment ultimate_creditor.org_id field is not applicable - 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 - For TH Instant payment ultimate_creditor.prvt_id is not applicable - 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 - For IN IMPS ultimate_creditor.prvt_id is not applicable - For UK FPS Instant payment ultimate_creditor.prvt_id is not applicable - For IN UPI ultimate_creditor.prvt_id is not applicable - US Wire, ultimate_creditor.prvt_id is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.prvt_id field is not applicable - For SEPA IDP ultimate_creditor.prvt_id field is optional with max length 35 - For Japan Instant payment ultimate_creditor.prvt_id field is not applicable - 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 - For TH Instant payment ultimate_creditor.birth_date is not applicable - For US Instant payment ultimate_creditor.birth_date field is not applicable - For IN IMPS ultimate_creditor.birth_date is not applicable - For UK FPS Instant payment ultimate_creditor.birth_date field is not applicable - For IN UPI ultimate_creditor.birth_date is not applicable - For US Wire ultimate_creditor.birth_date is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.birth_date is not applicable - For SEPA IDP ultimate_creditor.birth_date field is optional - For Japan Instant payment ultimate_creditor.birth_date field is not applicable - 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 - For TH Instant payment ultimate_creditor.birth_city is not applicable - For US Instant payment ultimate_creditor.birth_city field is not applicable - For IN IMPS ultimate_creditor.birth_city is not applicable - For UK FPS Instant payment ultimate_creditor.birth_city is not applicable - For IN UPI ultimate_creditor.birth_city is not applicable - For US Wire ultimate_creditor.birth_city is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.birth_city is not applicable - For SEPA IDP ultimate_creditor.birth_city is optional with max length 35 - For Japan Instant payment ultimate_creditor.birth_city field is not applicable - 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 - For TH Instant payment ultimate_creditor.birth_country is not applicable - For US Instant payment ultimate_creditor.birth_country field is not applicable - For IN IMPS ultimate_creditor.birth_country is not applicable - For UK FPS Instant payment ultimate_creditor.birth_country is not applicable - For IN UPI ultimate_creditor.birth_country is not applicable - For US Wire ultimate_creditor.birth_country is not applicable - For US ACH CCD/PPD/IAT payment, ultimate_creditor.birth_country is not applicable - For SEPA IDP ultimate_creditor.birth_country field is optional - For Japan Instant payment ultimate_creditor.birth_country field is not applicable - 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 - For TH Instant payment ultimate_creditor.anybic is not applicable - For US Instant payment ultimate_creditor.anybic is not applicable - For IN IMPS ultimate_creditor.anybic is not applicable - For UK FPS Instant payment ultimate_creditor.anybic is not applicable - For IN UPI ultimate_creditor.anybic is not applicable - For US Wire, ultimate_creditor.anybic is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.anybic is not applicable - For US ACH IAT payment, ultimate_creditor.anybic is not applicable - For US ACH IAT payment, ultimate_creditor.anybic is not applicable - For SEPA IDP, ultimate_creditor.anybic is optional with max length 11 - For Japan Instant payment ultimate_creditor.anybic field is not applicable - 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 - For TH Instant payment ultimate_creditor.lei is not applicable - For US Instant payment ultimate_creditor.lei is not applicable - For IN IMPS ultimate_creditor.lei is not applicable - For UK FPS Instant payment ultimate_creditor.lei is not applicable - For IN UPI ultimate_creditor.lei is not applicable - For US Wire, ultimate_creditor.lei is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.lei is not applicable - For US ACH IAT payment, ultimate_creditor.lei is not applicable - For US ACH IAT payment, ultimate_creditor.lei is not applicable - For SEPA IDP, ultimate_creditor.lei is optional with max length 20 - For Japan Instant payment ultimate_creditor.lei field is not applicable - For SEPA, ultimate_creditor.lei is optional with max length 20 title: lei issuer: maxLength: 35 minLength: 1 type: string description: >2- Ultimate creditor name that identifies an issuer - For TH Instant payment ultimate_creditor.issuer is not applicable - For US Instant payment ultimate_creditor.issuer is not applicable - For IN IMPS ultimate_creditor.issuer is not applicable - For UK FPS Instant payment ultimate_creditor.issuer is not applicable - For IN UPI ultimate_creditor.issuer is not applicable - For US Wire, ultimate_creditor.issuer is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.issuer is not applicable - For US ACH IAT payment, ultimate_creditor.issuer is not applicable - For US ACH IAT payment, ultimate_creditor.issuer is not applicable - For SEPA IDP, ultimate_creditor.issuer is optional with max length 35 - For Japan Instant payment ultimate_creditor.issuer field is not applicable - 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 - For TH Instant payment ultimate_creditor.birth_province is not applicable - For US Instant payment ultimate_creditor.birth_province is not applicable - For IN IMPS ultimate_creditor.birth_province is not applicable - For UK FPS Instant payment ultimate_creditor.birth_province is not applicable - For IN UPI ultimate_creditor.birth_province is not applicable - For US Wire, ultimate_creditor.birth_province is not applicable - For US ACH CCD/PPD payment, ultimate_creditor.birth_province is not applicable - For US ACH IAT payment, ultimate_creditor.birth_province is not applicable - For US ACH IAT payment, ultimate_creditor.birth_province is not applicable - For SEPA IDP, ultimate_creditor.birth_province is optional with max length 35 - For Japan Instant payment ultimate_creditor.birth_province field is not applicable - 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 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 - Provide IP for instant payment - For India provide either IMPS or UPI - Provide WIRE for US Wire payment - Provide ACH for US ACH payment - 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 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 - Provide IP for instant payment - For India provide either IMPS or UPI - 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) - BK_CT - Book to Book Credit Transfer - 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 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 - For Thailand PromptPay transaction.instruction_id field is not applicable - For United States transaction.instruction_id field is optional - For IN IMPS transaction.instruction_id field is not applicable - For UK FPS Instant payment transaction.instruction_id field is not applicable - For JP Instant payment transaction.instruction_id field is applicable - For IN UPI transaction.instruction_id field is not applicable - For US Wire, this field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.instruction_id field is not applicable - For SEPA IDP transaction.instruction_id field is optional with max length 35 - For Japan Instant payment transaction.instruction_id field is not applicable - 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) - For SEPA IDP, transaction id will be passed in transaction.network_id field - 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. - To utilize the field in production, please contact with implementation manager - For TH Instant payment transaction.local_reference is optional - For US Instant payment transaction.local_reference field is not applicable - For IN IMPS transaction.local_reference is optional - For UK FPS Instant payment transaction.local_reference is not applicable - For JP Instant payment transaction.local_reference field is applicable - For IN UPI transaction.local_reference is optional - For US WIRE, transaction.local_reference field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.local_reference field is not applicable - For SEPA IDP transaction.local_reference field is not applicable - 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. - For TH Instant payment transaction.reference is not applicable - For US Instant payment transaction.reference field is not applicable - For IN IMPS transaction.reference is not applicable - For UK FPS Instant payment transaction.reference is not applicable - For JP Instant payment transaction.reference is optional - For IN UPI transaction.reference is not applicable - For US WIRE, transaction.reference field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.reference field is not applicable - For SEPA IDP transaction.reference field is not applicable - For SEPA, transaction.reference field is not applicable title: reference processing_code: type: string description: >- - For Thailand this field contains the reference of, Two Digit Process Code + Two Digit From Account + Two Digit To Account Processing 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 - For US Instant payment transaction.processing_code field is not applicable - For IN IMPS transaction.processing_code is not applicable - For UK FPS Instant payment transaction.processing_code is not applicable - For JP Instant payment transaction.processing_code is not applicable - For IN UPI transaction.processing_code is not applicable - For US WIRE, transaction.processing_code field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.processing_code field is not applicable - For SEPA IDP transaction.processing_code field is not applicable - 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 - Thailand PromptPay - Maximum length is 20. - For US Instant payment transaction.bill_id_1 field is not applicable - For IN IMPS transaction.bill_id_1 field is not applicable - For UK FPS Instant payment transaction.bill_id_1 field is not applicable - For IN UPI transaction.bill_id_1 field is not applicable - For US Wire, transaction.bill_id_1 field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.bill_id_1 field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.bill_id_1 field is not applicable - 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 - Thailand PromptPay - Maximum length is 20. - For US Instant payment transaction.bill_id_2 field is not applicable - For IN IMPS transaction.bill_id_2 field is not applicable - For UK FPS Instant payment transaction.bill_id_2 field is not applicable - For IN UPI transaction.bill_id_2 field is not applicable - For US Wire, transaction.bill_id_2 field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.bill_id_2 field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.bill_id_2 field is not applicable - 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 - Thailand PromptPay - Maximum length is 20. - For US Instant payment transaction.bill_id_3 field is not applicable - For IN IMPS transaction.bill_id_3 field is not applicable - For UK FPS Instant payment transaction.bill_id_3 field is not applicable - For IN UPI transaction.bill_id_3 field is not applicable - For US Wire, transaction.bill_id_3 field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.bill_id_3 field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.bill_id_3 field is not applicable - 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 - For Thailand PromptPay transaction.purpose field is optional - For US Instant payment transaction.purpose field is optional - For IN IMPS transaction.purpose field is optional - UK FPS Instant payment transaction.purpose field is optional - For IN UPI transaction.purpose field is optional - For India FIR IMPS Instant payment transaction.purpose field is mandatory - CASH for cash management - CNFL for confidential - COST for payment for business expenses - GDSV for payment related to purchase or sale of goods and services - GP2P for person-to-person payment - OTHR for other, if your payment doesn't fit any of the specific purpose codes - RCPT for payment of a receipt - SALA for salary payment - SUPP for supplier payment - TREA for treasury payment - REFU for refund payment - CLPO for Claim Payouts - LODI for Loan Disbursals - TIPO for Tips Payout - GIEO for Gig economy - VEPO for Vendor Payouts - INPO for Incentive Payouts - ISPO for Insurance Payouts - MPPO for Merchant/Marketplace Payouts - TXPO for Tax Payments - RDPO for Rider payout - GDDS for payment related to purchase or sale of goods - SCVE for payment related to purchase or sale of services - PAYR for payroll payment - NOWS for Not Otherwise Specified - INVS for Invoice Signed - INSC for Payment Of Insurance Claim - INSM for Installment - PDEP for Property Deposit - UBIL for Utilities Subscription Identification - ACCT for Account Management - CBLK for Bulk card transactions - MP2P for Mobile P2P Payment - For US Wire, transaction.purpose field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.purpose field is not applicable - For SEPA IDP this field is optional - For Japan Instant payment transaction.purpose field is not applicable - For SEPA, this field is optional title: purpose tax_code: type: number enum: - 0 - 1 - 2 description: >- Tax code - 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 - For US Instant payment transaction.tax_code field is not applicable - For IN IMPS transaction.tax_code field is not applicable - For UK FPS Instant payment transaction.tax_code field is not applicable - For IN UPI transaction.tax_code field is not applicable - For US Wire, transaction.tax_code field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.tax_code field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.tax_code field is not applicable - For SEPA, this field is not applicable title: tax_code wht_code: type: string enum: - A - S - B description: >- Withholding tax (WHT) code - 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. - For US Instant payment transaction.wht_code field is not applicable - For IN IMPS transaction.wht_code field is not applicable - For UK FPS Instant payment transaction.wht_code field is not applicable - For IN UPI transaction.wht_code field is not applicable - For US Wire, transaction.wht_code field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.wht_code field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.wht_code field is not applicable - For SEPA, this field is not applicable title: wht_code income_type: type: string pattern: ^(00[0-9]|01[0-2])$ description: >- Income type - 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. - For US Instant payment transaction.income_type field is not applicable - For IN IMPS transaction.income_type field is not applicable - For UK FPS Instant payment transaction.income_type field is not applicable - For IN UPI transaction.income_type field is not applicable - For US Wire, transaction.income_type field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.income_type field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.income_type field is not applicable - For SEPA, this field is not applicable title: income_type vat_rate: type: number minimum: 0 description: |- Value-added tax (VAT) rate - For TH Instant Payent Range is 0 - 99.99 - For US Instant payment transaction.vat_rate field is not applicable - For IN IMPS transaction.vat_rate field is not applicable - For UK FPS Instant payment transaction.vat_rate field is not applicable - For IN UPI transaction.vat_rate field is not applicable - For US Wire, transaction.vat_rate field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.vat_rate field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.vat_rate field is not applicable - For SEPA, this field is not applicable title: vat_rate vat_amount: type: number maximum: 1000000000000000 description: |- Value-added tax (VAT) amount - Thailand PromptPay - Maximum amount is 2000000.00. - For US Instant payment transaction.vat_amount field is not applicable - For IN IMPS transaction.vat_amount field is not applicable - For UK FPS Instant payment transaction.vat_amount field is not applicable - For IN UPI transaction.vat_amount field is not applicable - For US Wire, transaction.vat_amount field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.vat_amount field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.vat_amount field is not applicable - For SEPA, this field is not applicable title: vat_amount wht_rate: type: number minimum: 0 description: |- Withholding tax (WHT) rate (0 - 99.99) - Thailand PromptPay - Maximum rate is 5.00. - For US Instant payment transaction.wht_rate field is not applicable - For IN IMPS transaction.wht_rate field is not applicable - For UK FPS Instant payment transaction.wht_rate field is not applicable - For IN UPI transaction.wht_rate field is not applicable - For US Wire, transaction.wht_rate field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.wht_rate field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.wht_rate field is not applicable - For SEPA, this field is not applicable title: wht_rate wht_amount: type: number maximum: 1000000000000000 description: |- Withholding tax (WHT) amount - Thailand PromptPay - Maximum amount is 2000000.00. - For US Instant payment transaction.wht_amount field is not applicable - For IN IMPS transaction.wht_amount field is not applicable - For UK FPS Instant payment transaction.wht_amount field is not applicable - For IN UPI transaction.wht_amount field is not applicable - For US Wire, transaction.wht_amount field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.wht_amount field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.wht_amount field is not applicable - 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 - For TH Instant payment if client provides transaction.bill_id_1 value, require client to mandatorily provide bill_due_date value. - For US Instant payment transaction.bill_due_date field is not applicable - For IN IMPS transaction.bill_due_date field is not applicable - For UK FPS Instant payment transaction.bill_due_date field is not applicable - For IN UPI transaction.bill_due_date field is not applicable - For US Wire, transaction.bill_due_date field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.bill_due_date field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.bill_due_date field is not applicable - 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) - Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation - 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 - 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 - For US Wire, transaction.value_date is a mandatory field - For US ACH CCD/PPD/IAT payment, transaction.value_date field is mandatory - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.value_date field is mandatory, value date should be current calender date or current calender date -7 - 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 - Thailand PromptPay - Maximum amount is 2000000.00 - US RTP - Maximum amount is 1000000.00 - IN IMPS - Maximum amount is 500000.00 - UK FPS Instant Payment - Maximum amount is 1000000.00 and allowed only Maximum of Two digits after decimal - IN UPI - Maximum amount is 200000.00 - For US Wire, transaction.instructed_amount is a mandatory field. Maximum amount is $9999999999.99 - Japan - Maximum amount is 99,999,999 - 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 - Thailand PromptPay - Maximum length is 40. - For US Instant payment transaction.additional_info field is not applicable - For IN IMPS transaction.additional_info field is not applicable - For UK FPS Instant payment transaction.additional_info field is optional and allowed max length is 105 - For IN UPI transaction.additional_info field is not applicable - For US Wire, transaction.additional_info field is not applicable - 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 - For US ACH IAT payment, transaction.additional_info field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.additional_info field is not applicable - For SEPA, this field is not applicable title: additional_info unstructured_remittance_info: type: array description: >- Unstructured remitance information - For TH Instant payment transaction.unstructured_remittance_info field is not applicable - For US Instant payment transaction.unstructured_remittance_info field is optional - Maximum length is 140 and Single instance is allowed - 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 - For UK FPS Instant payment transaction.unstructured_remittance_info is optional and allowed only four instance with each line max length of 35 - 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 - 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. - For SEPA and SEPA IDP transaction.unstructured_remittance_info field is optional with max length 140 and ten instances allowed - For Japan Instant payment transaction.unstructured_remittance_info field is applicable and Maximum length is 140 and four instance is allowed - 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 - EMAL - EMail, FAXI - Fax, SMSM - SMS Phone Number, URID - UniformResourceIdentifier - For TH Instant payment transaction.advice_type field is not applicable - For US Instant payment transaction.advice_type field is not applicable - For IN IMPS transaction.advice_type field is optional with max length 4 - For UK FPS Instant payment transaction.advice_type field is not applicable - For IN UPI transaction.advice_type field is optional, applicable values are SMSM or EMAL - For US Wire, transaction.advice_type field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.advice_type field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.advice_type field is not applicable - 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 - For TH Instant payment transaction.advice_address field is not applicable - For US Instant payment transaction.advice_address field is not applicable - For IN IMPS transaction.advice_address field is optional - For UK FPS Instant payment transaction.advice_address field is not applicable - For IN UPI transaction.advice_address field is mandatory, if transaction.advice_type is EMAL - For US Wire, transaction.advice_address field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.advice_address field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.advice_address field is not applicable - For SEPA, this field is not applicable title: advice_address category: type: string description: >- Specifies the high level purpose of the instruction - For Thailand PromptPay transaction.category field is not applicable - For United States transaction.category field is optional - For IN IMPS transaction.category field is not applicable - For UK FPS Instant payment transaction.category field is not applicable - For IN UPI transaction.category field is not applicable - For US Wire, transaction.category field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.category field is mandatory and allowed value is CCD, PPD and IAT - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.category field is not applicable - For India FIR IMPS payment transaction.category field is applicable and allowed value is FIR and FDL - 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. - For Thailand PromptPay transaction.priority field is not applicable - For United States transaction.priority field is not applicble - For IN IMPS transaction.priority field is not applicable - For UK FPS Instant payment transaction.priority field is not applicable - For IN UPI transaction.priority field is not applicable - For US Wire, transaction.priority is an optional field - For US ACH CCD/PPD/IAT payment, transaction.priority field is not applicable - For SEPA IDP this field is not applicable - For Japan Instant payment transaction.category field is not applicable - 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. - For Thailand PromptPay transaction.charges_paid_by field is not applicable - For United States transaction.charges_paid_by field is not applicble - For IN IMPS transaction.charges_paid_by field is not applicable - For UK FPS Instant payment transaction.charges_paid_by field is not applicable - For US Wire, transaction.charges_paid_by is an optional field with allowed values CRED,DEBT,SHAR - For US ACH CCD/PPD/IAT payment, transaction.charges_paid_by field is not applicable - For SEPA IDP,transaction.charges_paid_by is optional with max length 4 - For Japan Instant payment transaction.charges_paid_by field is not applicable - 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. - For Thailand PromptPay transaction.original_amount field is not applicable - For United States transaction.original_amount field is optional - For IN IMPS transaction.original_amount field is not applicable - For UK FPS Instant payment transaction.original_amount field is not applicable - For JP Instant payment transaction.original_amount field is not applicable - For IN UPI transaction.original_amount field is not applicable - For US WIRE, transaction.original_amount field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.original_amount field is not applicable - For SEPA IDP this field is not applicable - 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 - For Thailand PromptPay transaction.full_amount field is not applicable - For United States transaction.full_amount field is optional - For IN IMPS transaction.full_amount field is not applicable - For UK FPS Instant payment transaction.full_amount field is not applicable - For JP Instant payment transaction.full_amount field is not applicable - For IN UPI transaction.full_amount field is not applicable - For US WIRE, transaction.full_amount field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.full_amount field is not applicable - For SEPA IDP this field is not applicable - 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 - For Thailand PromptPay transaction.discount_amount field is not applicable - For United States transaction.discount_amount field is optional - For IN IMPS transaction.discount_amount field is not applicable - For UK FPS Instant payment transaction.discount_amount field is not applicable - For JP Instant payment transaction.discount_amount field is not applicable - For IN UPI transaction.discount_amount field is not applicable - For US WIRE, transaction.discount_amount field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.discount_amount field is not applicable - For SEPA IDP this field is not applicable - 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 - For TH Instant payment transaction.interbank_settlement_date is not applicable - For US Instant payment transaction.interbank_settlement_date is optional - For IN IMPS transaction.interbank_settlement_date is not applicable - For UK FPS Instant payment transaction.interbank_settlement_date is not applicable - For IN UPI transaction.interbank_settlement_date is not applicable - For US Wire, transaction.interbank_settlement_date is not applicable - For US ACH CCD/PPD payment, transaction.interbank_settlement_date is not applicable - For US ACH IAT payment, transaction.interbank_settlement_date is not applicable - For US ACH IAT payment, transaction.interbank_settlement_date is not applicable - For SEPA IDP, transaction.interbank_settlement_date is mandatory - For Japan Instant payment transaction.interbank_settlement_date field is not applicable - 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 - For TH Instant payment transaction.category_purpose is not applicable - For US Instant payment transaction.category_purpose is not applicable - For IN IMPS transaction.category_purpose is not applicable - For UK FPS Instant payment transaction.category_purpose is not applicable - For IN UPI transaction.category_purpose is not applicable - For US Wire, transaction.category_purpose is not applicable - For US ACH CCD/PPD payment, transaction.category_purpose is not applicable - For US ACH IAT payment, transaction.category_purpose is not applicable - For US ACH IAT payment, transaction.category_purpose is not applicable - For SEPA IDP, transaction.category_purpose is optional with max length 35 - For Japan Instant payment transaction.category_purpose field is not applicable - 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 - For TH Instant payment transaction.acceptance_date_time is not applicable - For US Instant payment transaction.acceptance_date_time is not applicable - For IN IMPS transaction.acceptance_date_time is not applicable - For UK FPS Instant payment transaction.acceptance_date_time is not applicable - For IN UPI transaction.acceptance_date_time is not applicable - For US Wire, transaction.acceptance_date_time is not applicable - For US ACH CCD/PPD payment, transaction.acceptance_date_time is not applicable - For US ACH IAT payment, transaction.acceptance_date_time is not applicable - For US ACH IAT payment, transaction.acceptance_date_time is not applicable - For SEPA IDP, transaction.acceptance_date_time is optional - For Japan Instant payment transaction.acceptance_date_time field is not applicable - 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' 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) - 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 - ACCC - Completed - 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 - For SEPA VoP,this field is optional - MATCH - Validation based on account is a match - MISMATCH - Validation based on account is a mismatch - NA - Account match did not happen enum: - MATCH - MISMATCH - NA title: number_validation name_validation: type: string description: |- Name validation result - For SEPA VoP,this field is optional - MATCH - Validation based on name is a match - MISMATCH - Validation based on name is a mismatch - PARTIALMATCH - Validation based on name is a partial match - NOTCHECKED - Validation not checked - NA - Name match did not happen enum: - MATCH - MISMATCH - PARTIALMATCH - NA title: name_validation unstructured_remittance_info: type: array description: |- Unstructured remitance information - 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 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 regulatory-reporting: type: object title: RegulatoryReporting properties: type: maxLength: 35 minLength: 1 type: string description: |- Regulatory Reporting details type - For TH Instant payment transaction.regulatory_reporting.type is not applicable - For US Instant payment transaction.regulatory_reporting.type field is not applicable - For IN IMPS transaction.regulatory_reporting.type is not applicable - For UK FPS Instant payment transaction.regulatory_reporting.type is not applicable - For JP Instant payment transaction.regulatory_reporting.type is not applicable - For IN UPI transaction.regulatory_reporting.type is not applicable - For US WIRE,transaction.regulatory_reporting.type field is not applicable - For US ACH CCD/PPD/IAT payment,transaction.regulatory_reporting.type field is not applicable - For SEPA IDP transaction.regulatory_reporting.type field is optional with max length 35 - For Japan Instant payment transaction.regulatory_reporting.type field is not applicable - 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 - For TH Instant payment transaction.regulatory_reporting.code is not applicable - For US Instant payment transaction.regulatory_reporting.code field is not applicable - For IN IMPS transaction.regulatory_reporting.code is not applicable - For UK FPS Instant payment transaction.regulatory_reporting.code is not applicable - For JP Instant payment transaction.regulatory_reporting.code is not applicable - For IN UPI transaction.regulatory_reporting.code is not applicable - For US WIRE,transaction.regulatory_reporting.code field is not applicable - For US ACH CCD/PPD/IAT payment,transaction.regulatory_reporting.code field is not applicable - For SEPA IDP transaction.regulatory_reporting.code field is optional with max length 10 - For Japan Instant payment transaction.regulatory_reporting.code field is not applicable - For SEPA, transaction.regulatory_reporting.code field is optional and allowed maxLength is 35 title: code 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 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 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 - For TH Instant payment transaction.structured_remittance_info.creditor_reference_information_code is not applicable - For US Instant payment transaction.structured_remittance_info.creditor_reference_information_code field is not applicable - For IN IMPS transaction.structured_remittance_info.creditor_reference_information_code is not applicable - For UK FPS Instant payment transaction.structured_remittance_info.creditor_reference_information_code is not applicable - For JP Instant payment transaction.structured_remittance_info.creditor_reference_information_code is not applicable - For IN UPI transaction.structured_remittance_info.creditor_reference_information_code is not applicable - For US WIRE, transaction.structured_remittance_info.creditor_reference_information_code field is not applicable - For US ACH CCD/PPD/IAT payment, transaction.structured_remittance_info.creditor_reference_information_code field is not applicable - For SEPA IDP transaction.structured_remittance_info.creditor_reference_information_code field is optional with max length 4 - For Japan Instant payment transaction.structured_remittance_info.creditor_reference_information_code field is not applicable - 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 - For TH Instant payment transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For US Instant payment transaction.structured_remittance_info.creditor_reference_issuer field is not applicable - For IN IMPS transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For UK FPS Instant payment transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For JP Instant payment transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For IN UPI transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For US WIRE,transaction.structured_remittance_info.creditor_reference_issuer field is not applicable - For US ACH CCD/PPD/IAT payment,transaction.structured_remittance_info.creditor_reference_issuer field is not applicable - For SEPA IDP transaction.structured_remittance_info.creditor_reference_issuer field is optional with max length 35 - For Japan Instant payment transaction.structured_remittance_info.creditor_reference_issuer field is not applicable - 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 - For TH Instant payment transaction.structured_remittance_info.creditor_reference is not applicable - For US Instant payment transaction.structured_remittance_info.creditor_reference field is not applicable - For IN IMPS transaction.structured_remittance_info.creditor_reference is not applicable - For UK FPS Instant payment transaction.structured_remittance_info.creditor_reference is not applicable - For JP Instant payment transaction.structured_remittance_info.creditor_reference is not applicable - For IN UPI transaction.structured_remittance_info.creditor_reference is not applicable - For US WIRE,transaction.structured_remittance_info.creditor_reference field is not applicable - For US ACH CCD/PPD/IAT payment,transaction.structured_remittance_info.creditor_reference field is not applicable - For SEPA IDP transaction.structured_remittance_info.creditor_reference field is optional with max length 35 - For Japan Instant payment transaction.structured_remittance_info.creditor_reference field is not applicable - For SEPA, transaction.structured_remittance_info.creditor_reference field is optional and allowed maxLength is 35 title: creditor_reference 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. - For TH Instant payment instructed_agent.bank_id field is not applicable - For US Instant payment instructed_agent.bank_id field is not applicable - For IN IMPS Instant payment instructed_agent.bank_id field is not applicable - For UK FPS Instant payment instructed_agent.bank_id field is not applicable - For IN UPI Instant payment instructed_agent.bank_id field is not applicable - For US Wire, instructed_agent.bank_id is not applicable - For US ACH CCD/PPD payment, instructed_agent.bank_id is not applicable - For US ACH IAT payment, instructed_agent.bank_id is not applicable - For SEPA IDP instructed_agent.bank_id field is mandatory with max length 11 - For Japan Instant payment instructed_agent.bank_id field is not applicable - For SEPA, instructed_agent.bank_id field is mandatory with max length 11 title: bank_id 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. - For TH Instant payment instructing_agent.bank_id field is not applicable - For US Instant payment instructing_agent.bank_id field is not applicable - For IN IMPS Instant payment instructing_agent.bank_id field is not applicable - For UK FPS Instant payment instructing_agent.bank_id field is not applicable - For IN UPI Instant payment instructing_agent.bank_id field is not applicable - For US Wire, instructing_agent.bank_id is not applicable - For US ACH CCD/PPD payment, instructing_agent.bank_id is not applicable - For US ACH IAT payment, instructing_agent.bank_id is not applicable - For SEPA IDP instructing_agent.bank_id field is not applicable - For Japan Instant payment instructing_agent.bank_id field is not applicable - 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. - 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 - 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. - 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 - 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. - 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 - 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. - 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 - 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. - 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 - 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. - 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 - 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 - 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 - 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 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. - For TH Instant payment instructing_agent.bank_id field is not applicable - For US Instant payment instructing_agent.bank_id field is not applicable - For IN IMPS Instant payment instructing_agent.bank_id field is not applicable - For UK FPS Instant payment instructing_agent.bank_id field is not applicable - For IN UPI Instant payment instructing_agent.bank_id field is not applicable - For US Wire, instructing_agent.bank_id is not applicable - For US ACH CCD/PPD payment, instructing_agent.bank_id is not applicable - For US ACH IAT payment, instructing_agent.bank_id is not applicable - For SEPA IDP instructing_agent.bank_id field is mandatory with max length 11 - For Japan Instant payment instructing_agent.bank_id field is not applicable - For India FIR IMPS Instant payment instructing_agent.bank_id field is optional and allowed length is 11 - 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. - 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 - 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. - 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 - 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. - 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 - 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. - 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 - 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. - 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 - 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. - 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 - 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 - 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 - 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 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 - Thailand PromptPay - Maximum amount is 2000000.00 - United States - Maximum amount is 1000000.00 - 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 Refunds-Response: type: array items: $ref: '#/components/schemas/Refunds' maxItems: 1000 Refunds: type: object title: Refunds required: - instructed_amount - instructed_currency - original_payment - end_to_end_id properties: end_to_end_id: $ref: '#/components/schemas/Restricted-Finx-Max-Text' instruction_id: type: string description: >- Instruction id on return payment - For Thailand PromptPay refunds.instruction_id field is not applicable - For Brazil refunds.instruction_id field is not applicable - For United States refunds.instruction_id field is optional - For SEPA refunds.instruction_id field is not applicable minLength: 1 maxLength: 35 title: instruction_id refund_id: 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: refund_id creation_date_time: type: string format: date-time description: >- GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ)- Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation - 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 network_id: maxLength: 128 minLength: 1 type: string description: |- Transaction identification generated by the network (clearing) - For Thailand PromptPay refunds.network_id field is not applicable - For Brazil refunds.network_id field is optional - For United States refunds.network_id field is not applicable - For SEPA refunds.network_id field is not applicable title: network_id value_date: type: string format: date description: >- 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 - Format YYYY-MM-DD title: value_date instructed_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: >- Instructed amount can be either full original transaction amount or partial amount - Thailand PromptPay - Maximum amount is 2000000.00 - United States - Maximum amount is 1000000.00 title: instructed_amount instructed_currency: description: ISO 4217 code for the transaction instructed amount currency type: string enum: - THB - BRL - USD - EUR - AUD title: instructed_currency additional_info: type: string maxLength: 140 minLength: 1 description: |- Additional or remittance information - For Thailand PromptPay - Maximum length is 40 - For United States refunds.additional_info field is not applicable - For Brazil refunds.additional_info field is optional - For SEPA refunds.additional_info field is not applicable title: additional_info unstructured_remittance_info: type: array description: >- Unstructured remitance information - For TH refunds.unstructured_remittance_info field is not applicable - For US refunds.unstructured_remittance_info field is optional - Maximum length is 140 and single instance is allowed - For Brazil refunds.unstructured_remittance_info field is not applicable - For SEPA refunds.unstructured_remittance_info field is optional - Maximum length is 140 and single instance is allowed items: $ref: '#/components/schemas/Unstructured' title: unstructured_remittance_info return_reason_code: description: >- Reason code to initiate the refund - For TH refunds.return_reason_code field is not applicable - For US refunds.return_reason_code field is not applicable - For Brazil refunds.return_reason_code field is not applicable - For SEPA refunds.return_reason_code field is mandatory - For AU, applicable retun reason codes are AM05, AM09, BE05, CUST, FOCR, MD05, NARR - BE05 -Beneficiary does not recognize the remitter. - AC01 -Remitter sent the transaction to the wrong account. - AM02 -Transaction amount is higher than expected. - AM06 -Transaction amount is lower than expected. - AM03 -Transaction currency is incorrect. - AG01 -Transaction information is insufficient for reconciliation. - AM05 -Transaction is a duplicate. - MS01 -Other - AM09 -Transaction amount is wrong. - CUST -Requested by customer. - FOCR -Following cancellation request. - MD05 -Collection not due. - NARR -Narrative from client type: string enum: - BE05 - AC01 - AM02 - AM03 - AM05 - AM06 - AG01 - MS01 - AM09 - CUST - FOCR - MD05 - NARR title: return_reason_code return_reason_description: type: string maxLength: 105 minLength: 1 description: >- Reason description to initiate the refund - For AU, return reason description is mandatory if return reason code is NARR title: return_reason_description status: $ref: '#/components/schemas/Refund-Status' reasons: $ref: '#/components/schemas/Refund-Reasons' debtor: $ref: '#/components/schemas/Debtor-Refund' ultimate_debtor: $ref: '#/components/schemas/Ultimate-Debtor-Refund' original_payment: $ref: '#/components/schemas/Original-Payment' description: Refund status notification / inquiry response Refunds-Initiation: type: object title: Refunds required: - instructed_amount - instructed_currency - original_payment - end_to_end_id properties: end_to_end_id: $ref: '#/components/schemas/Restricted-Finx-Max-Text' instruction_id: type: string description: >- Instruction id on return payment - For Thailand PromptPay refunds.instruction_id field is not applicable - For Brazil refunds.instruction_id field is not applicable - For United States refunds.instruction_id field is optional - For SEPA refunds.instruction_id field is not applicable minLength: 1 maxLength: 35 title: instruction_id value_date: type: string readOnly: true format: date description: >- 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 - Format YYYY-MM-DD title: value_date instructed_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: >- Instructed amount can be either full original transaction amount or partial amount - Thailand PromptPay - Maximum amount is 2000000.00 - United States - Maximum amount is 1000000.00 title: instructed_amount instructed_currency: description: ISO 4217 code for the transaction instructed amount currency type: string enum: - THB - BRL - USD - EUR - AUD title: instructed_currency additional_info: type: string maxLength: 140 minLength: 1 description: |- Additional or remittance information - For Thailand PromptPay - Maximum length is 40 - For United States refunds.additional_info field is not applicable - For Brazil refunds.additional_info field is optional - For SEPA, refunds.additional_info field is not applicable title: additional_info unstructured_remittance_info: type: array description: >- Unstructured remitance information - For TH refunds.unstructured_remittance_info field is not applicable - For US refunds.unstructured_remittance_info field is optional - Maximum length is 140 and single instance is allowed - For Brazil refunds.unstructured_remittance_info field is not applicable - For SEPA refunds.unstructured_remittance_info field is optional - Maximum length is 140 and single instance is allowed items: $ref: '#/components/schemas/Unstructured' title: unstructured_remittance_info return_reason_code: description: >- Reason code to initiate the refund - For TH refunds.return_reason_code field is not applicable - For US refunds.return_reason_code field is not applicable - For Brazil refunds.return_reason_code field is not applicable - For SEPA refunds.return_reason_code field is mandatory - For AU, applicable retun reason codes are AM05, AM09, BE05, CUST, FOCR, MD05, NARR - BE05 -Beneficiary does not recognize the remitter. - AC01 -Remitter sent the transaction to the wrong account. - AM02 -Transaction amount is higher than expected. - AM06 -Transaction amount is lower than expected. - AM03 -Transaction currency is incorrect. - AG01 -Transaction information is insufficient for reconciliation. - AM05 -Transaction is a duplicate. - MS01 -Other - AM09 -Transaction amount is wrong. - CUST -Requested by customer. - FOCR -Following cancellation request. - MD05 -Collection not due. - NARR -Narrative from client type: string enum: - BE05 - AC01 - AM02 - AM03 - AM05 - AM06 - AG01 - MS01 - AM09 - CUST - FOCR - MD05 - NARR title: return_reason_code return_reason_description: type: string maxLength: 105 minLength: 1 description: >- Reason description to initiate the refund - For AU, return reason description is mandatory if return reason code is NARR title: return_reason_description debtor: $ref: '#/components/schemas/Debtor-Refund' ultimate_debtor: $ref: '#/components/schemas/Ultimate-Debtor-Refund' original_payment: $ref: '#/components/schemas/Original-Payment' description: Refund status notification / inquiry response Payments-Response: type: array items: $ref: '#/components/schemas/Payments' maxItems: 1000 Payments: type: object title: Payments required: - debtor - creditor - method - transaction properties: message_id: type: string description: >- Message Identification - 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 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 For UK FPS payment, only the below set of character supported - A to Z (uppercase) - a to z (lowercase) - 0 to 9 - / (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) - Fixed length numeric fields are right justified with leading zeros - Fixed length alphanumeric fields are left justified with trailing spaces - Fixed length binary fields are left justified with trailing zeros - } (right curly bracket) is not supported 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 / - ? : ( ) . , ‘ + . - If client_id + end_to_end_id combination is duplicate within 90 days, payment will be rejected - Thailand Max length 12 - United State Max length 35 - IN IMPS Max length 16 - UK FPS Max length is 18 - Brazil Max length is 35 - IN UPI Max length 16 - For US WIRE/ACH, Max length is 16 and allowed value is AlphaNumeric (A-Z and 0-9) - For SEPA and SEPA IDP Max length is 35 - Japan Max length 35. It allows only upper alphabet characters A-Z and accepts special characters as follows . , () - title: Restricted-Finx-Max-Text Status: type: object title: Status properties: date_time: type: string format: date-time description: |- GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - 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 - ACTC - Accepted - ACCC - Completed - PDNG - Pending - RJCT - Rejected (only in case of US incoming returns - 'Returned') - ACWP - AcceptedWithoutPosting (Applicable for US country) - ACCP - Accepted (Applicable for UK BACS - ACH) - 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 Refund-Status: type: object title: RefundStatus required: - date_time - code - description properties: date_time: type: string format: date-time description: |- GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Date time of transaction status title: date_time code: type: string description: ISO 20022 transaction status code enum: - ACCC - ACTC - RJCT title: code description: type: string description: |- Status code description - ACTC - Accepted - ACCC - Completed - RJCT - Rejected title: description type: type: string description: Refund Status P - Partial Refund F - Full Refund enum: - P - F title: type Reasons: type: array readOnly: false items: $ref: '#/components/schemas/Reason' Refund-Reasons: type: array title: RefundReasons items: $ref: '#/components/schemas/Reason' 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.) - 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., - AM03 -Method instructed currency is invalid (not in ISO 4217 format or value) - AM02 -Instructed amount is not ≥ 0.01 & ≤ 2,000,000.00. - AC02 -Debtor account is invalid - CH03 -Value date is in the future - CH04 -Value date is in the past - CH20 -Value-added tax (VAT) amount format is invalid - CH21 -Bill identification 1 is mandatory for a bill payment,Bill identification 2 and 3 are conditional for a bill payment - BE23 -Creditor mobile number (proxy identification) format is invalid - NARR -Creditor name maximum length is 50 ) - 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 - For UK it is an optional field with max length 4 - For SEPA IDP it is an optional field - For US, this field is optional - For SEPA, it is an optional field title: non_iso_code Initial-Acknowledgement-Response: type: object title: InitialAcknowledgementResponse properties: message_id: type: string description: Message Identification readOnly: true maxLength: 35 title: message_id creation_date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Date time when a message was created readOnly: true title: creation_date_time message_type: type: string description: |- Message Type as provided by the customer - RFR - Request for Refund (camt.056) - RRFR - Response to Request for Refund(camt.029) - PCR - Payment Confirmation Request - RPCR - Response to Payment Confirmation Request - RFP - Request for Payment (pain.013) - RRFP - Response to Request for Payment (pain.014) - RRFICS - Response to Request for Information Compliance enum: - RFR - RRFR - PCR - RPCR - RFP - RRFP - RRFICS title: message_type message: oneOf: - $ref: '#/components/schemas/Initial-Response-To-Request-For-Refund' - $ref: >- #/components/schemas/Initial-Response-To-Payment-Confirmation-Request - $ref: '#/components/schemas/Initial-Response-To-Request-For-Payment' - $ref: '#/components/schemas/Initial-Outgoing-Request-For-Refund' - $ref: >- #/components/schemas/Initial-Response-To-Request-for-Information-Compliance required: - message_id - creation_date_time - message_type Final-Message-Response: type: object title: FinalMessageResponse properties: message_id: type: string description: Message Identification readOnly: true maxLength: 35 title: message_id creation_date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Date time when a message was created readOnly: true title: creation_date_time message_type: type: string description: |- Message Type as provided by the customer - RFR - Request for Refund (camt.056) - RRFR - Response to Request for Refund(camt.029) - PCR - Payment Confirmation Request - RPCR - Response to Payment Confirmation Request - RFP - Request for Payment (pain.013) - RRFP - Response to Request for Payment (pain.014) - RFICS - Request for Information Compliance - RRFICS - Response to Request for Information Compliance enum: - RFR - RRFR - PCR - RPCR - RFP - RRFP - RFICS - RRFICS title: message_type original_payment: type: object title: OriginalPayment readOnly: true properties: message_id: type: string description: Message Id of original payment maxLength: 35 title: message_id creation_date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Date time when a original payment was created title: creation_date_time instruction_id: type: string description: Instruction ID of Original Payment minLength: 1 maxLength: 35 title: instruction_id end_to_end_id: type: string description: End to End ID of Original Payment minLength: 1 maxLength: 35 title: end_to_end_id transaction_id: type: string description: Transaction ID of Original Payment minLength: 1 maxLength: 35 title: transaction_id uetr: type: string description: UETR of Original payment pattern: >- ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ title: uetr clearing_reference: type: string description: Clearing reference of Original Payment minLength: 1 maxLength: 35 title: clearing_reference instructed_amount: type: number description: Instructed amount of Original Payment minimum: 0.01 maximum: 1000000000000000 title: instructed_amount instructed_currency: type: string description: Instructed currency of Original Payment enum: - USD - EUR - GBP - AUD - INR - ARS - BRL - HUF - HKD - CNY title: instructed_currency value_date: type: string format: date description: >- 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.Format is YYYY-MM-DD title: value_date message_name_identification: type: string description: Clearing specific original message name minLength: 1 maxLength: 35 title: message_name_identification requested_execution_date: type: string format: date description: Requested Execution Date of Original Request for Payment title: requested_execution_date requested_execution_date_time: type: string format: date-time description: Requested Execution Date/ Time of Original Request for Payment title: requested_execution_date_time expiry_date: type: string format: date description: Expiry Date of Original Request for Payment title: expiry_date expiry_date_time: type: string format: date-time description: Expiry Date/Time of Original Request for Payment title: expiry_date_time payment_information_id: type: string maxLength: 35 minLength: 1 description: Payment Information ID Original Request for Payment title: payment_information_id category_purpose: type: string maxLength: 128 minLength: 1 description: Category purpose of original payment title: category_purpose unstructured_remittance_info: type: array description: Unstructured remitance information of original payment items: $ref: '#/components/schemas/Unstructured' title: unstructured_remittance_info 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 of original payment title: creditor_reference_information_code creditor_reference_issuer: maxLength: 35 minLength: 1 type: string description: |- Structured Creditor Reference Issuer - For TH Instant payment transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For US Instant payment transaction.structured_remittance_info.creditor_reference_issuer field is not applicable - For IN IMPS transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For UK FPS Instant payment transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For JP Instant payment transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For IN UPI transaction.structured_remittance_info.creditor_reference_issuer is not applicable - For US WIRE,transaction.structured_remittance_info.creditor_reference_issuer field is not applicable - For US ACH CCD/PPD/IAT payment,transaction.structured_remittance_info.creditor_reference_issuer field is not applicable - For SEPA IDP transaction.structured_remittance_info.creditor_reference_issuer field is optional with max length 35 - For Japan Instant payment transaction.structured_remittance_info.creditor_reference_issuer field is not applicable - 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 of original payment title: creditor_reference purpose: type: string minLength: 1 maxLength: 5 description: >- Purpose of a transaction of original payment - CASH for cash management - CNFL for confidential - COST for payment for business expenses - GDDS for payment related to purchase or sale of goods - GDSV for payment related to purchase or sale of goods and services - GP2P for person-to-person payment - OTHR for other, if your payment doesn't fit any of the specific purpose codes - PAYR for payroll payment - RCPT for payment of a receipt - SALA for salary payment - SCVE for payment related to purchase or sale of services - SUPP for supplier payment - TREA for treasury payment - REFU for refund payment - CLPO for Claim Payouts - LODI for Loan Disbursals - TIPO for Tips Payout - GIEO for Gig economy - VEPO for Vendor Payouts - INPO for Incentive Payouts - ISPO for Insurance Payouts - MPPO for Merchant/Marketplace Payouts - TXPO for Tax Payments - RDPO for Rider payout title: purpose method: type: object title: OriginalMethod properties: network: type: string enum: - RTP - FDN - AUNPP description: >- Financial market infrastructure or clearing system (e.g., RTP Network in the United States) of original payment title: network debtor: $ref: '#/components/schemas/Original-Debtor' creditor: $ref: '#/components/schemas/Original-Creditor' ultimate_debtor: $ref: '#/components/schemas/Original-Ultimate-Debtor' ultimate_creditor: $ref: '#/components/schemas/Original-Ultimate-Creditor' message: oneOf: - $ref: '#/components/schemas/Request-For-Refund' - $ref: '#/components/schemas/Final-Response-To-Request-For-Refund' - $ref: '#/components/schemas/Payment-Confirmation-Request' - $ref: '#/components/schemas/Response-To-Payment-Confirmation-Request' - $ref: '#/components/schemas/Request-For-Payment' - $ref: '#/components/schemas/Response-To-Request-For-Payment' - $ref: '#/components/schemas/Final-Request-For-Information-Compliance' - $ref: >- #/components/schemas/Response-To-Request-For-Information-Compliance required: - message_id - creation_date_time - message_type Message-Request: type: object title: MessageRequest properties: message_type: type: string description: |- Message Type provided by the customer - RFR - Request for Refund (camt.056) - RRFR - Response to Request for Refund(camt.029) - PCR - Payment Confirmation Request - RPCR - Response to Payment Confirmation Request - RFP - Request for Payment (pain.013) - RRFP - Response to Request for Payment (pain.014) - RRFICS - Response to Request for Information Compliance enum: - RFR - RRFR - PCR - RPCR - RFP - RRFP - RRFICS title: message_type message: oneOf: - $ref: '#/components/schemas/Final-Response-To-Request-For-Refund' - $ref: >- #/components/schemas/Final-Response-To-Payment-Confirmation-Request - $ref: '#/components/schemas/Response-To-Request-For-Payment' - $ref: '#/components/schemas/Outgoing-Request-For-Refund' - $ref: >- #/components/schemas/Response-To-Request-For-Information-Compliance required: - message_type - message Request-For-Refund: type: object title: RequestForRefund description: Incoming/Outgoing Request For Refund properties: case_id: type: string description: Case Id received from clearing minLength: 1 maxLength: 35 readOnly: true title: case_id reasons: type: object title: reasons properties: code: type: string description: >- Code of Transaction reasons.Either ISO code or proprietary code should be present in this field maxLength: 4 title: code description: type: string description: Description of Transaction reasons minLength: 1 maxLength: 105 title: description required: - code requestor_name: type: string description: Official name of the originator of Request For Refund minLength: 1 maxLength: 140 title: requestor_name requestor_bank_id: type: string description: Bank ID of the originator FI requesting Request For Refund minLength: 1 maxLength: 35 title: requestor_bank_id requestor_issuer: type: string description: Originator Issuer minLength: 1 maxLength: 35 title: requestor_issuer requestor_org_id: type: string description: Orginator Identification minLength: 1 maxLength: 35 title: requestor_org_id requestor_lei: type: string description: LEI of the originator of RFR minLength: 1 maxLength: 20 pattern: '[A-Z0-9]{18,18}[0-9]{2,2}' title: requestor_lei status: type: object title: status properties: date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Status change date time title: date_time code: type: string description: ISO 20022 message status code enum: - RCVD - RJCT - PDNG title: code description: type: string description: |- Status code description - RJCT - Rejected - RCVD - Received - PDNG - Pending minLength: 1 maxLength: 256 title: description reasons: type: object title: reasons readOnly: true properties: code: type: string description: Reason code (applicable when message is rejected) maxLength: 4 title: code description: type: string description: Reason code description (e.g., Debtor account is invalid.) minLength: 1 maxLength: 256 title: description required: - date_time - code - description required: - case_id additionalProperties: false Payment-Confirmation-Request: type: object title: PaymentConfirmationRequest description: Incoming Payment Confirmation Request properties: debtor: $ref: '#/components/schemas/Message-Debtor-Status' ultimate_debtor: $ref: '#/components/schemas/Message-Ultimate-Debtor-Status' creditor: $ref: '#/components/schemas/Message-Creditor-Status' ultimate_creditor: $ref: '#/components/schemas/Message-Ultimate-Creditor-Status' method: $ref: '#/components/schemas/Message-Method-Status' transaction: $ref: '#/components/schemas/Message-Transaction-Status' Final-Response-To-Request-For-Refund: type: object title: FinalResponseToRequestForRefund description: Outgoing/Incoming Response to Request for Refund properties: case_id: type: string description: Case Id received from clearing minLength: 1 maxLength: 35 title: case_id decision_code: type: string description: >- Acceptance or Rejection of return of funds. Only the below 3 codes are applicable - IPAY - Acceptance to Return the payment - RJCR - Decline to Return the payment - PECR - Partially Executed Cancellation Return enum: - ACDA - ACNR - ACVA - CHRG - CNCL - CONF - CVAA - CWFW - FTNA - ICOV - IDUP - IPAY - IPYI - MCOV - MODI - MWFW - PDCR - PECR - PURP - RJCR - RJNR - RJVA - SMTC - SMTI - UWFW - BIAS - IDNE - IVCR - INFO - NINF - PDNG title: decision_code reasons: type: object title: reasons properties: code: type: string description: >- Code of Transaction reasons - If decision_code = RJCR,reasons.code is mandatory for ResponseToRequest-For-Refund enum: - AC04 - ADAC - AGNT - AM04 - ARDT - ARPL - CUST - LEGL - NARR - NOAS - NOOR - PTNA - RQDA - WSEQ - IDMN - ACLR - AEXR - ARFR - ARJR - PATE - RR04 - RCAR - RCNR - RCPR - URTP title: code description: type: string description: |- Reason code description (e.g., Debtor account is invalid.). - For reasons.code = NARR this field is mandatory minLength: 1 maxLength: 105 title: description method: type: string description: |- Method type - MPNS - for ACH payment - RTGS - for FedWire - RTNS - for CHIPS - RT1 - for SEPA IP payments readOnly: true enum: - MPNS - RTGS - RTNS - RT1 title: method interbank_settlement_date: type: string description: YYYY-MM-DD Intended interbank settlement date format: date readOnly: true title: interbank_settlement_date instructed_amount: type: number description: >- Instructed amount for partial acceptance of return request - Mandatory for ResponseToRequest-For-Refund with decision code as PECR. minimum: 0.01 maximum: 1000000000000000 title: instructed_amount instructed_currency: type: string description: >- Instructed currency for partial acceptance of return request - Mandatory for ResponseToRequest-For-Refund with decision code as PECR enum: - USD - EUR - AUD - ARS - BRL - HKD - CNY title: instructed_currency instruction_id: writeOnly: true type: string description: Unique Instruction id on return payment initiation minLength: 1 maxLength: 35 title: instruction_id end_to_end_id: writeOnly: true type: string description: Unique end to end id on return payment initiation minLength: 1 maxLength: 35 title: end_to_end_id country: writeOnly: true description: |- ISO 3166 Alpha-2 code for the non pay message country. - This field is optional for US - This field is mandatory for SEPA type: string default: US enum: - US - IE - DE - AT - BE - FI - FR - GR - IT - LU - NL - PT - ES - SK - AU - AR - BR - HK - BG title: country network: type: string readOnly: true enum: - RTP - FDN description: >- Financial market infrastructure or clearing system (e.g., RTP Network in the United States) - RTP for TCH - FDN for FedNow title: network debtor: $ref: '#/components/schemas/Debtor-Refund' ultimate_debtor: $ref: '#/components/schemas/Ultimate-Debtor-Refund' status: type: object title: status readOnly: true properties: date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Date time, -, status change date time title: date_time code: type: string description: ISO 20022 message status code enum: - RCVD - RJCT - PDNG title: code description: type: string description: |- Status code description - RJCT - Rejected - RCVD - Received - PDNG - Pending minLength: 1 maxLength: 256 title: description reasons: type: object title: reasons readOnly: true properties: code: type: string description: Reason code (applicable when message is rejected) maxLength: 4 title: code description: type: string description: Reason code description (e.g., Debtor account is invalid.) minLength: 1 maxLength: 256 title: description required: - date_time - code - description return_id: type: string readOnly: true description: >- If other FI wants to return funds outside of RTP, the unique identifier of the transaction used to return the funds must be included in this field - If via ACH, Trace Number must be populated - If via FedWire -- IMAD must be populated - If via CHIPS -- System Sequence Number (SSN) must be populated minLength: 1 maxLength: 35 title: return_id required: - case_id - decision_code - end_to_end_id Final-Request-For-Information-Compliance: title: Final-Request-For-Information-Compliance type: object description: Request For Information Compliance properties: transaction: type: object title: transaction properties: end_to_end_id: type: string description: End to End ID of Original Payment for which RFI is requested minLength: 1 maxLength: 35 title: end_to_end_id uetr: type: string description: 'UETR of Original payment for which RFI is requested ' minLength: 1 maxLength: 36 title: uetr status: type: object title: status properties: date_time: type: string format: date-time description: |- Status Date Time - UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Status change date time. title: date_time code: type: string description: |- ISO 20022 message status code. - PDNG - Pending title: code enum: - PDNG description: type: string description: |- Status code description. - PDNG - Pending minLength: 1 maxLength: 256 title: description required: - date_time reasons: type: object title: reasons properties: code: type: string description: |- Reason code corresponding to the transaction status. - RECI - ReceiverCustomerInformation. title: code enum: - RECI description: type: string description: |- Reason code description. - Transaction is in compliance review request for further information minLength: 1 maxLength: 256 title: description required: - uetr - end_to_end_id rfics: type: object description: Request for Information Compliance title: rfics properties: alert_id: type: string description: 'RFI Alert ID ' minLength: 1 maxLength: 16 title: alert_id request_id: type: string description: 'RFI Request ID ' minLength: 1 maxLength: 16 title: request_id request_date_time: type: string format: date-time description: |- RFI Request Date Time. - Date when RFI request is initiated. title: request_date_time purpose_of_transaction_required: type: string description: 'Purpose Of Transaction ' title: purpose_of_transaction_required enum: - 'Y' - 'N' additional_details_requested: type: string description: 'Additional Details ' minLength: 1 maxLength: 4000 title: additional_details_requested fieldlevel_requests: type: array items: $ref: '#/components/schemas/Field-level-Requests-For-RFICS' description: ' Field level requests for which response is requested' maxItems: 30 title: fieldlevel_requests required: - alert_id - request_id - request_date_time - purpose_of_transaction_required Initial-Response-To-Request-For-Refund: type: object title: InitialResponseToRequestForRefund properties: case_id: type: string description: Case Id received from clearing minLength: 1 maxLength: 35 title: case_id decision_code: type: string description: >- Acceptance or Rejection of return of funds. Only the below 3 codes are applicable - IPAY - Acceptance to Return the payment - RJCR - Decline to Return the payment - PECR - Partially Executed Cancellation Return enum: - ACDA - ACNR - ACVA - CHRG - CNCL - CONF - CVAA - CWFW - FTNA - ICOV - IDUP - IPAY - IPYI - MCOV - MODI - MWFW - PDCR - PECR - PURP - RJCR - RJNR - RJVA - SMTC - SMTI - UWFW - BIAS - IDNE - IVCR - INFO - NINF - PDNG title: decision_code reasons: type: object title: reasons properties: code: type: string description: >- Code of Transaction reasons - If decision_code = RJCR,reasons.code is mandatory for ResponseToRequest-For-Refund enum: - AC04 - ADAC - AGNT - AM04 - ARDT - ARPL - CUST - LEGL - NARR - NOAS - NOOR - PTNA - RQDA - WSEQ - IDMN - ACLR - AEXR - ARFR - ARJR - PATE - RR04 - RCAR - RCNR - RCPR - URTP title: code description: type: string description: |- Reason code description (e.g., Debtor account is invalid.). - For reasons.code = NARR this field is mandatory minLength: 1 maxLength: 105 title: description instructed_amount: type: number description: >- Instructed amount for partial acceptance of return request - Mandatory for ResponseToRequest-For-Refund with decision code as PECR. minimum: 0.01 maximum: 1000000000000000 title: instructed_amount instructed_currency: type: string description: >- Instructed currency for partial acceptance of return request - Mandatory for ResponseToRequest-For-Refund with decision code as PECR enum: - USD - EUR - AUD - ARS - BRL - HKD - CNY title: instructed_currency instruction_id: type: string description: Unique Instruction id on return payment initiation minLength: 1 maxLength: 35 title: instruction_id end_to_end_id: type: string description: Unique end to end id on return payment initiation minLength: 1 maxLength: 35 title: end_to_end_id country: description: |- ISO 3166 Alpha-2 code for the non pay message country. - This field is optional for US - This field is mandatory for SEPA type: string default: US enum: - US - IE - DE - AT - BE - FI - FR - GR - IT - LU - NL - PT - ES - SK - BG title: country status: type: object title: status readOnly: true properties: date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Status change date time title: date_time code: type: string description: ISO 20022 message status code enum: - PDNG title: code description: type: string description: |- Status code description - PDNG - Pending minLength: 1 maxLength: 256 title: description required: - date_time - code - description required: - case_id - decision_code - end_to_end_id Final-Response-To-Payment-Confirmation-Request: type: object title: FinalResponseToPaymentConfirmationRequest description: Outgoing Response to Payment Confirmation Request properties: status: type: object title: status properties: date_time: type: string format: date-time description: UTC (YYYY-MM-DDTHH:MM:SS.sssZ) date time title: date_time code: type: string description: ISO 20022 message status code enum: - ACSC - RJCT title: code description: type: string description: |- Status code description - ACSC - Accepted - RJCT - Rejected minLength: 1 maxLength: 105 title: description required: - date_time - code - description reasons: type: object title: reasons properties: code: type: string description: >- Reason code (mandatory when status is rejected) - For US RPCR, client need to pass reason.code only AC02,AC03,AC04,AC06,AC11,AC13,AC14,AG01,AG03,AM02,AM04,AM09,AM12,AM13,AM14,NARR - For Thailand RPCR, client need to pass reason.code only AM09 or NARR - For SEPA RPCR, client need to pass reason.code only AM05,AC01,AC04,AC06,RR04,AG01,MS03,MS02 enum: - AC02 - AC03 - AC04 - AC06 - AC11 - AC13 - AC14 - AG01 - AG03 - AM02 - AM04 - AM09 - AM12 - AM13 - AM14 - NARR - AM05 - AC01 - RR04 - MS02 - MS03 title: code description: type: string description: >- Reason code description - AC02- Debtor account number invalid or missing - AC03- Creditor account number invalid or missing - AC04- Account number specified has been closed on the bank of account’s books - AC06- Account specified is blocked,prohibiting posting of transactions against it - AC11- Creditor account currency is invalid or missing - AC13- Debtor account type invalid - AC14- Creditor account type invalid - AG01- Transaction forbidden on this type of account (formerly NoAgreement) - AG03- Transaction type not supported / authorized on this account - AM02- Specific transaction/message amount is greater than allowed maximum - AM04- Amount of funds available to cover specified message amount is insufficient - AM09- Amount received is not the amount agreed or expected - AM12- Amount is invalid or missing - AM13- Transaction amount exceeds limits set by clearing system - AM14- Transaction amount exceeds limits agreed between bank and client - NARR- Put the description as per clearing guideline for NARR (if reasons.code is NARR, reasons.decription is mandatory) - AM05- Duplication - AC01- Incorrect Account Number - RR04- Regulatory Reason - MS03- Not Specified Reason Agent Generated - MS02- Not Specified Reason Customer Generated minLength: 1 maxLength: 105 title: description required: - status Initial-Response-To-Request-for-Information-Compliance: type: object title: Initial-Response-To-Request-for-Information-Compliance properties: uetr: type: string description: UETR of Original payment pattern: >- ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ title: uetr status: type: object title: status readOnly: true properties: date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Status change date time title: date_time code: type: string description: ISO 20022 message status code enum: - PDNG title: code description: type: string description: |- Status code description - PDNG - Pending minLength: 1 maxLength: 256 title: description required: - date_time - code - description Initial-Response-To-Payment-Confirmation-Request: type: object title: InitialResponseToPaymentConfirmationRequest properties: uetr: type: string description: UETR of Original payment pattern: >- ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ title: uetr status: type: object title: status readOnly: true properties: date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Status change date time title: date_time code: type: string description: ISO 20022 message status code enum: - PDNG title: code description: type: string description: |- Status code description - PDNG - Pending minLength: 1 maxLength: 256 title: description required: - date_time - code - description Response-To-Payment-Confirmation-Request: type: object title: ResponseToPaymentConfirmationRequest properties: uetr: type: string description: UETR of Original payment pattern: >- ^[a-f0-9]{8}-[a-f0-9]{4}-4[a-f0-9]{3}-[89ab][a-f0-9]{3}-[a-f0-9]{12}$ title: uetr status: type: object title: status readOnly: true properties: date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Date time, -, status change date time title: date_time code: type: string description: ISO 20022 message status code enum: - PDNG - RJCT title: code description: type: string description: |- Status code description - PDNG - Pending - RJCT - Rejected minLength: 1 maxLength: 256 title: description reasons: type: object title: reasons readOnly: true properties: code: type: string description: Reason code (applicable when message is rejected) maxLength: 4 title: code description: type: string description: Reason code description (e.g., Debtor account is invalid.) minLength: 1 maxLength: 256 title: description Request-For-Payment: type: object title: RequestForPayment required: - debtor - creditor - method - transaction description: Request For Payment properties: debtor: $ref: '#/components/schemas/Message-Debtor-Request-For-Payment' ultimate_debtor: $ref: '#/components/schemas/Message-Ultimate-Debtor-Request-For-Payment' creditor: $ref: '#/components/schemas/Message-Creditor-Request-For-Payment' ultimate_creditor: $ref: '#/components/schemas/Message-Ultimate-Creditor-Status' method: $ref: '#/components/schemas/Message-Method-Request-For-Payment' transaction: $ref: '#/components/schemas/Message-Transaction-Request-For-Payment' response_rfp: type: object title: responserfp properties: message_id: type: string description: |- Message Identification of Response to Request For Payment - Mandatory only if message.transaction.status.code = ACSP - Conditional if message.transaction.status.code = ACCC. The condition is -: If a RRFP was initiated , this field is mandatory; if RRFP was not initiated, this field must not be present. maxLength: 35 title: message_id creation_date_time: type: string format: date-time description: >- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) Date time when a message was created for Response to Request For Payment. - Mandatory only if message.transaction.status.code = ACSP - Conditional if message.transaction.status.code = ACCC. The condition is -: If a RRFP was initiated , this field is mandatory; if RRFP was not initiated, this field must not be present. title: creation_date_time end_to_end_id: maxLength: 35 minLength: 1 pattern: ^(?!\s*$).+ type: string description: |- Unique End to end id of Response to Request for Payment - Mandatory only if message.transaction.status.code = ACSP - Conditional if message.transaction.status.code = ACCC. The condition is -: If a RRFP was initiated , this field is mandatory; if RRFP was not initiated, this field must not be present. title: end_to_end_id accepted_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: |- Amount to be paid from Request for Payment. - Mandatory only if message.transaction.status.code = ACSP - Conditional if message.transaction.status.code = ACCC. The condition is -: If a RRFP was initiated , this field is mandatory; if RRFP was not initiated, this field must not be present. title: accepted_amount accepted_currency: type: string description: |- ISO 4217 code for the accepted currency - Mandatory only if message.transaction.status.code = ACSP - Conditional if message.transaction.status.code = ACCC. The condition is -: If a RRFP was initiated , this field is mandatory; if RRFP was not initiated, this field must not be present. enum: - USD title: accepted_currency scheduled_exec_date: type: string format: date description: |- Date payment is expected to be made.Format is YYYY-MM-DD - Mandatory only if message.transaction.status.code = ACSP - Conditional if message.transaction.status.code = ACCC. The condition is -: If a RRFP was initiated , this field is mandatory; if RRFP was not initiated, this field must not be present. title: scheduled_exec_date Response-To-Request-For-Payment: type: object title: ResponseToRequestForPayment description: Response to Request for Payment properties: decision_code: type: string description: |- Acceptance or Rejection of request for payment - ACTC - Acceptance to make requested payment - RJCT - Decline to pay requested amount enum: - ACTC - RJCT title: decision_code end_to_end_id: maxLength: 35 minLength: 1 pattern: ^(?!\s*$).+ type: string description: Unique End to End ID of Response to Request for Payment title: end_to_end_id accepted_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: >- Amount to be paid from Request for Payment.Indicates if Instructed amount in Payment request will be paid, or different amount.If Different amount not allowed by Payment Request, this field must carry Instructed amount - Mandatory if message.decision_code = ACTC title: accepted_amount accepted_currency: type: string description: |- ISO 4217 code for the accepted currency - Mandatory if message.decision_code = ACTC enum: - USD title: accepted_currency scheduled_exec_date: type: string format: date description: |- Date payment is expected to be made.Format is YYYY-MM-DD - Mandatory if message.decision_code = ACTC title: scheduled_exec_date reasons: type: object title: reasons properties: code: type: string description: |- Code of Transaction reasons - Mandatory if message.decision_code = RJCT enum: - AC06 - AG01 - AG03 - AM09 - AM14 - BE04 - BE07 - CH11 - CUST - DS04 - MD07 - NARR - SL12 title: code description: type: string description: |- Description of Transaction reasons - Mandatory if message.reasons.code = NARR minLength: 1 maxLength: 105 title: description debtor: $ref: '#/components/schemas/Debtor-Payment' ultimate_debtor: $ref: '#/components/schemas/Ultimate-Debtor-Payment' status: type: object title: status readOnly: true properties: date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Status change date time title: date_time code: type: string description: ISO 20022 message status code enum: - RCVD - RJCT - PDNG title: code description: type: string description: |- Status code description - RCVD - Received - RJCT - Rejected - PDNG - Pending minLength: 1 maxLength: 256 title: description reasons: type: object title: reasons readOnly: true properties: code: type: string description: Reason code (applicable when message is rejected) maxLength: 4 title: code description: type: string description: Reason code description (e.g., Debtor account is invalid.) minLength: 1 maxLength: 256 title: description required: - date_time - code - description required: - decision_code - end_to_end_id - payment_information_id Initial-Response-To-Request-For-Payment: type: object title: InitialResponseToRequestForPayment 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 reference generated in outgoing payment title: uetr decision_code: type: string description: |- Acceptance or Rejection of request for payment - ACTC - Acceptance to make requested payment - RJCT - Decline to pay requested amount enum: - ACTC - RJCT title: decision_code end_to_end_id: maxLength: 35 minLength: 1 pattern: ^(?!\s*$).+ type: string description: Unique End to End ID of Response to Request for Payment title: end_to_end_id accepted_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: >- Amount to be paid from Request for Payment.Indicates if Instructed amount in Payment request will be paid, or different amount.If Different amount not allowed by Payment Request, this field must carry Instructed amount - Mandatory if message.decision_code = ACTC title: accepted_amount accepted_currency: type: string description: |- ISO 4217 code for the accepted currency - Mandatory if message.decision_code = ACTC enum: - USD title: accepted_currency scheduled_exec_date: type: string format: date description: |- Date payment is expected to be made.Format is YYYY-MM-DD - Mandatory if message.decision_code = ACTC title: scheduled_exec_date reasons: type: object title: reasons properties: code: type: string description: |- Code of Transaction reasons - Mandatory if message.decision_code = RJCT enum: - AC06 - AG01 - AG03 - AM09 - AM14 - BE04 - BE07 - CH11 - CUST - DS04 - MD07 - NARR - SL12 title: code description: type: string description: |- Description of Transaction reasons - Mandatory if message.reasons.code = NARR minLength: 1 maxLength: 105 title: description debtor: $ref: '#/components/schemas/Debtor-Payment' ultimate_debtor: $ref: '#/components/schemas/Ultimate-Debtor-Payment' status: type: object title: status readOnly: true properties: date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Status change date time title: date_time code: type: string description: ISO 20022 message status code enum: - PDNG title: code description: type: string description: |- Status code description - PDNG - Pending minLength: 1 maxLength: 256 title: description required: - date_time - code - description required: - decision_code - end_to_end_id - payment_information_id Outgoing-Request-For-Refund: type: object title: OutgoingRequestForRefund description: Outgoing Request For Refund properties: reasons: type: object title: reasons properties: code: type: string description: >- Code of Transaction reasons - For US RTP the applicable reason.code are (AC03,AM09,CUST,DUPL,FRAD,FRTR,TECH,UPAY) - For AU the applicable reason.code are (DUPL,AGNT,CURR,CUST,UPAY,CUTA,TECH,FRAD) - DUPL DuplicatePayment - BIAS BatchInstructionAlreadySettled - DRTP DuplicationRequestToPay - WNTB WarrantyBreach - MD06 RefundRequestByEndCustomer - UAPA UnauthorizedPayment - PAID TransactionAlreadyPaid - SVNR ServiceNotRendered - SYAD RequestToSettlementSystemAdministrator - ENUE EndUserError - NARR Narrative - INCR InvalidCancellationRequest - BE16 InvalidDebtorIdentificationCode - COVR CoverCancelledOrReturned - CURR IncorrectCurrency - CUTA CancelUponUnableToApply - DT01 InvalidDate - FRNA ForwardToNextAgent - INDM IndemnityRequired - MODT ModifiedTransaction - AC03 InvalidCreditorAccountNumber - AM09 WrongAmount - CUST RequestedByCustomerDUPL - FRAD FraudulentOrigin - FRTR FinalResponse - TECH TechnicalProblem - UPAY UnduePayment - AC02 InvalidDebtorAccountNumber - AGNT IncorrectAgent enum: - AC03 - AM09 - CUST - DUPL - FRAD - FRTR - TECH - UPAY - UAPA - AGNT - CURR - CUTA - AC02 - BE16 - COVR - DT01 - FRNA - INDM - MODT - PAID - SVNR - SYAD - ENUE - NARR - INCR - BIAS - DRTP - WNTB - MD06 title: code description: type: string description: >- Description of Transaction reasons. - For RFP warranty claim, the following codes/ warranty component may be used.The client may populate the code and warranty component, OR code, comma, free form text - N: No Legitimate Purpose - F: Part of Fraudulent Scheme to Induce Payment - H: Harassing - U: Otherwise Unlawful minLength: 1 maxLength: 105 title: description required: - code country: writeOnly: true description: >- The ISO 3166 Alpha-2 code for the non-payment message country should correspond to the originator’s payment initiation country code. - This field is optional for US - This field is mandatory for SEPA type: string default: US enum: - US - IE - DE - AT - BE - FI - FR - GR - IT - LU - NL - PT - ES - SK - GB - AU - IN - AR - BR - HK - BG title: country Incoming-Request-For-Refund: type: object title: IncomingRequestForRefund description: Incoming Request For Refund properties: reasons: type: object title: reasons properties: code: type: string description: >- Code of Transaction reasons - For US RTP the applicable reason.code are (AC03,AM09,CUST,DUPL,FRAD,FRTR,TECH,UPAY) - AC03 InvalidCreditorAccountNumber - AM09 WrongAmount - CUST Requested by Customer - DUPL DuplicatePayment - FRAD FraudulentOrigin - FRTR FinalResponse - TECH TechnicalProblem - UPAY UnduePayment - UAPA Customer claims Credit Transfer is fraudulently induced enum: - AC03 - AM09 - CUST - DUPL - FRAD - FRTR - TECH - UPAY - UAPA title: code description: type: string description: >- Description of Transaction reasons. - For RFP warranty claim, the following codes/ warranty component may be used.The client may populate the code and warranty component, OR code, comma, free form text - N: No Legitimate Purpose - F: Part of Fraudulent Scheme to Induce Payment - H: Harassing - U: Otherwise Unlawful minLength: 1 maxLength: 105 title: description required: - code Response-To-Request-For-Information-Compliance: title: Response-To-Request-For-Information-Compliance type: object description: Response to Request for Information Compliance properties: rrfics: type: object description: Response to Request for Information Compliance title: rrfics properties: alert_id: type: string description: RFI Alert ID. minLength: 1 maxLength: 16 title: alert_id request_id: type: string description: 'RFI Request ID. ' minLength: 1 maxLength: 16 title: request_id response_date_time: type: string format: date-time description: RFI Response Date Time. title: response_date_time purpose_of_transaction: type: string description: Purpose Of Transaction. minLength: 1 maxLength: 140 title: purpose_of_transaction additional_details: type: string description: Additional Details. minLength: 1 maxLength: 140 title: additional_details fieldlevel_responses: type: array items: $ref: '#/components/schemas/Field-level-Responses-For-RRFICS' description: ' This block will contain 3 fields (id, name,value) and at least 1 field from the input type for which response is provided.' maxItems: 30 title: fieldlevel_responses required: - alert_id - request_id - response_date_time required: - uetr Initial-Outgoing-Request-For-Refund: type: object title: InitialOutgoingRequestForRefund properties: reasons: type: object title: reasons properties: code: type: string description: |- Code of Transaction reasons - AC03 InvalidCreditorAccountNumber - AM09 WrongAmount - CUST Requested by Customer - DUPL DuplicatePayment - FRAD FraudulentOrigin - FRTR FinalResponse - TECH TechnicalProblem - UPAY UnduePayment - UAPA Customer claims Credit Transfer is fraudulently induced enum: - AC03 - AM09 - CUST - DUPL - FRAD - FRTR - TECH - UPAY - AC02 - UAPA - AGNT - BE16 - COVR - CURR - CUTA - DT01 - FRNA - INDM - MODT - PAID - SVNR - SYAD - ENUE - NARR - INCR - BIAS - DRTP - WNTB - MD06 title: code description: type: string description: >- Description of Transaction reasons. - For RFP warranty claim, the following codes/ warranty component may be used.The client may populate the code and warranty component, OR code, comma, free form text - N: No Legitimate Purpose - F: Part of Fraudulent Scheme to Induce Payment - H: Harassing - U: Otherwise Unlawful minLength: 1 maxLength: 105 title: description required: - code country: description: |- ISO 3166 Alpha-2 code for the non pay message country. - This field is optional for US - This field is mandatory for SEPA type: string default: US enum: - US - IE - DE - AT - BE - FI - FR - GR - IT - LU - NL - PT - ES - SK - GB - AU - IN - AR - BR - BG - HK title: country status: type: object title: status readOnly: true properties: date_time: type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Status change date time title: date_time code: type: string description: ISO 20022 message status code enum: - PDNG title: code description: type: string description: |- Status code description - PDNG - Pending minLength: 1 maxLength: 256 title: description required: - date_time - code - description Original-Debtor: type: object title: OriginalDebtor properties: bank_id: minLength: 1 maxLength: 35 type: string description: Debtor Bank ID of Original Payment title: bank_id name: minLength: 1 maxLength: 140 type: string description: Name of Debtor from Original Payment title: name street_name: minLength: 1 maxLength: 70 type: string description: Street Name of Debtor address from Original Payment title: street_name building_number: minLength: 1 maxLength: 16 type: string description: Debtor Building number of Original Payment title: building_number postal_code: minLength: 1 maxLength: 16 type: string description: Debtor Postal code of Original Payment title: postal_code city: minLength: 1 maxLength: 35 type: string description: City of Debtor from Original Payment title: city state: minLength: 1 maxLength: 35 type: string description: State of Debtor from Original Payment title: state country: maxLength: 2 type: string description: Country of Debtor from Original Payment title: country address_lines: type: array description: >- Debtor Address lines of Original Payment which is array of 7 lines and each line has maximum 70 characters items: $ref: '#/components/schemas/Address' title: address_lines org_id: minLength: 1 maxLength: 35 type: string description: Debtor Org ID of Original Payment title: org_id birth_date: type: string format: date description: Debtor Birth date of Original Payment.Format is YYYY-MM-DD title: birth_date birth_city: minLength: 1 maxLength: 35 type: string description: Debtor Birth city of Original Payment title: birth_city birth_country: maxLength: 2 type: string description: Debtor Birth country of Original Payment title: birth_country proxy_id: maxLength: 255 minLength: 1 type: string description: >- Debtor's proxy identification (e.g., email address) of original payment 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) of original payment title: proxy_type account: maxLength: 40 minLength: 1 type: string description: Debtor's bank account of original payment title: account birth_province: maxLength: 35 minLength: 1 type: string description: ' Debtor Province Of Birth of original payment' title: birth_province prvt_id: maxLength: 35 minLength: 1 type: string description: Debtor's private id of original payment title: prvt_id department: maxLength: 70 minLength: 1 type: string description: 'debtor Address Department of original payment ' title: department sub_department: maxLength: 70 minLength: 1 type: string description: debtor Address Sub-Department of original payment title: sub_department building_name: maxLength: 35 minLength: 1 type: string description: 'debtor building name of original payment ' title: building_name floor: maxLength: 70 minLength: 1 type: string description: debtor address floor of original payment title: floor post_box: maxLength: 16 minLength: 1 type: string description: 'debtor address post box of original payment ' title: post_box room: maxLength: 70 minLength: 1 type: string description: debtor address room of original payment title: room town_location_name: maxLength: 35 minLength: 1 type: string description: 'debtor address town location name of original payment ' title: town_location_name district_name: maxLength: 35 minLength: 1 type: string description: 'debtor address district_name of original payment ' title: district_name anybic: maxLength: 35 minLength: 1 type: string description: 'debtor BIC of original payment ' title: anybic lei: maxLength: 35 minLength: 1 type: string description: >- Unique global identifier for legal entities participating in financial transactions of original payment title: lei issuer: maxLength: 35 minLength: 1 type: string description: 'debtor name that identifies an issuer of original payment ' title: issuer scheme_name: maxLength: 128 minLength: 1 type: string description: Debtor's scheme name of original payment title: scheme_name Original-Creditor: type: object title: OriginalCreditor properties: bank_id: minLength: 1 maxLength: 35 type: string description: Bank Id of Creditor from original payment title: bank_id name: minLength: 1 maxLength: 140 type: string description: Name of Creditor from Original Payment title: name street_name: minLength: 1 maxLength: 70 type: string description: Creditor Street name of Original Payment title: street_name building_number: minLength: 1 maxLength: 16 type: string description: Creditor Building number of Original Payment title: building_number postal_code: minLength: 1 maxLength: 16 type: string description: Creditor Postal code of Original Payment title: postal_code city: minLength: 1 maxLength: 35 type: string description: City of Creditor from Original Payment title: city state: minLength: 1 maxLength: 35 type: string description: State of Creditor from Original Payment title: state country: maxLength: 2 type: string description: Country of Creditor from Original Payment title: country address_lines: type: array description: >- Creditor Address lines of Original Payment which is an array of 7 lines and each line has maximum 70 characters items: $ref: '#/components/schemas/Address' title: address_lines org_id: minLength: 1 maxLength: 35 type: string description: Creditor Org ID of Original Payment title: org_id birth_date: type: string format: date description: Creditor Birth date of Original Payment.Format is YYYY-MM-DD title: birth_date birth_city: minLength: 1 maxLength: 35 type: string description: Creditor Birth city of Original Payment title: birth_city birth_country: maxLength: 2 type: string description: Creditor Birth country of Original Payment title: birth_country proxy_id: maxLength: 255 minLength: 1 type: string description: >- Creditor's proxy identification (e.g., email address) of original payment title: proxy_id proxy_type: type: string enum: - BIID - EMAL - EWAL - MBNO - NIDN - COTS - IBAN - PAYR 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) of original payment title: proxy_type account: maxLength: 40 minLength: 1 type: string description: 'Creditor''s bank account of original payment ' title: account prvt_id: maxLength: 35 minLength: 1 type: string description: 'Creditor''s prvt_id of original payment ' title: prvt_id birth_province: maxLength: 35 minLength: 1 type: string description: 'Creditor''s Province Of Birth of original payment ' title: birth_province department: maxLength: 70 minLength: 1 type: string description: 'creditor Address Department of original payment ' title: department sub_department: maxLength: 70 minLength: 1 type: string description: creditor Address Sub-Department of original payment title: sub_department building_name: maxLength: 35 minLength: 1 type: string description: 'creditor building name of original payment ' title: building_name floor: maxLength: 70 minLength: 1 type: string description: creditor address floor of original payment title: floor post_box: maxLength: 16 minLength: 1 type: string description: 'creditor address post box of original payment ' title: post_box room: maxLength: 70 minLength: 1 type: string description: 'creditor address room of original payment ' title: room town_location_name: maxLength: 35 minLength: 1 type: string description: 'creditor address town location name of original payment ' title: town_location_name district_name: maxLength: 35 minLength: 1 type: string description: 'creditor address district_name of original payment ' title: district_name anybic: maxLength: 35 minLength: 1 type: string description: 'creditor BIC of original payment ' title: anybic lei: maxLength: 35 minLength: 1 type: string description: >- Unique global identifier for legal entities participating in financial transactions of original payment title: lei issuer: maxLength: 35 minLength: 1 type: string description: 'creditor name that identifies an issuer of original payment ' title: issuer scheme_name: maxLength: 128 minLength: 1 type: string description: Creditor's scheme name of original payment title: scheme_name Original-Ultimate-Debtor: type: object title: OriginalUltimateDebtor properties: name: maxLength: 140 minLength: 1 type: string description: 'Ultimate Debtor''s bank account name of original payment ' title: name org_id: maxLength: 35 minLength: 1 type: string description: Ultimate Debtor's org_id of original payment title: org_id birth_date: type: string format: date description: >- ISO 8601 (YYYY-MM-DD), ultimate debtor's birth date of original payment title: birth_date birth_city: maxLength: 35 minLength: 1 type: string description: 'Ultimate debtor''s birth city of original payment ' title: birth_city birth_country: type: string description: 'Ultimate debtor''s birth country of original payment ' pattern: ^[A-Z]{2,2}$ title: birth_country birth_province: maxLength: 35 minLength: 1 type: string description: 'Ultimate Debtor Province Of Birth of original payment ' title: birth_province prvt_id: maxLength: 35 minLength: 1 type: string description: 'Ultimate Debtor''s private id of original payment ' title: prvt_id anybic: maxLength: 35 minLength: 1 type: string description: 'ultimate debtor''s BIC of original payment ' title: anybic lei: maxLength: 35 minLength: 1 type: string description: >- Unique global identifier for legal entities participating in financial transactions of original payment title: lei issuer: maxLength: 35 minLength: 1 type: string description: >- ultimate debtor's name that identifies an issuer of original payment title: issuer scheme_name: maxLength: 128 minLength: 1 type: string description: Ultimate Debtor's scheme name of original payment title: scheme_name Original-Ultimate-Creditor: type: object title: OriginalUltimateCreditor properties: name: maxLength: 140 minLength: 1 type: string description: 'Ultimate Creditor''s bank account name of original payment ' title: name org_id: maxLength: 35 minLength: 1 type: string description: Ultimate Creditor's org_id of original payment title: org_id birth_date: type: string format: date description: >- ISO 8601 (YYYY-MM-DD), ultimate creditor's birth date of original payment title: birth_date birth_city: maxLength: 35 minLength: 1 type: string description: 'Ultimate Creditor''s birth city of original payment ' title: birth_city birth_country: type: string description: 'Ultimate Creditor''s birth country of original payment ' pattern: ^[A-Z]{2,2}$ title: birth_country birth_province: maxLength: 35 minLength: 1 type: string description: 'Ultimate Creditor Province Of Birth of original payment ' title: birth_province prvt_id: maxLength: 35 minLength: 1 type: string description: 'Ultimate Creditor''s private id of original payment ' title: prvt_id anybic: maxLength: 35 minLength: 1 type: string description: 'ultimate Creditor''s BIC of original payment ' title: anybic lei: maxLength: 35 minLength: 1 type: string description: >- Unique global identifier for legal entities participating in financial transactions of original payment title: lei issuer: maxLength: 35 minLength: 1 type: string description: >- ultimate Creditor's name that identifies an issuer of original payment title: issuer scheme_name: maxLength: 128 minLength: 1 type: string description: Ultimate Creditor's scheme name of original payment title: scheme_name Debtor-Refund: type: object title: DebtorRefund properties: name: minLength: 1 maxLength: 140 type: string description: >- Name of Debtor to be passed for Refund payment - For United States debtor.name field is mandatory for decision code IPAY and PECR - For Thailand debtor.name field is not applicable - For Brazil debtor.name field is not applicable - For SEPA debtor.name field is not applicable title: name street_name: minLength: 1 maxLength: 70 type: string description: |- Street Name of Debtor to be passed for Refund payment - For United States debtor.street_name field is optional - For Thailand debtor.street_name field is not applicable - For Brazil debtor.street_name field is not applicable - For SEPA debtor.street_name field is not applicable title: street_name building_number: minLength: 1 maxLength: 16 type: string description: |- Building number of Debtor to be passed for Refund payment - For United States debtor.building_number field is optional - For Thailand debtor.building_number field is not applicable - For Brazil debtor.building_number field is not applicable - For SEPA debtor.building_number field is not applicable title: building_number postal_code: minLength: 1 maxLength: 16 type: string description: |- Postal code of Debtor to be passed for Refund payment - For United States debtor.postal_code field is optional - For Thailand debtor.postal_code field is not applicable - For Brazil debtor.postal_code field is not applicable - For SEPA debtor.postal_code field is not applicable title: postal_code city: minLength: 1 maxLength: 35 type: string description: |- City of Debtor to be passed for Refund payment - For United States debtor.city field is optional - For Thailand debtor.city field is not applicable - For Brazil debtor.city field is not applicable - For SEPA debtor.city field is not applicable title: city state: minLength: 1 maxLength: 35 type: string description: |- State of Debtor to be passed for Refund payment - For United States debtor.state field is optional - For Thailand debtor.state field is not applicable - For Brazil debtor.state field is not applicable - For SEPA debtor.state field is not applicable title: state country: type: string description: |- Country of Debtor to be passed for Refund payment - For United States debtor.country field is optional - For Thailand debtor.country field is not applicable - For Brazil debtor.country field is not applicable - For SEPA debtor.country field is not applicable pattern: ^[A-Z]{2,2}$ title: country address_lines: type: array minItems: 1 maxItems: 7 description: >- Debtor Address lines which is array of 7 lines and each line has maximum 70 characters which is to be passed for Refund payment - For United States debtor.address_lines field is optional - For Thailand debtor.address_lines field is not applicable - For Brazil debtor.address_lines field is not applicable - For SEPA debtor.address_lines field is not applicable items: $ref: '#/components/schemas/Address' title: address_lines Ultimate-Debtor-Refund: type: object title: UltimateDebtorRefund properties: name: minLength: 1 maxLength: 140 type: string description: |- Name of Ultimate Debtor to be passed for Refund payment - For United States ultimate_debtor.name field is optional - For Thailand ultimatedebtor.name field is not applicable - For Brazil ultimatedebtor.name field is not applicable - For SEPA ultimate_debtor.name field is not applicable title: name street_name: minLength: 1 maxLength: 70 type: string description: |- Street Name of Ultimate Debtor to be passed for Refund payment - For United States ultimate_debtor.street_name field is optional - For Thailand ultimatedebtor.street_name field is not applicable - For Brazil ultimatedebtor.street_name field is not applicable - For SEPA ultimate_debtor.street_name field is not applicable title: street_name building_number: minLength: 1 maxLength: 16 type: string description: >- Building number of Ultimate Debtor to be passed for Refund payment - For United States ultimate_debtor.building_number field is optional - For Thailand ultimatedebtor.building_number field is not applicable - For Brazil ultimatedebtor.building_number field is not applicable - For SEPA ultimate_debtor.building_number field is not applicable title: building_number postal_code: minLength: 1 maxLength: 16 type: string description: |- Postal code of Ultimate Debtor to be passed for Refund payment - For United States ultimate_debtor.postal_code field is optional - For Thailand ultimatedebtor.postal_code field is not applicable - For Brazil ultimatedebtor.postal_code field is not applicable - For SEPA ultimate_debtor.postal_code field is not applicable title: postal_code city: minLength: 1 maxLength: 35 type: string description: |- City of Ultimate Debtor to be passed for Refund payment - For United States ultimate_debtor.city field is optional - For Thailand ultimatedebtor.city field is not applicable - For Brazil ultimatedebtor.city field is not applicable - For SEPA ultimate_debtor.city field is not applicable title: city state: minLength: 1 maxLength: 35 type: string description: |- State of Ultimate Debtor to be passed for Refund payment - For United States ultimate_debtor.state field is optional - For Thailand ultimatedebtor.state field is not applicable - For Brazil ultimatedebtor.state field is not applicable - For SEPA ultimate_debtor.state field is not applicable title: state country: type: string description: |- Country of Ultimate Debtor to be passed for Refund payment - For United States ultimate_debtor.country field is optional - For Thailand ultimatedebtor.country field is not applicable - For Brazil ultimatedebtor.country field is not applicable - For SEPA ultimate_debtor.country field is not applicable pattern: ^[A-Z]{2,2}$ title: country address_lines: type: array minItems: 1 maxItems: 7 description: >- Ultimate Debtor Address lines which is array of 7 lines and each line has maximum 70 characters which is to be passed for Refund payment - For United States ultimate_debtor.address_lines field is optional - For Thailand ultimatedebtor.address_lines field is not applicable - For Brazil ultimatedebtor.address_lines field is not applicable - For SEPA ultimate_debtor.address_lines field is not applicable items: $ref: '#/components/schemas/Address' title: address_lines Message-Creditor-Status: type: object title: MessageCreditorStatus properties: proxy_id: type: string maxLength: 128 minLength: 1 description: |- Creditor's proxy identification (e.g., email address) - For US creditor.proxy_id field is not applicable title: proxy_id proxy_type: type: string enum: - BIID - EMAL - EWAL - MBNO - NIDN description: >- Creditor'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) - For US creditor.proxy_type field is not applicable title: proxy_type tax_id: maxLength: 128 minLength: 1 type: string description: |- Creditor's tax identification - For US creditor.tax_id field is not applicable title: tax_id account: maxLength: 40 minLength: 1 type: string description: Creditor's bank account title: account account_name: maxLength: 140 minLength: 1 type: string description: Creditor Account name, different from the Creditor Name title: account_name virtual_account: maxLength: 40 minLength: 1 type: string description: |- Creditor's virtual account (also kown as PAYER ID) - For US creditor.virtual_account field is not applicable title: virtual_account name: maxLength: 140 minLength: 1 type: string description: Creditor's name title: name address_lines: type: array description: Creditor's address_lines items: $ref: '#/components/schemas/Address' title: address_lines street_name: maxLength: 70 minLength: 1 type: string description: 'Creditor''s street_name ' title: street_name building_number: maxLength: 16 minLength: 1 type: string description: Creditor's building_number title: building_number postal_code: maxLength: 16 minLength: 1 type: string description: Creditor's postal_code title: postal_code city: maxLength: 35 minLength: 1 type: string description: Creditor's city title: city state: maxLength: 35 minLength: 1 type: string description: Creditor's state title: state country: type: string description: Creditor's country pattern: ^[A-Z]{2,2}$ title: country org_id: maxLength: 20 minLength: 1 type: string description: Creditor's org_id title: org_id birth_date: type: string format: date description: ISO 8601 (YYYY-MM-DD), Creditor's birth_date title: birth_date birth_city: maxLength: 35 minLength: 1 type: string description: 'Creditor''s birth_city ' title: birth_city birth_country: type: string description: Creditor's birth_country pattern: ^[A-Z]{2,2}$ title: birth_country bank_id: maxLength: 35 minLength: 1 type: string description: Creditor Bank ID title: bank_id bank_branch_id: maxLength: 16 minLength: 1 type: string description: 'Creditor Bank Branch ID ' title: bank_branch_id Message-Debtor-Status: type: object title: MessageDebtorStatus properties: proxy_id: type: string maxLength: 128 minLength: 1 description: |- Debtor's proxy identification (e.g., email address) - For US debtor.proxy_id field is not applicable 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) - For US debtor.proxy_type is not applicable title: proxy_type tax_id: maxLength: 128 minLength: 1 type: string description: |- Debtor's tax identification - For US debtor.tax_id is not applicable title: tax_id account: maxLength: 40 minLength: 1 type: string description: Debtor's bank account title: account account_name: maxLength: 140 minLength: 1 type: string description: Debtor Account name, different from the Debtor Name title: account_name virtual_account: maxLength: 40 minLength: 1 type: string description: |- Debtor's virtual account - For US debtor.virtual_account field is not applicable title: virtual_account name: maxLength: 140 minLength: 1 type: string description: 'Debtor''s bank account name ' title: name address_lines: type: array description: Debtor's address_lines items: $ref: '#/components/schemas/Address' title: address_lines street_name: maxLength: 70 minLength: 1 type: string description: 'Debtor''s street_name ' title: street_name building_number: maxLength: 16 minLength: 1 type: string description: Debtor's building_number title: building_number postal_code: maxLength: 16 minLength: 1 type: string description: Debtor's postal_code title: postal_code city: maxLength: 35 minLength: 1 type: string description: Debtor's City title: city state: maxLength: 35 minLength: 1 type: string description: Debtor's State title: state country: type: string description: Debtor's Country pattern: ^[A-Z]{2,2}$ title: country org_id: maxLength: 20 minLength: 1 type: string description: Debtor's org_id title: org_id birth_date: type: string format: date description: 'ISO 8601 (YYYY-MM-DD), Debtor''s birth_date ' title: birth_date birth_city: maxLength: 35 minLength: 1 type: string description: Debtor's birth_city title: birth_city birth_country: type: string description: Debtor's birth_country pattern: ^[A-Z]{2,2}$ title: birth_country bank_id: maxLength: 35 minLength: 1 type: string description: Instructing Agent member Identification ID of a clearing system title: bank_id bank_branch_id: maxLength: 16 minLength: 1 type: string description: Debtor Bank branch ID title: bank_branch_id Message-Ultimate-Debtor-Status: type: object title: MessageUltimateDebtorStatus properties: name: maxLength: 140 minLength: 1 type: string description: Name of the ultimate debtor title: name address_lines: type: array description: Ultimate Debtor's address_lines items: $ref: '#/components/schemas/Address' title: address_lines street_name: maxLength: 70 minLength: 1 type: string description: Ultimate Debtor's street_name title: street_name building_number: maxLength: 16 minLength: 1 type: string description: Ultimate Debtor's building_number title: building_number postal_code: maxLength: 16 minLength: 1 type: string description: Ultimate Debtor's postal_code title: postal_code city: maxLength: 35 minLength: 1 type: string description: Ultimate Debtor's city title: city state: maxLength: 35 minLength: 1 type: string description: 'Ultimate Debtor''s state ' title: state country: type: string description: Ultimate Debtor's country pattern: ^[A-Z]{2,2}$ title: country Message-Ultimate-Creditor-Status: type: object title: MessageUltimateCreditorStatus properties: name: maxLength: 140 minLength: 1 type: string description: Ultimate Creditor's bank account name title: name address_lines: type: array description: Ultimate Creditor's address_lines items: $ref: '#/components/schemas/Address' title: address_lines street_name: maxLength: 70 minLength: 1 type: string description: Ultimate Creditor's street_name title: street_name building_number: maxLength: 16 minLength: 1 type: string description: Ultimate Creditor's building_number title: building_number postal_code: maxLength: 16 minLength: 1 type: string description: Ultimate Creditor's postal_code title: postal_code city: maxLength: 35 minLength: 1 type: string description: Ultimate Creditor's city title: city state: maxLength: 35 minLength: 1 type: string description: Ultimate Creditor's state title: state country: type: string description: Ultimate Creditor's country pattern: ^[A-Z]{2,2}$ title: country Message-Method-Status: type: object title: MessageMethodStatus required: - country - instructed_currency - method - type properties: country: description: ISO 3166 Alpha-2 code for the transaction country type: string enum: - US title: country instructed_currency: type: string description: ISO 4217 code for the transaction instructed amount currency enum: - USD - EUR - ARS - BRL title: instructed_currency method: description: >- Method specified by the debtor for the transaction \n- Provide IP for instant payment type: string enum: - IP title: method type: type: string description: >- Transaction message type (e.g., CT for credit transfer. RF for Refund) - CT - Credit Transfer - RF - Return payment - BK_CT - Book to Book Credit Transfer - BK_RF - Book to Book Return Payment enum: - CT - RF - BK_CT - BK_RF title: type network: type: string enum: - RTP - ZELLE - FDN description: >- Financial market infrastructure or clearing system (e.g., RTP Network in the United States) - RTP for TCH - FDN for FedNow title: network Message-Transaction-Status: type: object title: MessageTransactionStatus required: - uetr - type - instructed_amount - creation_date_time - value_date - settlement_currency - settlement_amount properties: end_to_end_id: maxLength: 35 minLength: 1 pattern: ^(?!\s*$).+ type: string description: Specifies a character string with a maximum length of 35 characters title: end_to_end_id instruction_id: type: string maxLength: 35 minLength: 1 description: Instruction Id 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 for or by the network 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 title: local_reference batch_id: maxLength: 35 minLength: 1 type: string description: |- Identification for the bulk debit or credit posting to Citi account - For SEPA, transaction.batch_id field is optional and allwed maxLength is 35 title: batch_id bill_id_1: maxLength: 128 pattern: ^[0-9A-Z]{1,128}$ type: string description: |- Bill identification for a bill payment - For US 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 for a bill payment - For US 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 for a bill payment - For US transaction.bill_id_3 field is not applicable title: bill_id_3 type: type: string description: Transaction Type - Debit or Credit enum: - credit - debit title: type purpose: type: string enum: - CNFL - PAYR - OTHR - CASH - GP2P - SCVE - GDDS - GDSV - SALA - SUPP - RCPT - COST - TREA - REFU description: >- Purpose of a transaction - CASH for cash management - CNFL for confidential - COST for payment for business expenses - GDDS for payment related to purchase or sale of goods - GDSV for payment related to purchase or sale of goods and services - GP2P for person-to-person payment - OTHR for other, if your payment doesn't fit any of the specific purpose codes - PAYR for payroll payment - RCPT for payment of a receipt - SALA for salary payment - SCVE for payment related to purchase or sale of services - SUPP for supplier payment - TREA for treasury payment - REFU for refund payment title: purpose tax_code: type: number enum: - 0 - 1 description: |- Tax code - For US transaction.tax_code field is not applicable title: tax_code wht_code: type: string enum: - A - S - B description: |- Withholding tax (WHT) code - For US transaction.wht_code field is not applicable title: wht_code income_type: type: string pattern: ^(00[0-9]|01[0-2])$ description: |- Income type - For US transaction.income_type field is not applicable title: income_type vat_rate: type: number minimum: 0 description: |- Value-added tax (VAT) rate - For US transaction.vat_rate field is not applicable title: vat_rate vat_amount: type: number maximum: 1000000000000000 description: |- Value-added tax (VAT) amount - For US transaction.vat_amount field is not applicable title: vat_amount wht_rate: type: number minimum: 0 description: |- Withholding tax (WHT) rate (0 - 99.99) - For US transaction.wht_rate field is not applicable title: wht_rate wht_amount: type: number maximum: 1000000000000000 description: |- Withholding tax (WHT) amount - For US transaction.wht_amount field is not applicable title: wht_amount bill_due_date: type: string format: date description: |- ISO 8601 (YYYY-MM-DD) bill due date - For US transaction.bill_due_date 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) - Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation - 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 ) when Citi's transaction processing application starts processing a transaction title: value_date instructed_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: Amount instructed by client for a transaction 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 interbank_settlement_date: type: string format: date description: >- Interbank settlement Date received from clearing (TCH) Format is YYYY-MM-DD title: interbank_settlement_date unstructured_remittance_info: type: array description: |- Unstructured remitance information - For US transaction.unstructured_remittance_info field maximum length is 140 and unlimited line is allowed - For SEPA, transaction.unstructured_remittance_info field is optional and maxLength is 140 items: $ref: '#/components/schemas/Unstructured' title: unstructured_remittance_info advice_id: type: string description: Remittance identifier maxLength: 35 minLength: 1 title: advice_id advice_type: type: string description: Method use to deliver the remittance advice information enum: - EMAL - FAXI - SMSM - URID title: advice_type advice_address: type: string maxLength: 2048 minLength: 1 description: Address to send remittance details title: advice_address category: type: string maxLength: 35 minLength: 1 description: |- Specifies the high level purpose of the instruction - For US TCH - CONUSMER, BUSINESS - For US Fednow - CONS, BIZZ,GOVT - CONS for credit transfers initiated by a consumer - BIZZ for credit transfers initiated by a business entity - GOVT for credit transfers initiated by a government agency title: category original_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: >- Amount that was originally sent by our client. - For Thailand PromptPay transaction.original_amount field is not applicable - For United States transaction.original_amount field is optional - For IN IMPS transaction.original_amount field is not applicable - For UK FPS Instant payment transaction.original_amount 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 - For Thailand PromptPay transaction.full_amount field is not applicable - For United States transaction.full_amount field is optional - For IN IMPS transaction.full_amount field is not applicable - For UK FPS Instant payment transaction.full_amount 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 - For Thailand PromptPay transaction.discount_amount field is not applicable - For United States transaction.discount_amount field is optional - For IN IMPS transaction.discount_amount field is not applicable - For UK FPS Instant payment transaction.discount_amount field is not applicable title: discount_amount Message-Debtor-Request-For-Payment: type: object title: MessageDebtorRequestForPayment properties: account: maxLength: 40 minLength: 1 type: string description: Debtor Account ID title: account account_name: maxLength: 140 minLength: 1 type: string description: Debit Account name, different from the Debtor Name title: account_name name: maxLength: 140 minLength: 1 type: string description: Debtor Name title: name bank_id: maxLength: 16 minLength: 1 type: string description: Instructing Agent member Identification ID of a clearing system title: bank_id address_lines: type: array description: Debtor's address_lines items: $ref: '#/components/schemas/Address' title: address_lines street_name: maxLength: 70 minLength: 1 type: string description: 'Debtor''s street_name ' title: street_name building_number: maxLength: 16 minLength: 1 type: string description: Debtor's building_number title: building_number postal_code: maxLength: 16 minLength: 1 type: string description: Debtor's postal_code title: postal_code city: maxLength: 35 minLength: 1 type: string description: Debtor's City title: city state: maxLength: 35 minLength: 1 type: string description: Debtor's State title: state country: type: string description: Debtor's Country pattern: ^[A-Z]{2,2}$ title: country org_id: maxLength: 20 minLength: 1 type: string description: Debtor's org_id title: org_id birth_date: type: string format: date description: 'ISO 8601 (YYYY-MM-DD), Debtor''s birth_date ' title: birth_date birth_city: maxLength: 35 minLength: 1 type: string description: Debtor's birth_city title: birth_city birth_country: type: string description: Debtor's birth_country pattern: ^[A-Z]{2,2}$ title: birth_country required: - account - name - bank_id Message-Ultimate-Debtor-Request-For-Payment: type: object title: MessageUltimateDebtorRequestForPayment properties: name: maxLength: 140 minLength: 1 type: string description: Name of the ultimate debtor title: name address_lines: type: array description: Ultimate Debtor's address_lines items: $ref: '#/components/schemas/Address' title: address_lines street_name: maxLength: 70 minLength: 1 type: string description: Ultimate Debtor's street_name title: street_name building_number: maxLength: 16 minLength: 1 type: string description: Ultimate Debtor's building_number title: building_number postal_code: maxLength: 16 minLength: 1 type: string description: Ultimate Debtor's postal_code title: postal_code city: maxLength: 35 minLength: 1 type: string description: Ultimate Debtor's city title: city state: maxLength: 35 minLength: 1 type: string description: 'Ultimate Debtor''s state ' title: state country: type: string description: Ultimate Debtor's country pattern: ^[A-Z]{2,2}$ title: country org_id: maxLength: 20 minLength: 1 type: string description: ' Ultimate Debtor''s org_id' title: org_id birth_date: type: string format: date description: ISO 8601 (YYYY-MM-DD), ultimate debtor's birth date title: org_id birth_city: maxLength: 35 minLength: 1 type: string description: Ultimate debtor's birth city title: birth_city birth_country: type: string description: Ultimate debtor's birth country pattern: ^[A-Z]{2,2}$ title: birth_country Message-Creditor-Request-For-Payment: type: object title: MessageCreditorRequestForPayment properties: account: maxLength: 40 minLength: 1 type: string description: Creditor Account ID title: account account_name: maxLength: 140 minLength: 1 type: string description: Creditor Account Name title: account_name name: maxLength: 140 minLength: 1 type: string description: Creditor Name title: name bank_id: maxLength: 16 minLength: 1 type: string description: Beneficiary Bank Clearing Id title: bank_id address_lines: type: array description: Creditor's address_lines items: $ref: '#/components/schemas/Address' title: address_lines street_name: maxLength: 70 minLength: 1 type: string description: 'Creditor''s street_name ' title: street_name building_number: maxLength: 16 minLength: 1 type: string description: Creditor's building_number title: building_number postal_code: maxLength: 16 minLength: 1 type: string description: Creditor's postal_code title: postal_code city: maxLength: 35 minLength: 1 type: string description: Creditor's city title: city state: maxLength: 35 minLength: 1 type: string description: Creditor's state title: state country: type: string description: Creditor's country pattern: ^[A-Z]{2,2}$ title: country org_id: maxLength: 20 minLength: 1 type: string description: Creditor's org_id title: org_id birth_date: type: string format: date description: ISO 8601 (YYYY-MM-DD), Creditor's birth_date title: birth_date birth_city: maxLength: 35 minLength: 1 type: string description: 'Creditor''s birth_city ' title: birth_city birth_country: type: string description: Creditor's birth_country pattern: ^[A-Z]{2,2}$ title: birth_country phone_number: type: string maxLength: 35 description: Creditor's phone number pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} title: phone_number required: - account - name - bank_id Message-Method-Request-For-Payment: type: object title: MessageMethodRequestForPayment required: - country - instructed_currency - method properties: country: description: ISO 3166 Alpha-2 code for the transaction country type: string enum: - US title: country instructed_currency: type: string description: ISO 4217 code for the transaction instructed amount currency enum: - USD title: instructed_currency method: description: |- Method specified by the debtor for the transaction - Provide IP for instant payment type: string enum: - IP title: method network: type: string enum: - RTP - ZELLE description: >- Financial market infrastructure or clearing system (e.g., RTP Network in the United States) title: network Message-Transaction-Request-For-Payment: type: object title: MessageTransactionRequestForPayment required: - uetr - type - instructed_amount - creation_date_time - settlement_currency - payment_information_id - end_to_end_id - category properties: end_to_end_id: maxLength: 35 minLength: 1 type: string description: Client provided reference number title: end_to_end_id instruction_id: type: string maxLength: 35 minLength: 1 description: Instruction Id title: instruction_id payment_information_id: type: string maxLength: 35 minLength: 1 description: Payment Information ID title: payment_information_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 type: type: string description: Transaction Type - Debit or Credit enum: - credit - debit title: type 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 title: local_reference creation_date_time: type: string format: date-time description: >- GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Instant Payment (Debit) - Date time, generated by CitiConnect API, when CitiConnect API accepted a payment initiation after validation - 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 instructed_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: Amount instructed by client for a transaction title: instructed_amount settlement_currency: maxLength: 3 type: string description: ISO 4217 code for the transaction settlement amount currency title: settlement_currency unstructured_remittance_info: type: array description: |- Unstructured remitance information - For US transaction.unstructured_remittance_info field maximum length is 140 and unlimited line is allowed items: $ref: '#/components/schemas/Unstructured' title: unstructured_remittance_info category: type: string description: Specifies the high level purpose of the instruction enum: - BUSINESS - CONSUMER title: category requested_execution_date: type: string format: date description: >- Requested Execution Date Format is YYYY-MM-DD. - Either Requested Execution Date or Requested Execution Date Time must be present title: requested_execution_date requested_execution_date_time: type: string format: date-time description: >- Requested Execution Date/Time UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - - Either Requested Execution Date or Requested Execution Date Time must be present title: requested_execution_date_time expiry_date: type: string format: date description: |- Expiry Date Format is YYYY-MM-DD - Either Expiry Date or Expiry Date Time must be present title: expiry_date expiry_date_time: type: string format: date-time description: |- Expiry Date/Time GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Either Expiry Date or Expiry Date Time must be present title: expiry_date_time amt_mod_allowed: type: boolean default: true description: >- Indicator by customer if the debtor (RFP recipient) can modify over/under the instructed amount - true - Amount may be modified by the Debtor - false - Amount of payment must equal the Instructed Amount title: amt_mod_allowed full_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: >- Amount that is the gross amount payable by client - If populated, message.transaction.discount_amount must also be populated title: full_amount discount_amount: type: number minimum: 0.01 maximum: 1000000000000000 description: >- Amount that is the discount from the gross amount - If populated, message.transaction.full_amount must also be popluated title: discount_amount purpose: type: string minLength: 1 maxLength: 5 description: |- Purpose of a transaction - GDDS for payment related to purchase or sale of goods - SCVE for payment related to purchase or sale of services - PAYR for payroll payment - NOWS for Not Otherwise Specified - INVS for Invoice Signed - INSC for Payment Of Insurance Claim - INSM for Installment - PDEP for Property Deposit - UBIL for Utilities Subscription Identification - ACCT for Account Management - CBLK for Bulk card transactions - MP2P for Mobile P2P Payment title: purpose status: type: object title: status properties: date_time: type: string format: date-time description: |- GMT (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Date time of transaction status title: date_time code: type: string description: ISO 20022 message status code enum: - PRES - ACSP - ACCC - RJCT title: code description: type: string description: |- Status code description - RJCT - Rejected - PRES - Request For Payment has been presented to the Debtor - ACSP- Accepted Settlement In Process - ACCC - Accepted Settlement Completed minLength: 1 maxLength: 256 title: description required: - date_time - code - description reasons: type: object title: reasons readOnly: true properties: code: type: string description: Reason code (applicable when message is rejected) maxLength: 4 title: code description: type: string description: Reason code description (e.g., Debtor account is invalid.) minLength: 1 maxLength: 256 title: description isproprietary: type: integer description: >- Flag to indicate the Rejection code is ISO Standard or Proprietary - 0 For ISO Code - 1 For Proprietary enum: - 0 - 1 title: isproprietary Debtor-Payment: type: object title: DebtorPayment writeOnly: true properties: name: minLength: 1 maxLength: 140 type: string description: Name of Debtor that may be passed for payment initiation title: name street_name: minLength: 1 maxLength: 70 type: string description: Street Name of Debtor that may be passed for payment initiation title: street_name building_number: minLength: 1 maxLength: 16 type: string description: Building number of Debtor that may be passed for payment initiation title: building_number postal_code: minLength: 1 maxLength: 16 type: string description: Postal code of Debtor that may be passed for payment initiation title: postal_code city: minLength: 1 maxLength: 35 type: string description: City of Debtor that may be passed for payment initiation title: city state: minLength: 1 maxLength: 35 type: string description: State of Debtor that may be passed for payment initiation title: state country: type: string description: Country of Debtor that may be passed for payment initiation pattern: ^[A-Z]{2,2}$ title: country address_lines: type: array minItems: 1 maxItems: 7 description: >- Debtor Address lines which is array of 7 lines and each line has maximum 70 characters which may be passed for payment initiation items: $ref: '#/components/schemas/Address' title: address_lines Ultimate-Debtor-Payment: type: object title: UltimateDebtorPayment writeOnly: true properties: name: minLength: 1 maxLength: 140 type: string description: Name of Ultimate Debtor that may be passed for payment initiation title: name street_name: minLength: 1 maxLength: 70 type: string description: >- Street Name of Ultimate Debtor that may be passed for payment initiation title: street_name building_number: minLength: 1 maxLength: 16 type: string description: >- Building number of Ultimate Debtor that may be passed for payment initiation title: building_number postal_code: minLength: 1 maxLength: 16 type: string description: >- Postal code of Ultimate Debtor that may be passed for payment initiation title: postal_code city: minLength: 1 maxLength: 35 type: string description: City of Ultimate Debtor that may be passed for payment initiation title: city state: minLength: 1 maxLength: 35 type: string description: State of Ultimate Debtor that may be passed for payment initiation title: state country: type: string description: Country of Ultimate Debtor that may be passed for payment initiation pattern: ^[A-Z]{2,2}$ title: country address_lines: type: array minItems: 1 maxItems: 7 description: >- Ultimate Debtor Address lines which is array of 7 lines and each line has maximum 70 characters which may be passed for payment initiation items: $ref: '#/components/schemas/Address' title: address_lines Beneficiary-Validation-Request: xml: name: BeneficiaryValidationRequest type: object title: BeneficiaryValidationRequest required: - debtor - method properties: end_to_end_id: xml: name: EndToEndId type: string description: |- Client provided reference number. - For India IMPS and UPI, this field is mandatory and max length is 16 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not required minLength: 1 maxLength: 35 title: end_to_end_id uetr: xml: name: 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 debtor: xml: name: Debtor type: object title: debtor properties: account: xml: name: Account type: string description: |- Bank account held with CITI - For India IMPS and UPI , this field is mandatory and max length is 34 - For US EWS, this field is mandatory and max length is 40 - For UK, this field is mandatory and max length is 40 - For IN PAN, this field is mandatory and max length is 40 - For Pay2China, this field is mandatory and max length is 40 minLength: 1 maxLength: 40 title: account name: xml: name: Name type: string description: |- Debtor Account Name. - For India IMPS and UPI ,this field is mandatory and max length is 99 - For US EWS,this field is optional and max length is 140 - For UK,this field is optional and max length is 140 - For IN PAN,this field is optional and max length is 140 - For Pay2China - this field is optional and max length is 140 minLength: 1 maxLength: 140 title: name proxy_id: xml: name: ProxyId type: string description: |- Remitter Proxy ID. - For India,this field is mandatory for UPI only and max length is 255 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not required minLength: 1 maxLength: 255 title: proxy_id ultimate_debtor: xml: name: UltimateDebtor type: object title: ultimate_debtor properties: name: xml: name: Name type: string description: |- Ultimate debtor name. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For Pay2China, this field is optional and the max length is 140 minLength: 1 maxLength: 140 title: ultimate_debtor_name account: xml: name: Account type: string description: |- Beneficiary Owner Id/Legal Rep id. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is mandatory and the max length is 35 minLength: 1 maxLength: 35 title: ultimate_debtor_account required: - account creditor: xml: name: Creditor type: object title: creditor properties: id: xml: name: Id type: string description: |- Creditor Id. - For IMPS India,this field is not applicable - For UPI India, this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable. - For Pay2China, this field is merchant ID. It is mandatory and the max length is 32 minLength: 1 maxLength: 35 title: id account: xml: name: Account type: string description: |- Creditor Account Number. - For IMPS India,this field is mandatory and max length is 34 - For UPI India, this field is optional and length should be 34 - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For Pay2China, this field is optional and max length is 32 minLength: 1 maxLength: 40 title: account name: xml: name: Name type: string description: |- Creditor Account Name. - For India IMPS and UPI,this field is optional and max length is 99 - For US EWS,this field is mandatory and max length is 87. Please provide first middle(if any) last name in this sequence with spaces - For UK,this field is mandatory and max length is 87. Please provide first middle(if any) last name in this sequence with spaces - For IN PAN,this field is mandatory and max length is 85. Please provide first middle(if any) last name in this sequence with spaces - For Pay2China, this field is merchant name. It is a conditional field. It is mandatory for first time onboarding and max length is 128 minLength: 1 maxLength: 140 title: name father_name: xml: name: FatherName type: string description: |- Creditor' Father's Name. - For India IMPS and UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is optional and max length is 75. Please provide first middle(if any) last name in this sequence with spaces - For Pay2China, this field is not required minLength: 1 maxLength: 140 title: father_name bank_id: xml: name: BankId type: string description: |- Receiving Financial Institution BIC. - For IMPS India,this field is mandatory and length should be 11 - For UPI India,this field is optional and length should be 11 - For US EWS,this field is mandatory and length should be 9 if routing/clearing code is populated - For UK,this field is mandatory and length should be 8 or 11 character if bic (including branch code) is sent - For IN PAN,this field is not applicable - For Pay2China, this field is optional and max length is 64 minLength: 1 maxLength: 35 title: bank_id bank_name: xml: name: BankName type: string description: |- Receiving Financial Institution Name. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this is an optional field and max length is 128 minLength: 1 maxLength: 140 title: bank_name proxy_id: xml: name: ProxyId type: string description: |- Creditor Proxy ID - For India,this field is mandatory for UPI only and max length is 255 (UPI ID or Mobile number can be passed).If mobile number is passed it should be greater than or equal to 6 and less than or equal to 16 - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For Pay2China, this field is not required minLength: 1 maxLength: 255 title: proxy_id proxy_type: xml: name: ProxyType type: string description: |- Creditor Proxy type - For India,this field is optional for UPI only if mobile number needs to be passed in creditor.proxy_id - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - MBNO - Mobile Number - SHID - Scheme identification number (eg. VPA ID) - For Pay2China, this field is not required enum: - MBNO - SHID title: proxy_type wallet: xml: name: Wallet type: string description: |- Creditor wallet details - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For Pay2China, this field is not required minLength: 1 maxLength: 40 title: wallet IBAN: xml: name: Iban type: string description: |- Creditor IBAN number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 34.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For Pay2China, this field is not required minLength: 1 maxLength: 40 title: IBAN address_lines: xml: name: AddressLines type: array description: |- Creditor's address lines - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional and allowed 2 lines with each line max length of 40 - For UK, this field is optional and allowed 2 lines with each line max length of 40 - For IN PAN,this field is not applicable - For Pay2China, this field is not required items: $ref: '#/components/schemas/Address' title: address_lines street_name: xml: name: StreetName maxLength: 70 minLength: 1 type: string description: |- Creditor's street_name - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 70 - For UK, this field is optional with max length 70 - For IN PAN,this field is not applicable - For Pay2China, this field is not required title: street_name building_number: xml: name: BuildingNumber maxLength: 16 minLength: 1 type: string description: |- Creditor's building_number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 16 - For UK, this field is optional with max length 16 - For IN PAN,this field is not applicable - For Pay2China, this field is not required title: building_number postal_code: xml: name: PostalCode maxLength: 16 minLength: 1 type: string description: |- Creditor's postal_code - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 10 - For UK, this field is optional with max length 16 - For IN PAN,this field is not applicable - For Pay2China, this field is not required title: postal_code city: xml: name: City maxLength: 35 minLength: 1 type: string description: |- Creditor's city - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 25 - For UK, this field is optional with max length 35 - For IN PAN,this field is not applicable - For Pay2China, this field is not required title: city state: xml: name: State maxLength: 35 minLength: 1 type: string description: |- Creditor's state - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 25 - For UK, this field is optional with max length 35 - For IN PAN,this field is not applicable - For Pay2China, this field is not required title: state country: xml: name: Country type: string description: |- Creditor's country - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 2 - For UK, this field is optional with max length 2 - For IN PAN,this field is not applicable - For Pay2China, this field is not required pattern: ^[A-Z]{2,2}$ title: country birth_date: xml: name: BirthDate type: string format: date description: |- ISO 8601 (YYYY-MM-DD), Creditor's birth date - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional - For UK, this field is optional - For IN PAN,this field is mandatory - For Pay2China, this field is not required title: birth_date home_phone_number: xml: name: HomePhoneNumber maxLength: 34 minLength: 6 type: string description: |- Creditor's home phone number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 10 - For UK, this field is optional with max length 34 - For IN PAN,this field is not applicable - For Pay2China, this field is not required title: home_phone_number work_phone_number: xml: name: WorkPhoneNumber maxLength: 34 minLength: 6 type: string description: |- Creditor's work phone number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 10 - For UK, this field is optional with max length 34 - For IN PAN,this field is not applicable - For Pay2China, this is a conditional field. It is mandatory for first time onboarding and max length is 32 title: work_phone_number beneficial_owner: xml: name: BeneficialOwner type: object title: beneficial_owner properties: name: xml: name: Name type: string description: |- Beneficiary Owner Name/Legal Rep name. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For Pay2China, this is a conditional field. If the document.entity is business, this field should present for first time onboarding. If document.entity is Personal, this fields is not application and the max length is 32 minLength: 1 maxLength: 140 title: owner_name id: xml: name: Id type: string description: |- Beneficiary Owner Id/Legal Rep id. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this is a conditional field. If the document.entity is business, this filed should present for first time onboarding. If document.entity is Personal, this fields is not application and max length is 32 minLength: 1 maxLength: 35 title: owner_id document: xml: name: Document type: object title: document properties: entity: xml: name: Entity type: string description: |- Whether the document belongs to Business or Individual - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is optional - For UK,this field is optional - For IN PAN,this field is not applicable - For Pay2China, this is mandatory enum: - BUSINESS - PERSONAL title: entity type: xml: name: Type type: string description: |- Whether the document belongs to Business or Individual - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is optional - For UK,this field is optional - For IN PAN,this field is mandatory with applicable value TXID - For Pay2China, this field is conditional. It is mandatory for first time onboarding. If the document.entity is Business, this filed value should be EMPL. If document.entity is Personal, this fields value should be NIDN - Personal Code values - ARNU AlienRegistrationNumber - CCPT PassportNumber - CUST CustomerIdentificationNumber - DRLC DriversLicenseNumber - EMPL EmployeeIdentificationNumber - NIDN NationalIdentityNumber - SOSE SocialSecurityNumber - TELE TelephoneNumber - TXID TaxIdentificationNumber - POID PersonCommercialIdentification - Corporate Code values - BANK BankPartyIdentification - CBID Central Bank Identification Number - CHID Clearing Identification Number - COID CountryIdentificationCode - CUST CustomerNumber - DUNS Data Universal Numbering System - EMPL EmployerIdentificationNumber - GS1G GS1GLNIdentifier - SREN SIREN - SRET SIRET - TXID Tax Identification Number enum: - ARNU - CCPT - CUST - DRLC - EMPL - NIDN - SOSE - TELE - TXID - POID - BANK - CBID - CHID - COID - DUNS - GS1G - SREN - SRET title: type number: xml: name: Number maxLength: 35 minLength: 1 type: string description: |- Creditor's document number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 28 - For UK, this field is optional with max length 35 - For IN PAN,this field is mandatory with max length 10 - For Pay2China, this field is conditional. It is mandatory for first time onboarding and max length is 20 title: number state: xml: name: State maxLength: 35 minLength: 1 type: string description: |- Creditor's document state - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 6 - For UK, this field is optional with max length 35 - For IN PAN,this field is not applicable - For Pay2China, this field is not required title: state method: xml: name: Method type: object title: method properties: country: xml: name: Country type: string description: ISO 3166 Alpha-2 code for the transaction country enum: - IN - US - GB - CN title: country method: xml: name: Method type: string description: Method specified by the debtor for the validation enum: - IMPS - UPI - BANKACCOUNT - IBAN - CARD - PAYMENTID - ID - MERCHANTID title: method type: xml: name: Type type: string description: >- Message type (e.g., CT for credit transfer,AER for Account Enquiry Request) - For India,this field is mandatory and allowed value is AER - For US EWS,this field is mandatory - For UK,this field is mandatory - Ownership - Account ownership is limited to validation of correct owner , hence the account number or equivalent ( i.e Virtual account) and Name - Attributes- Attributes define the properties of the object , for an account the properties should include Status , type of account, status of account , the address of the account etc. - Structure - Structure refers to the mod 97 and the length as per the country of IBAN - TAXID- Validation of individual or corporate tax id/tax documentation - For Pay2China, this field is mandatory with the value Ownership enum: - AER - Structure - Ownership - Attributes - TAXID title: type penny_test: xml: name: PennyTest type: string description: >- This field enables selection of penny,non-penny or both validations - Applicable for IN IMPS enum: - NONPENNY - PENNY - BOTH title: penny_test required: - country - method - type Initial-Beneficiary-Validation-Response: xml: name: InitialBeneficiaryValidationResponse type: object title: InitialBeneficiaryValidationResponse properties: end_to_end_id: xml: name: EndToEndId type: string description: |- Client provided reference number. - For India IMPS and UPI, this field is mandatory and max length is 16 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 35 title: end_to_end_id uetr: xml: name: 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 debtor: xml: name: Debtor type: object title: debtor properties: account: xml: name: Account type: string description: |- Bank account held with CITI - For India IMPS and UPI , this field is mandatory and max length is 34 - For US EWS, this field is mandatory and max length is 40 - For UK, this field is mandatory and max length is 40 - For IN PAN, this field is mandatory and max length is 40 - For Pay2China, this field is mandatory and max length is 40 minLength: 1 maxLength: 40 title: account name: xml: name: Name type: string description: |- Debtor Account Name. - For India IMPS and UPI ,this field is mandatory and max length is 99 - For US EWS,this field is optional and max length is 140 - For UK,this field is optional and max length is 140 - For IN PAN,this field is optional and max length is 140 - For Pay2China, this field is optional and max length is 140 minLength: 1 maxLength: 140 title: name proxy_id: xml: name: ProxyId type: string description: |- Remitter Proxy ID. - For India,this field is mandatory for UPI only and max length is 255 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 255 title: proxy_id ultimate_debtor: xml: name: UltimateDebtor type: object title: ultimate_debtor properties: name: xml: name: Name type: string description: |- Ultimate debtor name. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For Pay2China, this field is optional and the max length is 140 minLength: 1 maxLength: 140 title: ultimate_debtor_name account: xml: name: Account type: string description: |- Beneficiary Owner Id/Legal Rep id. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is mandatory and the max length is 35 minLength: 1 maxLength: 35 title: ultimate_debtor_account required: - account creditor: xml: name: Creditor type: object title: creditor properties: id: xml: name: Id type: string description: |- Creditor Id. - For IMPS India,this field is not applicable - For UPI India, this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable. - For Pay2China, this field is merchant ID. It is mandatory and the max length is 32 minLength: 1 maxLength: 35 title: id account: xml: name: Account type: string description: |- Creditor Account Number. - For IMPS India,this field is mandatory and max length is 34 - For UPI India, this field is optional and length should be 34 - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For Pay2China, this field is optional and max length is 32 minLength: 1 maxLength: 40 title: account name: xml: name: Name type: string description: |- Creditor Account Name. - For India IMPS and UPI,this field is optional and max length is 99 - For US EWS,this field is mandatory and max length is 87. Please provide first middle(if any) last name in this sequence with spaces - For UK,this field is mandatory and max length is 87. Please provide first middle(if any) last name in this sequence with spaces - For IN PAN,this field is mandatory and max length is 85. Please provide first middle(if any) last name in this sequence with spaces - For Pay2China, this field is merchant name. It is a conditional field. It is mandatory for first time onboarding and max length is 128 minLength: 1 maxLength: 140 title: name father_name: xml: name: FatherName type: string description: |- Creditor' Father's Name. - For India IMPS and UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is optional and max length is 75. Please provide first middle(if any) last name in this sequence with spaces - For Pay2China,this field is not applicable minLength: 1 maxLength: 140 title: father_name bank_id: xml: name: BankId type: string description: |- Receiving Financial Institution BIC. - For IMPS India,this field is mandatory and length should be 11 - For UPI India,this field is optional and length should be 11 - For US EWS,this field is mandatory and length should be 9 if routing/clearing code is populated - For UK,this field is mandatory and length should be 8 or 11 character if bic (including branch code) is sent - For IN PAN,this field is not applicable - For Pay2China, this field is optional and max length is 64 minLength: 1 maxLength: 35 title: bank_id bank_name: xml: name: BankName type: string description: |- Receiving Financial Institution Name. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this is an optional field and max length is 128 minLength: 1 maxLength: 140 title: bank_name proxy_id: xml: name: ProxyId type: string description: |- Creditor Proxy ID - For India,this field is mandatory for UPI only and max length is 255 (UPI ID or Mobile number can be passed).If mobile number is passed it should be greater than or equal to 6 and less than or equal to 16 - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable minLength: 1 maxLength: 255 title: proxy_id proxy_type: xml: name: ProxyType type: string description: |- Creditor Proxy type - For India,this field is optional for UPI only if mobile number needs to be passed in creditor.proxy_id - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - MBNO - Mobile Number - SHID - Scheme identification number (eg. VPA ID) - For IN Pay2China,this field is not applicable enum: - MBNO - SHID title: proxy_type wallet: xml: name: Wallet type: string description: |- Creditor wallet details - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable minLength: 1 maxLength: 40 title: wallet IBAN: xml: name: Iban type: string description: |- Creditor IBAN number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 34.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable minLength: 1 maxLength: 40 title: IBAN address_lines: xml: name: AddressLines type: array description: |- Creditor's address lines - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional and allowed 2 lines with each line max length of 40 - For UK, this field is optional and allowed 2 lines with each line max length of 40 - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable items: $ref: '#/components/schemas/Address' title: address_lines street_name: xml: name: StreetName maxLength: 70 minLength: 1 type: string description: |- Creditor's street_name - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 70 - For UK, this field is optional with max length 70 - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable title: street_name building_number: xml: name: BuildingNumber maxLength: 16 minLength: 1 type: string description: |- Creditor's building_number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 16 - For UK, this field is optional with max length 16 - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable title: building_number postal_code: xml: name: PostalCode maxLength: 16 minLength: 1 type: string description: |- Creditor's postal_code - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 10 - For UK, this field is optional with max length 16 - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable title: postal_code city: xml: name: City maxLength: 35 minLength: 1 type: string description: |- Creditor's city - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 25 - For UK, this field is optional with max length 35 - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable title: city state: xml: name: State maxLength: 35 minLength: 1 type: string description: |- Creditor's state - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 25 - For UK, this field is optional with max length 35 - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable title: state country: xml: name: Country type: string description: |- Creditor's country - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 2 - For UK, this field is optional with max length 2 - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable pattern: ^[A-Z]{2,2}$ title: country birth_date: xml: name: BirthDate type: string format: date description: |- ISO 8601 (YYYY-MM-DD), Creditor's birth date - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional - For UK, this field is optional - For IN PAN,this field is mandatory - For IN Pay2China,this field is not applicable title: birth_date home_phone_number: xml: name: HomePhoneNumber maxLength: 34 minLength: 6 type: string description: |- Creditor's home phone number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 10 - For UK, this field is optional with max length 34 - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable title: home_phone_number work_phone_number: xml: name: WorkPhoneNumber maxLength: 34 minLength: 6 type: string description: |- Creditor's work phone number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 10 - For UK, this field is optional with max length 34 - For IN PAN,this field is not applicable - For Pay2China, this is a conditional field. It is mandatory for first time onboarding and max length is 32 title: work_phone_number beneficial_owner: xml: name: BeneficialOwner type: object title: beneficial_owner properties: name: xml: name: Name type: string description: |- Beneficiary Owner Name/Legal Rep name. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For Pay2China, this is a conditional field. If the document.entity is business, this field should present for first time onboarding. If document.entity is Personal, this fields is not application and the max length is 32 minLength: 1 maxLength: 140 title: owner_name id: xml: name: Id type: string description: |- Beneficiary Owner Id/Legal Rep id. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this is a conditional field. If the document.entity is business, this filed should present for first time onboarding. If document.entity is Personal, this fields is not application and max length is 32 minLength: 1 maxLength: 35 title: owner_id document: xml: name: Document type: object title: document properties: entity: xml: name: Entity type: string description: |- Whether the document belongs to Business or Individual - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is optional - For UK,this field is optional - For IN PAN,this field is not applicable - For Pay2China, this is a Mandatory field. enum: - BUSINESS - PERSONAL title: entity type: xml: name: Type type: string description: |- Whether the document belongs to Business or Individual - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is optional - For UK,this field is optional - For IN PAN,this field is mandatory with applicable value TXID - For Pay2China, this field is conditional. It is mandatory for first time onboarding. If the document.entity is Business, this filed value should be EMPL. If document.entity is Personal, this fields value should be NIDN - Personal Code values - ARNU AlienRegistrationNumber - CCPT PassportNumber - CUST CustomerIdentificationNumber - DRLC DriversLicenseNumber - EMPL EmployeeIdentificationNumber - NIDN NationalIdentityNumber - SOSE SocialSecurityNumber - TELE TelephoneNumber - TXID TaxIdentificationNumber - POID PersonCommercialIdentification - Corporate Code values - BANK BankPartyIdentification - CBID Central Bank Identification Number - CHID Clearing Identification Number - COID CountryIdentificationCode - CUST CustomerNumber - DUNS Data Universal Numbering System - EMPL EmployerIdentificationNumber - GS1G GS1GLNIdentifier - SREN SIREN - SRET SIRET - TXID Tax Identification Number enum: - ARNU - CCPT - CUST - DRLC - EMPL - NIDN - SOSE - TELE - TXID - POID - BANK - CBID - CHID - COID - DUNS - GS1G - SREN - SRET title: type number: xml: name: Number maxLength: 35 minLength: 1 type: string description: |- Creditor's document number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 28 - For UK, this field is optional with max length 35 - For IN PAN,this field is mandatory with max length 10 - For Pay2China, this field is conditional. It is mandatory for first time onboarding and max length is 20 title: number state: xml: name: State maxLength: 35 minLength: 1 type: string description: |- Creditor's document state - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 6 - For UK, this field is optional with max length 35 - For IN PAN,this field is not applicable - For IN Pay2China,this field is not applicable title: state method: xml: name: Method type: object title: method properties: country: xml: name: Country type: string description: ISO 3166 Alpha-2 code for the transaction country enum: - IN - US - GB - CN title: country method: xml: name: Method type: string description: Method specified by the debtor for the validation enum: - IMPS - UPI - BANKACCOUNT - IBAN - CARD - PAYMENTID - ID - MERCHANTID title: method type: xml: name: Type type: string description: >- Message type (e.g., CT for credit transfer,AER for Account Enquiry Request) - For India,this field is mandatory and allowed value is AER - For US EWS,this field is mandatory - For UK,this field is mandatory - Ownership - Account ownership is limited to validation of correct owner , hence the account number or equivalent ( i.e Virtual account) and Name - Attributes- Attributes define the properties of the object , for an account the properties should include Status , type of account, status of account , the address of the account etc. - Structure - Structure refers to the mod 97 and the length as per the country of IBAN - TAXID- Validation of individual or corporate tax id/tax documentation - For Pay2China, this field is mandatory with the value Ownership enum: - AER - Structure - Ownership - Attributes - TAXID title: type penny_test: xml: name: PennyTest type: string description: >- This field enables selection of penny,non-penny or both validations - Applicable for IN IMPS enum: - NONPENNY - PENNY - BOTH title: penny_test required: - country - method - type creation_date_time: xml: name: CreationDateTime type: string format: date-time description: >- Request Creation Date and Time in UTC generated by CitiConnect API UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) title: creation_date_time status: xml: name: Status type: object title: status properties: date_time: xml: name: DateTime type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Date time of transaction status title: date_time code: xml: name: Code type: string description: ISO 20022 acknowledegment status code enum: - ACTC title: code description: xml: name: Description type: string description: |- Status code description - ACTC - Accepted title: description required: - code - description - date_time Final-Beneficiary-Validation-Response: xml: name: FinalBeneficiaryValidationResponse type: object title: FinalBeneficiaryValidationResponse properties: end_to_end_id: xml: name: EndToEndId type: string description: |- Client provided reference number. - For India IMPS and UPI, this field is mandatory and max length is 16 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not required minLength: 1 maxLength: 35 title: end_to_end_id uetr: xml: name: 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 debtor: xml: name: Debtor type: object title: debtor properties: account: xml: name: Account type: string description: |- Bank account held with CITI - For India UPI and IMPS,this field is mandatory and max length is 34 - For US EWS, this field is optional and max length is 40 - For UK, this field is optional and max length is 40 - For IN PAN, this field is optional and max length is 40 - For Pay2China, this field is mandatory and max length is 40 minLength: 1 maxLength: 40 title: account name: xml: name: Name type: string description: |- Debtor Account Name. - For India IMPS and UPI ,this field is mandatory and max length is 99 - For US EWS,this field is optional and max length is 140 - For UK,this field is optional and max length is 140 - For IN PAN,this field is optional and max length is 140 - For Pay2China, this field is not applicable minLength: 1 maxLength: 140 title: name proxy_id: xml: name: ProxyId type: string description: |- Remitter Proxy ID. - For India,this field is mandatory for UPI only and max length is 255 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 255 title: proxy_id ultimate_debtor: xml: name: UltimateDebtor type: object title: ultimate_debtor properties: name: xml: name: Name type: string description: |- Ultimate debtor name. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 140 title: ultimate_debtor_name account: xml: name: Account type: string description: |- Beneficiary Owner Id/Legal Rep id. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is mandatory and the max length is 35 minLength: 1 maxLength: 35 title: ultimate_debtor_account creditor: xml: name: Creditor type: object title: creditor properties: id: xml: name: Id type: string description: |- Creditor Id. - For IMPS India,this field is not applicable - For UPI India, this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable. - For Pay2China, this field is mandatory and the max length is 32 minLength: 1 maxLength: 35 title: id account: xml: name: Account type: string description: |- Creditor Account Number. - For India IMPS ,this field is mandatory and max length is 34 - For India UPI ,this field is optional and max length is 34 - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 40 title: account name: xml: name: Name type: string description: |- Creditor Account Name. - For India IMPS and UPI,this field is optional and max length is 99 - For US EWS,this field is optional and max length is 87. Please provide first middle(if any) last name in this sequence with spaces - For UK,this field is optional and max length is 87. Please provide first middle(if any) last name in this sequence with spaces - For IN PAN,this field is optional and max length is 85. Please provide first middle(if any) last name in this sequence with spaces - For Pay2China, this field is merchant name. It is a conditional field. It is mandatory for first time onboarding and max length is 128 minLength: 1 maxLength: 140 title: name father_name: xml: name: FatherName type: string description: |- Creditor' Father's Name. - For India IMPS and UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is optional and max length is 75. Please provide first middle(if any) last name in this sequence with spaces - For Pay2China,this field is not applicable minLength: 1 maxLength: 140 title: father_name bank_id: xml: name: BankId type: string description: |- Receiving Financial Institution BIC. - For India IMPS,this field is mandatory and length should be 11 - For India UPI ,this field is conditional(available for successful validation) and max length is 11 - For US EWS,this field is optional and length should be 9 if routing/clearing code is populated - For UK,this field is optional and length should be 8 or 11 character if bic (including branch code) is sent - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable minLength: 1 maxLength: 35 title: bank_id bank_name: xml: name: BankName type: string description: |- Receiving Financial Institution Name. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this is not applicable minLength: 1 maxLength: 140 title: bank_name resolved_name: xml: name: ResolvedName type: string description: |- Creditor name sent in beneficiary validation response. - For India IMPS and UPI,this field is mandatory and max length is 99 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable minLength: 1 maxLength: 140 title: resolved_name proxy_id: xml: name: ProxyId type: string description: |- Creditor Proxy ID - For India,this field is mandatory for UPI only and max length is 255 (UPI ID or Mobile number can be passed) - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable minLength: 1 maxLength: 255 title: proxy_id proxy_type: xml: name: ProxyType type: string description: |- Creditor Proxy type - For India,this field is optional for UPI - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - MBNO - Mobile Number - SHID - Scheme identification number (eg. VPA ID) - For Pay2China,this field is not applicable enum: - MBNO - SHID title: proxy_type upi_id: xml: name: UpiId type: string description: |- Resolved UPI Id for successful response - For India,this field is conditional for UPI only and max length is 255 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable minLength: 1 maxLength: 255 title: upi_id wallet: xml: name: Wallet type: string description: |- Creditor wallet details - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable minLength: 1 maxLength: 40 title: wallet IBAN: xml: name: Iban type: string description: |- Creditor IBAN number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional and max length is 17.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For UK,this field is conditional and max length is 34.Either creditor.account or creditor.proxy_id or creditor.wallet or creditor.IBAN should be passed by client - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable minLength: 1 maxLength: 40 title: IBAN address_lines: xml: name: AddressLine type: array description: |- Creditor's address lines - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional and allowed 2 lines with each line max length of 40 - For UK, this field is optional and allowed 2 lines with each line max length of 40 - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable items: $ref: '#/components/schemas/Address' title: address_lines street_name: xml: name: StreetName maxLength: 70 minLength: 1 type: string description: |- Creditor's street_name - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 70 - For UK, this field is optional with max length 70 - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable title: street_name building_number: xml: name: BuildingNumber maxLength: 16 minLength: 1 type: string description: |- Creditor's building_number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 16 - For UK, this field is optional with max length 16 - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable title: building_number postal_code: xml: name: PostalCode maxLength: 16 minLength: 1 type: string description: |- Creditor's postal_code - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 10 - For UK, this field is optional with max length 16 - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable title: postal_code city: xml: name: City maxLength: 35 minLength: 1 type: string description: |- Creditor's city - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 25 - For UK, this field is optional with max length 35 - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable title: city state: xml: name: State maxLength: 35 minLength: 1 type: string description: |- Creditor's state - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 25 - For UK, this field is optional with max length 35 - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable title: state country: xml: name: Country type: string description: |- Creditor's country - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 2 - For UK, this field is optional with max length 2 - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable pattern: ^[A-Z]{2,2}$ title: country birth_date: xml: name: BirthDate type: string format: date description: |- ISO 8601 (YYYY-MM-DD), Creditor's birth date - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional - For UK, this field is optional - For IN PAN, this field is optional - For Pay2China,this field is not applicable title: birth_date home_phone_number: xml: name: HomePhoneNumber maxLength: 34 minLength: 6 type: string description: |- Creditor's home phone number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 10 - For UK, this field is optional with max length 34 - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable title: home_phone_number work_phone_number: xml: name: WorkPhoneNumber maxLength: 34 minLength: 6 type: string description: |- Creditor's work phone number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 10 - For UK, this field is optional with max length 34 - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable title: work_phone_number beneficial_owner: xml: name: BeneficialOwner type: object title: beneficial_owner properties: name: xml: name: Name type: string description: |- Beneficiary Owner Name/Legal Rep name. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 140 title: owner_name id: xml: name: Id type: string description: |- Beneficiary Owner Id/Legal Rep id. - For IMPS India,this field is not applicable - For UPI India,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 35 title: owner_id document: xml: name: Document type: object title: document properties: entity: xml: name: Entity type: string description: |- Whether the document belongs to Business or Individual - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is optional - For UK,this field is optional - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable enum: - BUSINESS - PERSONAL title: entity type: xml: name: Type type: string description: |- Whether the document belongs to Business or Individual - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is optional - For UK,this field is optional - For IN PAN,this field is optional - For Pay2China,this field is not applicable - Personal Code values - ARNU AlienRegistrationNumber - CCPT PassportNumber - CUST CustomerIdentificationNumber - DRLC DriversLicenseNumber - EMPL EmployeeIdentificationNumber - NIDN NationalIdentityNumber - SOSE SocialSecurityNumber - TELE TelephoneNumber - TXID TaxIdentificationNumber - POID PersonCommercialIdentification - Corporate Code values - BANK BankPartyIdentification - CBID Central Bank Identification Number - CHID Clearing Identification Number - COID CountryIdentificationCode - CUST CustomerNumber - DUNS Data Universal Numbering System - EMPL EmployerIdentificationNumber - GS1G GS1GLNIdentifier - SREN SIREN - SRET SIRET - TXID Tax Identification Number enum: - ARNU - CCPT - CUST - DRLC - EMPL - NIDN - SOSE - TELE - TXID - POID - BANK - CBID - CHID - COID - DUNS - GS1G - SREN - SRET title: type number: xml: name: Number maxLength: 35 minLength: 1 type: string description: |- Creditor's document number - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 28 - For UK, this field is optional with max length 35 - For IN PAN,this field is optional with max length 10 - For Pay2China,this field is not applicable title: number state: xml: name: State maxLength: 35 minLength: 1 type: string description: |- Creditor's document state - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS, this field is optional with max length 6 - For UK, this field is optional with max length 35 - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable title: state method: xml: name: Method type: object title: method properties: method: xml: name: Method type: string description: Method specified by the debtor for the validation enum: - IMPS - UPI - BANKACCOUNT - IBAN - CARD - PAYMENTID - ID - MERCHANTID title: method type: xml: name: Type type: string description: >- Message type (e.g., CT for credit transfer,AER for Account Enquiry Request) - For India,this field is mandatory and allowed value is AER - For US EWS,this field is mandatory - For UK,this field is mandatory - Ownership - Account ownership is limited to validation of correct owner , hence the account number or equivalent ( i.e Virtual account) and Name - Attributes- Attributes define the properties of the object , for an account the properties should include Status , type of account, status of account , the address of the account etc. - Structure - Structure refers to the mod 97 and the length as per the country of IBAN - TAXID- Validation of individual or corporate tax id/tax documentation - For Pay2China, this field is mandatory with the value Ownership enum: - AER - Structure - Ownership - Attributes - TAXID title: type country: xml: name: Country type: string description: ISO 3166 Alpha-2 code for the transaction country enum: - IN - US - GB - CN title: country network: xml: name: Network type: string enum: - IMPS - UPI description: >- Financial market infrastructure or clearing system (e.g., RTP Network in the United States) - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China,this field is not applicable title: network instructed_currency: xml: name: InstructedCurrency type: string description: >- Currency code - For India IMPS and UPI, this field is conditional and applicable only for penny transaction - For India UPI, this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable enum: - INR title: instructed_currency penny_test: xml: name: PennyTest type: string description: >- This field enables selection of penny,non-penny or both validations - Applicable for IN IMPS enum: - NONPENNY - PENNY - BOTH title: penny_test required: - method - type - country transaction: xml: name: Transaction title: transaction type: object properties: purpose: xml: name: Purpose title: purpose type: string description: >- Purpose of payment. - For India IMPS and UPI, this field is conditional and applicable only for penny transaction and max length is 4 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 4 type: xml: name: Type title: type type: string description: >- Derived value based on method of Payment - For India IMPS and UPI, this field is conditional and applicable only for penny transaction and max length is 8 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 8 value_date: xml: name: ValueDate title: value_date type: string format: date description: >- Mapped with Value Date when Penny requested is created by XPay Format: YYYY-MM-DD - For India IMPS and UPI, this field is conditional and applicable only for penny transaction - Date in local time zone (e.g., IST for a India) when Citi's transaction processing application starts processing a transaction.Format is YYYY-MM-DD Populate the present date in local timezone - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable instructed_amount: xml: name: InstructedAmount title: instructed_amount type: string description: >- Instructed Amount. - For India IMPS and UPI, this field is conditional and applicable only for penny transaction and max length is 17 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 18 unstructured_remittance_info: xml: name: UnstructuredRemittanceInfo title: unstructured_remittance_info type: array description: >- Unstructured Remitter Information - For India IMPS and UPI, this field is conditional and applicable only for penny transaction 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 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable items: $ref: '#/components/schemas/Unstructured' batch_id: xml: name: BatchId title: batch_id type: string description: >- Posting Batch ID (Bulk Reference Number) - For India IMPS and UPI, this field is conditional and applicable only for penny transaction - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable minLength: 1 maxLength: 35 creation_date_time: xml: name: CreationDateTime type: string format: date-time description: >- Request Creation Date and Time in UTC generated by CitiConnect API UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) title: creation_date_time network_id: xml: name: NetworkId maxLength: 128 minLength: 1 type: string description: |- Transaction identification generated for or by the network - For India IMPS and UPI, this field is optional and max length is 12 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable title: network_id local_reference: xml: name: LocalReference 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. - To utilize the field in production, please contact with implementation manager - For India IMPS and UPI, local_reference is optional - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is not applicable title: |- local_reference - For Pay2China, this field is not applicable status: xml: name: Status type: object title: status properties: date_time: xml: name: DateTime type: string format: date-time description: |- UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - Date time of transaction status title: date_time code: xml: name: Code type: string description: ISO 20022 acknowledegment status code enum: - ACCC - RJCT - ACTC - PDNG title: code description: xml: name: Description type: string description: |- Status code description - ACCC - Completed - RJCT - Rejected - ACTC - Accepted - PDNG - Pending title: description required: - code - description - date_time reasons: xml: name: Reasons type: object title: reasons properties: code: xml: name: Code type: string description: >- Reason code (applicable when request is rejected/status.code = RJCT) - For Pay2China, local regulatory error code should be sent to client. 2201, 2202, 2203, 2204, 2205, 2206, 9000, 9001, 9007, 9019, 9042 maxLength: 4 title: code description: xml: name: Description type: string description: |- Reason code description - For Pay2China, local regulatory error code should be sent to client. 2201 - corporate merchant not qualified, 2202 - merchant id verification failed, 2203 - individual merchant not qualified, 2204 - merchant validation failed (Internal), 2205 - account name of the payee error, 2206 - Merchant Frozen, 9000 - request parameter [{}] cannot be empty, 9001 - request parameter [{}] format error, 9007 - request parameter [{}] is too long, 9019 - request parameter [{}] already exist, 9042 platform not exist or invalid minLength: 1 maxLength: 105 title: description response: xml: name: Response type: object title: response properties: type: xml: name: Type type: string description: >- Validation based on historic or real time data - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is mandatory - For UK,this field is mandatory - For IN PAN,this field is mandatory - For Pay2China, this field is not applicable - HR - Validation based on Historic Data if we don’t have a real time data - RT- Validation based on real time data and data source is present - ERROR - Erroneous issue enum: - HR - RT - ERROR title: type data_date_time: xml: name: DataDateTime type: string format: date-time description: >- Contains the provider datetime else current Datetime in UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is mandatory - For UK,this field is mandatory - For IN PAN,this field is mandatory - For Pay2China, this field is mandatory title: data_date_time validation_risk_score: xml: name: ValidationRiskScore type: string description: >- Risk appetite of utilizing this account. This field will be populated only in case of reponse.type = HR - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US,this field is conditional - For UK,this field is conditional - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable - HIGH - There is high risk the data subject to validations is inaccurate as per the source. - MEDIUM - There is moderate risk the data subject to validations is inaccurate as per the source. - LOW- There is Low risk the data subject to validations is inaccurate as per the source. - UNKNOWN- The risk is unknown. enum: - HIGH - MEDIUM - LOW - UNKNOWN - NA title: validation_risk_score account: xml: name: Account type: object title: account properties: number_validation: xml: name: NumberValidation type: string description: |- Account validation result - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional - For UK,this field is conditional - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable - MATCH - Validation based on account is a match - MISMATCH - Validation based on account is a mismatch - NA - Validation is not applicable enum: - MATCH - MISMATCH - NA title: number_validation name_validation: xml: name: NameValidation type: string description: |- Name validation result - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional - For UK,this field is conditional - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable - MATCH - Validation based on name is a match - MISMATCH - Validation based on name is a mismatch - PARTIALMATCH - Validation based on name is a partial match - NOTCHECKED - Validation not checked - NA - Validation is not applicable enum: - MATCH - MISMATCH - PARTIALMATCH - NA - NOTCHECKED title: name_validation address_validation: xml: name: AddressValidation type: string description: |- Address validation result - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional - For UK,this field is conditional - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable - MATCH - Validation based on address is a match - MISMATCH - Validation based on address is a mismatch - PARTIALMATCH - Validation based on address is a partial match - NOTCHECKED - Validation not checked - NA - Validation is not applicable enum: - MATCH - MISMATCH - PARTIALMATCH - NA - NOTCHECKED title: address_validation phone_validation: xml: name: PhoneValidation type: string description: |- Phone number validation result - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional - For UK,this field is conditional - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable - MATCH - Validation based on phone number is a match - MISMATCH - Validation based on phone number is a mismatch - PARTIALMATCH - Validation based on phone number is a partial match - NOTCHECKED - Validation not checked - NA - Validation is not applicable enum: - MATCH - MISMATCH - PARTIALMATCH - NA - NOTCHECKED title: phone_validation iban: xml: name: Iban type: object title: iban properties: structure_validation: xml: name: StructureValidation type: string description: |- IBAN mod 97 structure validation - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is conditional - For UK,this field is conditional - For IN PAN,this field is not applicable - For Pay2China, this field is not applicable - MATCH - Validation based on mod 97 is a match - MISMATCH - Validation based on mod 97 is a mismatch - NOTCHECKED - Validation not checked - NA - Validation is not applicable enum: - MATCH - MISMATCH - NA - NOTCHECKED title: structure_validation txid: xml: name: TxId type: object title: txid properties: number_validation: xml: name: NumberValidation type: string description: |- Document number validation result - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is conditional - For Pay2China, this field is not applicable - MATCH - Validation based on document number is a match - MISMATCH - Validation based on document number is a mismatch - NA - Validation is not applicable enum: - MATCH - MISMATCH - NA title: number_validation name_validation: xml: name: NameValidation type: string description: |- Document name validation result - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is conditional - For Pay2China, this field is not applicable - MATCH - Validation based on document name is a match - MISMATCH - Validation based on document name is a mismatch - NA - Validation is not applicable enum: - MATCH - MISMATCH - NA title: name_validation father_name_validation: xml: name: FatherNameValidation type: string description: >- Document father's name validation result - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is conditional - For Pay2China, this field is not applicable - MATCH - Validation based on document father's name is a match - MISMATCH - Validation based on document father's name is a mismatch - NA - Validation is not applicable enum: - MATCH - MISMATCH - NA title: father_name_validation date_of_birth_validation: xml: name: DateOfBirthValidation type: string description: |- Date of birth validation result - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is conditional - For Pay2China, this field is not applicable - MATCH - Validation based on date of birth is a match - MISMATCH - Validation based on date of birth is a mismatch - NA - Validation is not applicable enum: - MATCH - MISMATCH - NA title: date_of_birth_validation status: xml: name: Status type: string description: >- Status of the tax id document - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is conditional - For Pay2China, this field is not applicable - E- EXISTING AND VALID - F - Marked as Fake - X - Marked as Deactivated - D - Deleted - N - Record (PAN) Not Found in ITD Database/Invalid PAN - EA - Existing and Valid but event marked as Amalgamation in ITD database - EC - Existing and Valid but event marked as Acquisition in ITD database - ED - Existing and Valid but event marked as Death in ITD database - EI - Existing and Valid but event marked as Dissolution in ITD database - EL - Existing and Valid but event marked as Liquidated in ITD database - EM - Existing and Valid but event marked as Merger in ITD database - EP - Existing and Valid but event marked as Partition in ITD database - ES - Existing and Valid but event marked as Split in ITD database - EU - Existing and Valid but event marked as Under Liquidation in ITD database - NA - Validation is not applicable enum: - E - F - X - D - 'N' - EA - EC - ED - EI - EL - EM - EP - ES - EU - NA title: status seeding_status: xml: name: SeedingStatus type: string description: |- Seeding status from underlying services - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is conditional - For Pay2China, this field is not applicable - Y – Operative PAN - R - Inoperative PAN - NA -For all non-Individual PAN enum: - 'Y' - R - NA title: seeding_status mxid: xml: name: MxId type: object title: mxid properties: number_validation: xml: name: NumberValidation type: string description: |- Document number validation result - For India IMPS,this field is not applicable - For India UPI,this field is not applicable - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,this field is conditional - For Pay2China, this field is mandatory - MATCH - Validation based on document number is a match - MISMATCH - Validation based on document number is a mismatch - NA - for other than MATCH/MISMATCH status from ECO enum: - MATCH - MISMATCH title: number_validation required: - uetr - method - status securitySchemes: 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 responses: 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' Not-Found: description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error-Response' examples: Not-Found-Example: $ref: '#/components/examples/Not-Found-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' 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' 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' 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' Bad-Request-Pay2China: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error-Response' examples: Bad-Request-Example: $ref: '#/components/examples/Bad-Request-Example' application/xml: schema: $ref: '#/components/schemas/Error-Response' examples: Bad-Request-Example: $ref: '#/components/examples/Bad-Request-Example' Unauthorized-Pay2China: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error-Response' examples: Unauthorized-Example: $ref: '#/components/examples/Unauthorized-Example' application/xml: schema: $ref: '#/components/schemas/Error-Response' examples: Unauthorized-Example: $ref: '#/components/examples/Unauthorized-Example' Not-Found-Pay2China: description: Not Found content: application/json: schema: $ref: '#/components/schemas/Error-Response' examples: Not-Found-Example: $ref: '#/components/examples/Not-Found-Example' application/xml: schema: $ref: '#/components/schemas/Error-Response' examples: Not-Found-Example: $ref: '#/components/examples/Not-Found-Example' Method-Not-Allowed-Pay2China: 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' application/xml: schema: $ref: '#/components/schemas/Error-Response' examples: Method-Not-Allowed-Example: $ref: '#/components/examples/Method-Not-Allowed-Example' Conflict-Pay2China: 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' application/xml: 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' Unsupported-Media-Type-Pay2China: 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' application/xml: schema: $ref: '#/components/schemas/Error-Response' examples: Un-Supported-Media-Type-Example: $ref: '#/components/examples/Un-Supported-Media-Type-Example' Internal-Server-Error-Pay2China: 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' application/xml: schema: $ref: '#/components/schemas/Error-Response' examples: Internal-Server-Error-Example: $ref: '#/components/examples/Internal-Server-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 Refund-Notification: /refund-notification: post: parameters: - $ref: '#/components/parameters/Event-Type' - $ref: '#/components/parameters/Event-Name' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Refunds' examples: Refund Status - Completed: $ref: '#/components/examples/Ok-Refund-Response' Refund Status - Rejected: $ref: '#/components/examples/Ok-Refund-Response-Failed' responses: '202': description: Accepted content: application/json: schema: type: object examples: Ok-Refund-Response: value: end_to_end_id: r/434SKtUcdGQ refund_id: 4f09214d-296c-494b-8e9c-810bf1d9fc93 creation_date_time: '2022-09-13T08:23:49.112Z' value_date: '2022-09-13' instructed_amount: 29876.98 instructed_currency: THB status: date_time: '2022-09-13T08:23:49.112Z' code: ACCC description: Completed type: F original_payment: end_to_end_id: r/434SKtUcdGQ uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93 value_date: '2022-09-13' instructed_amount: 29876.98 instructed_currency: THB Ok-Refund-Response-Failed: value: end_to_end_id: r/434SKtUcdGQ refund_id: 4f09214d-296c-494b-8e9c-810bf1d9fc93 creation_date_time: '2022-09-13T08:23:49.112Z' value_date: '2022-09-13' instructed_amount: 29900.98 instructed_currency: THB status: date_time: '2022-09-13T08:23:49.112Z' code: RJCT description: Rejected type: P reasons: - code: AM02 description: Transaction instructed refund amount is > total payment amount original_payment: end_to_end_id: r/434SKtUcdGQ uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93 value_date: '2022-09-13' instructed_amount: 29876.98 instructed_currency: THB 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 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 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 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 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 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 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. 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. 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 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 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 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 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 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 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 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-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 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 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 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 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-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 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 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 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 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: 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. 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-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. 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. 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. 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. 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-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 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 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 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 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 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 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. 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. 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-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. 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-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 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. 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: 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-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. 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 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-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 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 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 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. 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-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 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' 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 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' 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 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' 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 Ok-Refund-Response-Multiple-Example: value: - end_to_end_id: r/434SKtUcdGQ refund_id: 4f09214d-296c-494b-8e9c-810bf1d9fc93 creation_date_time: '2022-09-13T08:23:49.112Z' value_date: '2022-09-13' instructed_amount: 29876.98 instructed_currency: THB status: date_time: '2022-09-13T08:23:49.112Z' code: ACCC description: Completed type: F original_payment: end_to_end_id: r/434SKtUcdGQ uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93 value_date: '2022-09-13' instructed_amount: 29876.98 instructed_currency: THB - end_to_end_id: r/434SKtUcdGQ refund_id: 4f09214d-296c-494b-8e9c-810bf1d9fc93 creation_date_time: '2022-09-13T08:23:49.112Z' value_date: '2022-09-13' instructed_amount: 29900.98 instructed_currency: THB status: date_time: '2022-09-13T08:23:49.112Z' code: RJCT description: Rejected type: P reasons: - code: AM02 description: Transaction instructed amount is not ≥ 0.01 & ≤ 2,000,000.00 original_payment: end_to_end_id: r/434SKtUcdGQ uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93 value_date: '2022-09-13' instructed_amount: 29876.98 instructed_currency: THB Th-Refund-Initiation-Request-Example: value: end_to_end_id: r/434SKtUcdGQ instructed_amount: 2987.96 instructed_currency: THB additional_info: Text original_payment: end_to_end_id: r/434SKtUcdGQ value_date: '2022-09-13' Br-Refund-Initiation-Request-Example: value: end_to_end_id: r/434SKtUcd77 instructed_amount: 100.01 instructed_currency: BRL additional_info: Refund Request original_payment: end_to_end_id: r/434SKtUaaGQ value_date: '2023-10-01' Us-Refund-Initiation-Request-Example: value: end_to_end_id: r/434SKtUcd01 instruction_id: 1245hgfdartyu1 instructed_amount: 200.01 instructed_currency: USD debtor: name: JOHN street_name: street building_number: No16 postal_code: '102546' city: New Jer state: New Town country: US ultimate_debtor: street_name: street postal_code: '102546' city: New Jer state: New Town country: US original_payment: end_to_end_id: r/434SKtUaaGQ value_date: '2023-11-01' SEPA-Refund-Initiation-Request-Example: value: end_to_end_id: r/434SKtUcd01 instructed_amount: 200.01 instructed_currency: EUR unstructured_remittance_info: - More details of refund return_reason_code: AM05 original_payment: end_to_end_id: r/434SKtUaaGQ value_date: '2023-11-01' 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 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 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 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 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 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-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 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 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' 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 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 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-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 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 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 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-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 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 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 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-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-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 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 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 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 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 Refund-Initiation-Response-Example: value: end_to_end_id: r/434SKtUcdGQ refund_id: 4f09214d-296c-494b-8e9c-810bf1d9fc93 instructed_amount: 29876.98 instructed_currency: THB additional_info: Text status: date_time: '2022-09-13T08:23:49.112Z' code: ACTC description: Accepted original_payment: end_to_end_id: r/434SKtUcdGQ uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93 value_date: '2022-09-13' Response-To-Request-For-Refund-Example: value: message_type: RRFR message: case_id: M20230411021000089T1BXPY09462848401 decision_code: PECR instructed_amount: 135.56 instructed_currency: USD payment_information_id: '1122334455' instruction_id: 2017111202120020101BSTRF00000000067 end_to_end_id: r/434SKtUcwBY status: null date_time: '2022-09-13T08:23:49.112Z' code: ACTC description: Accepted debtor: name: Kyne street_name: 2345 3rd Street building_number: A1234 postal_code: '98076' city: San Francisco state: CA country: US ultimate_debtor: name: Jul street_name: 7868 3rd Street building_number: BC567 postal_code: '99089' city: San Francisco state: CA country: US Response-To-Request-For-Information-Compliance-Example: value: message_type: RRFICS message: rrfics: alert_id: '209339209123' request_id: '123456' response_date_time: '2023-01-10T08:45:10.489Z' purpose_of_transaction: This payment is for order number 12345 additional_details: Payment was sent to vendor ABC for order number 12345 fieldlevel_responses: - field_id: M12345 field_name: UltimateCreditor.name field_value: Mohammed individual: name: John Terry Weiss street_name: BeakalWoldemariam building_number: 24324 postal_code: 22079 city: Lorton state: VA country: US birth_date: '1967-11-27' city_of_birth: San Francisco country_of_birth: US nationality: American occupation: occupation country_of_residence: US - field_id: M12346 field_name: UltimateDebtor.name field_value: Jesus entity: name: Drivers4Hire street_name: BeakalWoldemariam building_number: '324324' postal_code: '22079' city: Lorton state: VA country: US line_of_business: Transportation ownership_details: Uber US LLC global_presence: Thailand, India, Japan website: www.Drivers4Hire.com registration_number: US1234 country_of_incorporation: US OK-Response-To-Request-For-Information-Compliance: value: message_id: 7f0aa5afdf7c4850b2823b7eae259450 creation_date_time: '2024-10-16T14:13:10.953Z' original_payment: end_to_end_id: CCAPI0603180692 uetr: 5e9058c5-ef9e-40c9-aff4-f14bd8af6ae0 message_type: RRFICS message: rrfics: alert_id: '209339209123' request_id: '123456' response_date_time: '2023-01-10T08:45:10.489Z' purpose_of_transaction: This payment is for order number 12345 additional_details: Payment was sent to vendor ABC for order number 12345 fieldlevel_responses: - field_id: M12345 field_name: UltimateCreditor.name field_value: Mohammed individual: name: John Terry Weiss street_name: BeakalWoldemariam building_number: 24324 postal_code: 22079 city: Lorton state: VA country: US birth_date: '1967-11-27' city_of_birth: San Francisco country_of_birth: US nationality: American occupation: occupation country_of_residence: US - field_id: M12346 field_name: UltimateDebtor.name field_value: Jesus entity: name: Drivers4Hire street_name: BeakalWoldemariam building_number: '324324' postal_code: '22079' city: Lorton state: VA country: US line_of_business: Transportation ownership_details: Uber US LLC global_presence: Thailand, India, Japan website: www.Drivers4Hire.com registration_number: US1234 country_of_incorporation: US Response-To-Payment-Confirmation-Request-Example: value: message_id: 7f0aa5afdf7c4850b2823b7eae259450 creation_date_time: '2024-10-16T14:13:10.953Z' message_type: RPCR message: uetr: 4f09214d-296c-494b-8e9c-810bf1d9fc93 status: date_time: '2023-01-10T07:57:10.489Z' code: ACSC description: Accepted Th-Response-To-Payment-Confirmation-Sucess-Request-Example: value: message_type: RPCR message: case_id: M20230411021000089T1BXPY09462848401 end_to_end_id: r/434SKtUcdGQ payment_information_id: '1122334455' status: date_time: '2023-01-10T07:57:10.489Z' code: ACSC description: Accepted Th-Response-To-Payment-Confirmation-Reject-Request-Example: value: message_type: RPCR message: case_id: M20230411021000089T1BXPY09462848401 end_to_end_id: r/434SKtUcdGQ decision_code: RJNR payment_information_id: '1122334455' status: date_time: '2023-01-10T07:57:10.489Z' code: RJCT description: Rejected reasons: code: AM04 description: Amount received is not the amount agreed or expected Pending-Payment-Confirmation-Request: value: message_id: bea176bf1d5d48cc88fb1d0e06af89j4 creation_date_time: '2023-02-10T07:45:10.489Z' message_type: RPCR message: case_id: M20230411021000089T1BXPY09462848401 status: date_time: '2023-01-10T07:57:10.489Z' code: PDNG description: Pending Ok-Request-For-Payment: value: message_id: bea176bf1d5d48cc88fb1d0e06af89j4 creation_date_time: '2023-02-10T07:45:10.489Z' message_type: RFP message: debtor: account: '98078' account_name: Yuzi name: Karl bank_id: '099289' street_name: 1212 4th Street building_number: A6378 postal_code: '94158' city: San Francisco state: CA country: US org_id: GH4657 birth_date: '2023-01-02' birth_city: New York birth_country: US ultimate_debtor: name: Himan street_name: 1345 4th Street building_number: B5829 postal_code: '89934' city: Vegas state: CA country: US creditor: account: '900900981' account_name: Mike name: Yokal bank_id: '89332' street_name: 1212 7th Street building_number: V7839 postal_code: '50098' city: New York state: CA country: US org_id: AS2345 birth_date: '2023-01-03' birth_city: New Ark birth_country: US phone_number: +1-555-123-4567 ultmate_creditor: name: Pits street_name: 4th Avenue building_number: G6178 postal_code: '90213' city: New York state: CA country: US method: country: US instructed_currency: USD method: IP network: RTP transaction: type: debit end_to_end_id: r/434SKtUcdGT instruction_id: 2017111202120020101BSTRF00000000011 uetr: bea176bf-1d5d-48cc-88fb-1d0e06af87p5 creation_date_time: '2023-01-10T07:45:10.489Z' instructed_amount: 192.33 settlement_currency: USD unstructured_remittance_info: - This is example category: CONSUMER requested execution_date: '1992-07-17' requested execution_date_time: '2023-01-11T07:45:11.489Z' expiry_date: '1992-07-18' expiry_date_time: '2023-01-12T07:45:10.489Z' amt_mod_allowed: true full_amount: 192.33 discount_amount: 0 local_reference: 7634an78543 payment_information_id: 2023111202120020101BSRFP00000000013 purpose: INVS status: date_time: '2023-01-10T08:59:10.487Z' code: PRES description: Request For Payment has been presented to the Debtor OK-Request-For-Information-Compliance: value: message_id: 7f0aa5afdf7c4850b2823b7eae259450 creation_date_time: '2024-10-16T14:13:10.953Z' original_payment: end_to_end_id: CCAPI0603180692 uetr: 5e9058c5-ef9e-40c9-aff4-f14bd8af6ae0 message_type: RFICS message: transaction: end_to_end_id: '30820231' uetr: 5671c145-df7c-47df-b949-8824ddd776a7 status: date_time: '2023-08-30T15:59:41.048Z' code: PDNG description: Pending reasons: code: RECI description: >- Transaction is in compliance review request for further information rfics: alert_id: '209339209123' request_id: '123546' request_date_time: '2023-01-10T07:45:10.489Z' purpose_of_transaction_required: 'Y' additional_details_requested: Please provide additional details for this transaction fieldlevel_requests: - field_id: M12345 field_name: UltimateCreditor.name field_value: Mohammed input_type: individual - field_id: M12346 field_name: UltimateDebtor.name field_value: Jesus input_type: entity Response-To-Request-For-Payment-Example: value: message_type: RRFP message: decision_code: ACTC end_to_end_id: I364836174511719 accepted_amount: 500 accepted_currency: USD scheduled_exec_dat: '2023-10-02' Ok-Request-For-Refund: value: message_id: bea176bf1d5d48cc88fb1d0e06af90g5 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RFR original_payment: message_id: M2017111202120020101BTRF00000000011 creation_date_time: '2023-01-01T17:06:49.712Z' instruction_id: 2017111202120020101BSTRF00000000011 end_to_end_id: I364836174511668 transaction_id: 20230411021000089T1BXPAY09462848400 uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7 clearing_reference: 7634an78543 instructed_amount: 144.56 instructed_currency: USD value_date: '2023-01-01' message_name_identification: 123456BKLO debtor: bank_id: '021000089' name: John M street_name: 1515 3rd Street building_number: A1234 postal_code: '94158' city: San Francisco state: CA country: US org_id: '12333333' birth_date: '1950-09-26' birth_city: San Francisco birth_country: US creditor: bank_id: '000000010' name: BeakalWoldemariam street_name: 5th Street building_number: '123444' postal_code: '22079' city: Lorton state: CA country: US org_id: '6563' birth_date: '1967-11-27' birth_city: San Francisco birth_country: US message: country: US reasons: code: AC03 description: InvalidCreditorAccountNumber requestor_name: Khalq requestor_bank_id: '0027849' status: date_time: '2023-01-10T08:59:10.489Z' code: RJCT description: Rejected Ok-Request-For-Refund-SEPA: value: message_id: bea176bf1d5d48cc88fb1d0e06af90g5 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RFR original_payment: message_id: M2017111202120020101BTRF00000000011 creation_date_time: '2023-01-01T17:06:49.712Z' instruction_id: 2017111202120020101BSTRF00000000011 end_to_end_id: I364836174511668 transaction_id: 20230411021000089T1BXPAY09462848400 uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7 instructed_amount: 144.56 instructed_currency: EUR value_date: '2023-01-01' category_purpose: YUOP purpose: PAYR unstructured_remittance_info: - More details of transaction structured_remittance_info: creditor_reference_information_code: RADM creditor_reference: More details debtor: proxy_id: a93d@gmail.com 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_id: qwerty@kmail ultimate_creditor: name: Karl Lewis anybic: ABCJIE20 lei: ABCJIE20XXX org_id: 55879VB issuer: VBH pvt ltd birth_province: Cali message: case_id: M20230411021000089T1BXPY09462848401 requestor_lei: ABCDEFGH123456789012 requestor_org_id: '1234567' requestor_issuer: ABCDFHGY765432 reasons: code: AC03 description: InvalidCreditorAccountNumber requestor_name: Khalq requestor_bank_id: '0027849' status: date_time: '2023-01-10T08:59:10.489Z' code: RJCT description: Rejected Ok-Request-For-Refund-Uk: value: message_id: bea176bf1d5d48cc88fb1d0e06af90g5 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RFR original_payment: message_id: M2017111202120020101BTRF00000000011 creation_date_time: '2023-01-01T17:06:49.712Z' instruction_id: 2017111202120020101BSTRF00000000011 end_to_end_id: I364836174511668 transaction_id: 20230411021000089T1BXPAY09462848400 uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7 instructed_amount: 144.56 instructed_currency: GBP value_date: '2023-01-01' category_purpose: YUOP purpose: PAYR unstructured_remittance_info: - More details of transaction structured_remittance_info: creditor_reference: More details debtor: account: '520993444' bank_id: CITI0000027 creditor: bank_id: TYEG6758 prvt_id: HJK876 account: '5589076' message: case_id: M20230411021000089T1BXPY09462848401 reasons: code: AC03 description: InvalidCreditorAccountNumber requestor_name: Khalq status: date_time: '2023-01-10T08:59:10.489Z' code: RCVD description: Received Ok-Request-For-Refund-In: value: message_id: bea176bf1d5d48cc88fb1d0e06af90g5 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RFR original_payment: message_id: M2017111202120020101BTRF00000000011 creation_date_time: '2023-01-01T17:06:49.712Z' end_to_end_id: I364836174511668 transaction_id: 20230411021000089T1BXPAY09462848400 uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7 instructed_amount: 144.56 instructed_currency: INR value_date: '2023-01-01' debtor: account: '520993444' bank_id: CITI0000027 creditor: account: '1234567890123456' bank_id: CITI0000032 message: case_id: M20230411021000089T1BXPY09462848401 reasons: code: AC03 description: InvalidCreditorAccountNumber requestor_name: Khalq status: date_time: '2023-01-10T08:59:10.489Z' code: RCVD description: Received Ok-Request-For-Refund-Br: value: message_id: bea176bf1d5d48cc88fb1d0e06af90g5 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RFR original_payment: message_id: M2017111202120020101BTRF00000000011 creation_date_time: '2023-01-01T17:06:49.712Z' end_to_end_id: I364836174511668 transaction_id: 20230411021000089T1BXPAY09462848400 uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7 instructed_amount: 144.56 instructed_currency: BRL value_date: '2023-01-01' debtor: account: '520993444' bank_id: CITI0000027 creditor: account: '1234567890123456' bank_id: CITI0000032 message: case_id: M20230411021000089T1BXPY09462848401 reasons: code: AC03 description: InvalidCreditorAccountNumber requestor_name: Khalq status: date_time: '2023-01-10T08:59:10.489Z' code: RCVD description: Received Ok-Response-To-Request-For-Refund: value: message_id: bea176bf1d5d48cc88fb1d0e06af54y8 creation_date_time: '2023-01-10T08:50:10.489Z' message_type: RRFR original_payment: message_id: M2017111202120020101BTRF00000000011 creation_date_time: '2023-01-01T17:06:49.712Z' instruction_id: 2017111202120020101BSTRF00000000011 end_to_end_id: I364836174511668 transaction_id: 20230411021000089T1BXPAY09462848400 uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7 clearing_reference: 7634an78543 instructed_amount: 144.56 instructed_currency: USD value_date: '2023-01-01' message_name_identification: 123456BKLO debtor: bank_id: '021000089' name: John M street_name: 1515 3rd Street building_number: A1234 postal_code: '94158' city: San Francisco state: CA country: US org_id: '12333333' birth_date: '1950-09-26' birth_city: San Francisco birth_country: US creditor: bank_id: '000000010' name: BeakalWoldemariam street_name: 5th Street building_number: '123444' postal_code: '22079' city: Lorton state: CA country: US org_id: '6563' birth_date: '1967-11-27' birth_city: San Francisco birth_country: US message: case_id: M20230411021000089T1BXPY09462848401 decision_code: IPAY end_to_end_id: I364836174511668 instructed_amount: 144.56 instructed_currency: USD interbank_settlement_date: '2023-01-01' status: date_time: '2023-01-10T08:59:10.489Z' code: RCVD description: Received Ok-Response-To-Request-For-Refund-SEPA: value: message_id: bea176bf1d5d48cc88fb1d0e06af54y8 creation_date_time: '2023-01-10T08:50:10.489Z' message_type: RRFR original_payment: message_id: M2017111202120020101BTRF00000000011 creation_date_time: '2023-01-01T17:06:49.712Z' instruction_id: 2017111202120020101BSTRF00000000011 end_to_end_id: I364836174511668 transaction_id: 20230411021000089T1BXPAY09462848400 uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7 instructed_amount: 144.56 instructed_currency: EUR message_name_identification: ABCD12345 value_date: '2023-01-01' category_purpose: YUOP unstructured_remittance_info: - More details of transaction structured_remittance_info: creditor_reference_information_code: RADM creditor_reference: More details debtor: proxy_id: a93d@gmail.com 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 prvt_id: hdhfhahah 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_id: qwerty@kmail message_name_identification: ABCD12345 purpose: SALA ultimate_creditor: name: Karl Lewis anybic: ABCJIE20 lei: ABCJIE20XXX org_id: 55879VB issuer: VBH pvt ltd birth_province: Cali method: network: FDN message: case_id: M20230411021000089T1BXPY09462848401 decision_code: RJCR reasons: code: AM04 end_to_end_id: r/434SKtUcd01 Not-Ok-Response-To-Request-For-Refund: value: message_id: bea176bf1d5d48cc88fb1d0e06af54y8 creation_date_time: '2023-01-10T07:56:11.489Z' message_type: RRFR original_payment: message_id: M2017111202120020101BTRF00000000011 creation_date_time: '2023-01-01T17:06:49.712Z' instruction_id: 2017111202120020101BSTRF00000000011 end_to_end_id: I364836174511668 transaction_id: 20230411021000089T1BXPAY09462848400 uetr: bea176bf-1d5d-48cc-88fb-1d0e06af43e7 clearing_reference: 7634an78543 instructed_amount: 231.54 instructed_currency: USD value_date: '2023-01-02' debtor: bank_id: '021000089' name: John M street_name: 1515 3rd Street building_number: A1234 postal_code: '94158' city: San Francisco state: CA country: US org_id: '12333333' birth_date: '1950-09-26' birth_city: San Francisco birth_country: US creditor: bank_id: '000000033' name: BeakalWoldemariam street_name: 5th Street building_number: '123576' postal_code: '22089' city: Lorton state: CA country: US org_id: '6561' birth_date: '1967-11-27' birth_city: San Francisco birth_country: US message: case_id: M20230411021000089T1BXPY09462848401 decision_code: RJCR reasons: code: AM04 instructed_amount: 144.56 instructed_currency: USD interbank_settlement_date: '2023-01-01' status: date_time: '2023-01-10T07:50:10.489Z' code: RJCT description: Rejected reasons: code: AC03 description: Creditor account number invalid or missing Initial-Response-To-Request-For-Refund: value: message_id: bea176bf1d5d48cc88fb1d0e06af54y8 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RRFR message: case_id: M20230411021000089T1BXPY09462848401 decision_code: IPAY instructed_amount: 144.56 instructed_currency: USD end_to_end_id: r/434SKtUcdGQ status: date_time: '2023-01-10T07:47:10.489Z' code: PDNG description: Pending Initial-Response-To-Request-for-Information-Compliance: value: message_id: bea176bf1d5d48cc88fb1d0e06af54y8 creation_date_time: '2023-10-10T08:49:10.489Z' message_type: RRFICS message: uetr: bea176bf-1d5d-48cc-88fb-1d0e06af87p5 status: date_time: '2023-10-10T08:52:10.489Z' code: PDNG description: Pending Initial-Response-To-Payment-Confirmation-Request: value: message_id: bea176bf1d5d48cc88fb1d0e06af78b5 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RPCR message: uetr: bea176bf-1d5d-48cc-88fb-1d0e06af87p5 status: date_time: '2023-01-10T07:59:10.489Z' code: PDNG description: Pending Initial-Response-To-Request-For-Payment: value: message_id: bea176bf1d5d48cc88fb1d0e06af89n6 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RRFP message: uetr: bea176bf-1d5d-48cc-88fb-1d0e06af90k8 decision_code: ACTC end_to_end_id: I364836174511719 accepted_amount: 500 accepted_currency: USD scheduled_exec_dat: '2023-10-02' status: date_time: '2023-01-10T07:59:10.489Z' code: PDNG description: Pending Ok-Payment-Confirmation-Request: value: message_id: bea176bf1d5d48cc88fb1d0e06af89j4 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: PCR original_payment: instruction_id: 2017111202120020101BSTRF00000000011 message: debtor: account: '98078' name: Karl bank_id: '099289' bank_branch_id: BAC456 street_name: 1212 4th Street building_number: A6378 postal_code: '94158' city: San Francisco state: CA country: US org_id: GH4657 birth_date: '2023-01-02' birth_city: New York birth_country: US ultimate_debtor: name: Himan street_name: 1345 4th Street building_number: B5829 postal_code: '89934' city: Vegas state: CA country: US creditor: account: '900900981' name: Yokal bank_id: '89332' street_name: 1212 7th Street building_number: V7839 postal_code: '50098' city: New York state: CA country: US org_id: AS2345 birth_date: '2023-01-03' birth_city: New Ark birth_country: US ultmate_creditor: name: Pits street_name: 4th Avenue building_number: G6178 postal_code: '90213' city: New York state: CA country: US method: country: US instructed_currency: USD method: IP type: CT network: RTP transaction: type: credit end_to_end_id: r/434SKtUcdGT instruction_id: 2017111202120020101BSTRF00000000011 payment_information_id: '1122334455' uetr: bea176bf-1d5d-48cc-88fb-1d0e06af87b5 network_id: '889923283934' purpose: PAYR creation_date_time: '2023-01-10T07:45:10.489Z' value_date: '1992-07-16' instructed_amount: 192.33 settlement_currency: USD settlement_amount: 132.45 unstructured_remittance_info: - This is example interbank_settlement_date: '2022-09-13' advice_id: '234' advice_type: EMAL advice_address: mat@qmail.com category: CONSUMER Outgoing-Request-For-Refund-Example: value: message_type: RFR message: country: IE reasons: code: AM09 description: WrongAmount Uk-Stop-Request-Example: value: message_type: RFR message: country: GB reasons: code: AM09 description: WrongAmount In-Stop-Request-Example: value: message_type: RFR message: country: IN reasons: code: AM09 description: WrongAmount Br-Stop-Request-Example: value: message_type: RFR message: country: BR reasons: code: AM09 description: WrongAmount Initial-Outgoing-Request-For-Refund: value: message_id: bea176bf1d5d48cc88fb1d0e06af54y8 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RFR message: reasons: code: AM09 description: WrongAmount status: date_time: '2023-01-10T07:47:10.489Z' code: PDNG description: Pending Uk-Stop-Request: value: message_id: bea176bf1d5d48cc88fb1d0e06af54y8 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RFR message: country: GB reasons: code: AM09 description: WrongAmount status: date_time: '2023-01-10T07:47:10.489Z' code: PDNG description: Pending In-Stop-Request: value: message_id: bea176bf1d5d48cc88fb1d0e06af54y8 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RFR message: country: IN reasons: code: AM09 description: WrongAmount status: date_time: '2023-01-10T07:47:10.489Z' code: PDNG description: Pending Br-Stop-Request: value: message_id: bea176bf1d5d48cc88fb1d0e06af54y8 creation_date_time: '2023-01-10T07:45:10.489Z' message_type: RFR message: country: BR reasons: code: AM09 description: WrongAmount status: date_time: '2023-01-10T07:47:10.489Z' code: PDNG description: Pending In-Beneficiary-Validation-Request-Non-Penny: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 method: country: IN method: IMPS type: AER penny_test: NONPENNY In-Beneficiary-Validation-Request-Penny: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 method: country: IN method: IMPS type: AER penny_test: PENNY Upi-In-Beneficiary-Validation-Request: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John proxy_id: lbem0028@citibank creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 proxy_id: lbem0028@citibank method: country: IN method: UPI type: AER Upi-In-Mobile-Number-Beneficiary-Validation-Request: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John proxy_id: lbem0028@citibank creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 proxy_id: '9809056489' proxy_type: MBNO method: country: IN method: UPI type: AER Upi-In-UPI-ID-Beneficiary-Validation-Request: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John proxy_id: lbem0028@citibank creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 proxy_id: hailey21@okbank proxy_type: SHID method: country: IN method: UPI type: AER US-EWS-Beneficiary-Validation-Request: value: uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393890' name: Hopkin creditor: account: '927393445' name: Leo bank_id: FGHJ09890 address_lines: - ABCD#WERT street_name: 1515 3rd Street building_number: A1234 postal_code: '94158' city: San Francisco state: CA country: US birth_date: '1950-09-26' home_phone_number: +92-80808009 document: entity: PERSONAL type: CCPT number: M7891234 state: Dublin method: country: US method: BANKACCOUNT type: Ownership UK-Beneficiary-Validation-Request: value: uetr: 921a9445-97df-4118-9a55-68d14667656f debtor: account: '927393890' name: Hopkin creditor: account: '927393445' name: Leo bank_id: FGHJ09890 address_lines: - ABCD#WERT street_name: 1515 3rd Street building_number: A1234 postal_code: '94158' city: Manchester state: Leeds country: UK birth_date: '1950-09-26' home_phone_number: +92-80808009 document: entity: PERSONAL type: CCPT number: M7891234 state: Dublin method: country: GB method: BANKACCOUNT type: Ownership Pay2China-Beneficiary-Validation-Request: value: uetr: 921a9445-97df-4118-9a55-68d14667222f debtor: account: P39023128 name: Das ultimate_debtor: name: Ethan account: '403653000011' creditor: id: M20220520100001 work_phone_number: '19988886666' beneficial_owner: name: Dino id: '330001202219817201' document: entity: BUSINESS type: EMPL number: 91330100799655058B method: country: CN method: MERCHANTID type: Ownership In-Initial-Beneficiary-Validation-Response-Non-Penny: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 method: country: IN method: IMPS type: AER penny_test: NONPENNY creation_date_time: '2023-09-10T08:23:49.112Z' status: date_time: '2023-01-10T08:59:10.489Z' code: ACTC description: Accepted In-Initial-Beneficiary-Validation-Response-Penny: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 method: country: IN method: IMPS type: AER penny_test: PENNY creation_date_time: '2023-09-10T08:23:49.112Z' status: date_time: '2023-01-10T08:59:10.489Z' code: ACTC description: Accepted Upi-In-Initial-Beneficiary-Validation-Response: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John proxy_id: lbem0028@citibank creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 proxy_id: lbem0028@citibank method: country: IN method: UPI type: AER creation_date_time: '2023-09-10T08:23:49.112Z' status: date_time: '2023-01-10T08:59:10.489Z' code: ACTC description: Accepted Upi-In-Mobile-Number-Initial-Beneficiary-Validation-Response: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John proxy_id: lbem0028@citibank creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 proxy_id: '9809056489' proxy_type: MBNO method: country: IN method: UPI type: AER creation_date_time: '2023-09-10T08:23:49.112Z' status: date_time: '2023-01-10T08:59:10.489Z' code: ACTC description: Accepted Upi-In-UPI-ID-Initial-Beneficiary-Validation-Response: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John proxy_id: lbem0028@citibank creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 proxy_id: hailey21@okbank proxy_type: SHID method: country: IN method: UPI type: AER creation_date_time: '2023-09-10T08:23:49.112Z' status: date_time: '2023-01-10T08:59:10.489Z' code: ACTC description: Accepted US-EWS-Initial-Beneficiary-Validation-Response: value: uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393890' name: Hopkin creditor: account: '927393445' name: Leo bank_id: FGHJ09890 address_lines: - ABCD#WERT street_name: 1515 3rd Street building_number: A1234 postal_code: '94158' city: San Francisco state: CA country: US birth_date: '1950-09-26' home_phone_number: +92-80808009 document: entity: PERSONAL type: CCPT number: M7891234 state: Dublin method: country: US method: BANKACCOUNT type: Ownership status: date_time: '2024-01-10T08:59:10.489Z' code: ACTC description: Accepted creation_date_time: '2023-05-02T08:23:49.554Z' UK-Initial-Beneficiary-Validation-Response: value: uetr: 921a9445-97df-4118-9a55-68d14667656f debtor: account: '927393890' name: Hopkin creditor: account: '927393445' name: Leo bank_id: FGHJ09890 address_lines: - ABCD#WERT street_name: 1515 3rd Street building_number: A1234 postal_code: '94158' city: Manchester state: Leeds country: UK birth_date: '1950-09-26' home_phone_number: +92-80808009 document: entity: PERSONAL type: CCPT number: M7891234 state: Dublin method: country: GB method: BANKACCOUNT type: Ownership status: date_time: '2024-01-10T08:59:10.489Z' code: ACTC description: Accepted creation_date_time: '2023-05-02T08:23:49.554Z' Pay2China-Initial-Beneficiary-Validation-Response: value: uetr: 921a9445-97df-4118-9a55-68d14667222f debtor: account: P39023128 name: Das ultimate_debtor: name: Ethan account: '403653000011' creditor: id: M20220520100001 work_phone_number: '19988886666' beneficial_owner: name: Dino id: '330001202219817201' document: entity: BUSINESS type: EMPL number: 91330100799655058B method: country: CN method: MERCHANTID type: Ownership status: date_time: '2024-01-10T08:59:10.489Z' code: ACTC description: Accepted In-Final-Beneficiary-Validation-Response-Non-Penny: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' creditor: account: '927393908' name: Mathew resolved_name: Simon method: method: IMPS type: AER country: IN network: IMPS penny_test: NONPENNY creation_date_time: '2023-09-11T08:23:49.112Z' local_reference: 7634an78543 network_id: '209323283934' status: date_time: '2023-01-10T08:59:12.489Z' code: ACCC description: Completed Upi-In-Final-Beneficiary-Validation-Response: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: proxy_id: lbem0028@citibank creditor: proxy_id: lbem0028@citibank name: Mathew resolved_name: Simon method: method: UPI type: AER country: IN network: UPI creation_date_time: '2023-09-11T08:23:49.112Z' local_reference: 7634an78543 network_id: '209323283934' status: date_time: '2023-01-10T08:59:12.489Z' code: ACCC description: Completed Upi-In-Final-Mobile-Number-Beneficiary-Validation-Response: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John proxy_id: lbem0028@citibank creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 proxy_id: '9809056489' proxy_type: MBNO resolved_name: Simon upi_id: urik@okaxil method: method: UPI type: AER country: IN network: UPI creation_date_time: '2023-09-11T08:23:49.112Z' local_reference: 7634an78543 network_id: '209323283934' status: date_time: '2023-01-10T08:59:12.489Z' code: ACCC description: Completed Upi-In-Final-UPI-ID-Beneficiary-Validation-Response: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John proxy_id: lbem0028@citibank creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 proxy_id: hailey21@okbank proxy_type: SHID resolved_name: Simon upi_id: urik@okaxil method: method: UPI type: AER country: IN network: UPI creation_date_time: '2023-09-11T08:23:49.112Z' local_reference: 7634an78543 network_id: '209323283934' status: date_time: '2023-01-10T08:59:12.489Z' code: ACCC description: Completed Upi-In-Final-Mobile-Number-Beneficiary-Validation-Penny-Testing-Response: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' name: John proxy_id: lbem0028@citibank creditor: account: '927393908' name: Mathew bank_id: FGHJ0985026 proxy_id: '9809056489' proxy_type: MBNO resolved_name: Simon upi_id: urik@okaxil method: method: UPI type: AER country: IN network: UPI instructed_currency: INR transaction: purpose: SALA type: debit value_date: '2024-02-23' instructed_amount: '1' unstructured_remittance_info: - Penny Testing for batch_id: '1234' creation_date_time: '2023-09-11T08:23:49.112Z' local_reference: 7634an78543 network_id: '209323283934' status: date_time: '2023-01-10T08:59:12.489Z' code: ACCC description: Completed In-Final-Beneficiary-Validation-Response-Penny: value: end_to_end_id: r/434SKtUcd01 uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393038' creditor: account: '927393908' name: Mathew resolved_name: Simon method: method: IMPS type: AER country: IN network: IMPS instructed_currency: INR penny_test: PENNY transaction: purpose: SALA type: debit value_date: '2024-02-23' instructed_amount: '1' unstructured_remittance_info: - Penny Testing for batch_id: '1234' creation_date_time: '2023-09-11T08:23:49.112Z' local_reference: 7634an78543 network_id: '209323283934' status: date_time: '2023-01-10T08:59:12.489Z' code: ACCC description: Completed US-EWS-Final-Beneficiary-Validation-Response: value: uetr: 921a9445-97df-4118-9a55-68d14667624c creditor: account: '927393445' method: country: US method: BANKACCOUNT type: Ownership response: type: HR data_date_time: '2023-09-10T08:23:49.112Z' validation_risk_score: HIGH account: number_validation: MATCH name_validation: MATCH status: code: ACCC description: Completed date_time: '2024-09-10T08:23:49.112Z' creation_date_time: '2023-05-02T08:23:49.554Z' UK-Final-Beneficiary-Validation-Response: value: uetr: 921a9445-97df-4118-9a55-68d14667656f creditor: account: '927393445' method: country: GB method: BANKACCOUNT type: Ownership response: type: HR data_date_time: '2023-09-10T08:23:49.112Z' validation_risk_score: HIGH account: number_validation: MATCH name_validation: MATCH status: code: ACCC description: Completed date_time: '2024-09-10T08:23:49.112Z' creation_date_time: '2023-05-02T08:23:49.554Z' IN-PAN-Validation-Request: value: uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393890' name: Hopkin creditor: name: Leo father_name: Moss birth_date: '1950-09-26' document: type: TXID number: WERHJ9012B method: country: IN method: ID type: TAXID IN-PAN-Initial-Validation-Response: value: uetr: 921a9445-97df-4118-9a55-68d14667624c debtor: account: '927393890' name: Hopkin creditor: name: Leo father_name: Moss birth_date: '1950-09-26' document: type: TXID number: WERHJ9012B method: country: IN method: ID type: TAXID status: date_time: '2024-01-10T08:59:10.489Z' code: ACTC description: Accepted creation_date_time: '2023-05-02T08:23:49.554Z' IN-PAN-Final-Validation-Response: value: uetr: 921a9445-97df-4118-9a55-68d14667624c creditor: document: number: WERHJ9012B method: country: IN method: ID type: TAXID response: type: HR data_date_time: '2023-09-10T08:23:49.112Z' txid: number_validation: MATCH name_validation: MATCH father_name_validation: MATCH date_of_birth_validation: MATCH status: E seeding_status: 'Y' status: code: ACCC description: Completed date_time: '2024-09-10T08:23:49.112Z' creation_date_time: '2023-05-02T08:23:49.554Z' Pay2China-Final-Beneficiary-Validation-Positive-Response: value: uetr: 921a9445-97df-4118-9a55-68d14667222f debtor: account: P39023128 name: Das ultimate_debtor: name: Ethan account: '403653000011' creditor: id: M20220520100001 work_phone_number: '19988886666' beneficial_owner: name: Dino id: '330001202219817201' document: entity: BUSINESS type: EMPL number: 91330100799655058B method: country: CN method: MERCHANTID type: Ownership creation_date_time: '2024-09-10T08:23:49.111Z' status: code: ACCC description: Completed date_time: '2024-09-10T08:23:49.112Z' response: data_date_time: '2023-09-10T08:23:49.112Z' mxid: number_validation: MATCH Pay2China-Final-Beneficiary-Validation-Negative-Response: value: uetr: 921a9445-97df-4118-9a55-68d14667222f debtor: account: P39023128 name: Das ultimate_debtor: name: Ethan account: '403653000011' creditor: id: M20220520100001 work_phone_number: '19988886666' beneficial_owner: name: Dino id: '330001202219817201' document: entity: BUSINESS type: EMPL number: 91330100799655058B method: country: CN method: MERCHANTID type: Ownership creation_date_time: '2024-09-10T08:23:49.112Z' status: code: RJCT description: Rejected date_time: '2024-09-10T08:23:49.111Z' reasons: code: '9001' description: request parameter [creditor.beneficial_owner_id] format error response: data_date_time: '2023-09-10T08:23:49.112Z' mxid: number_validation: MISMATCH 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 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-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-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 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' 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' 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' 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' 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' 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' 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' 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' 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-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' 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' 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' 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' 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-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' 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' 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' 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 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 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 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. 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. 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 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. 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 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' 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' 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' 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 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 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' 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 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 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 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 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 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 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 Internal-Server-Error-Example: value: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - issue: Request was not processed code: CC00004