openapi: 3.2.0 info: title: Instant Payments Beneficiary Validation API 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' 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. 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 \n - Maximum length is 128. \n- CitiConnect API responds with an error (HTTP status 4XX) if your POST request idempotency identification value is a duplicate across a recent history of idempotency identifications in Citi's database. \n- If you don't receive any response (HTTP status 2XX, 4XX or 5XX) from Citi to your POST request and you wish to retry, reinitiate your request with the same idempotency identification to prevent accidental duplicate payment." requestBody: required: true description: This 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' /payment/beneficiarysearch: get: parameters: - description: Unique reference which was shared during CitiConnect API on-boarding(client_id which used during oauth token generation) in: query name: client_id required: true schema: type: string - description: Country where the request is initiated for beneficiary account search/validation in ISO 3166-1 alpha-2 format in: query name: country_code required: true schema: type: string pattern: ^[A-Z]{2}$ - description: Account name of the creditor intended for search/validation whose payment amount will be credited. For early warning system (EWS), if the verification_type = (BANKOWN or BASICVR) either creditor_firstname & creditor_lastname or creditor_name (Business Name) should be passed. Business name maximum allowed length 87 characters. in: query name: creditor_name schema: type: string maxLength: 140 minLength: 3 - description: Creditor account bank identification code of the creditor whose payment amount will be credited. - For early warning system (EWS), 9 digit beneficiary bank routing number. in: query name: creditor_bank_code schema: type: string maxLength: 11 minLength: 1 - description: 'Creditor Branch identification of the creditor whose payment amount will be credited. ##### Field exclusively applicable for below conditions - country_code = AR (Argentina), BR (Brazil), UY (Uruguay), PE (Peru), MX (Mexico), CO (Colombia)' in: query name: creditor_branch_id schema: type: string maxLength: 3 - description: 'Account alias name of the creditor intended for search/validation whose payment amount will be credited. ##### Field exclusively applicable for below conditions - country_code = AR (Argentina), BR (Brazil), UY (Uruguay), PE (Peru), MX (Mexico), CO (Colombia)' in: query name: creditor_alias schema: type: string maxLength: 140 minLength: 3 - description: Account name of the debtor whose payment amount will be deducted. in: query name: debtor_name schema: type: string maxLength: 140 minLength: 3 - description: 'Requested execution date post alias resolution when the payment needs to be processed for settlement, format would be YYYYMMDD ##### Field exclusively applicable for below countries - country_code = BR (Brazil) _Note_ * _If not provided present date will be populated when alias api is invoked_ * _Only Present and Future date will be acceptable and not past date_' in: query name: value_date schema: type: string maxLength: 8 - description: "Account & Proxy details intended for search/validation of Beneficiary details\n _Condition : It should be encrypted JSON combination of **creditor_account** or **creditor_proxy_type & creditor_proxy_value** should be passed along with **debtor_account**_\n - **debtor_account** \n - account number of the debtor whose payment amount will be deducted\n - max length is 35\n - mandatory\n - **creditor_account**\n - account number of the creditor whose payment amount will be credited & which requires validation\n - max length is 35\n - conditional\n\n - **creditor_proxy_type**\n - type of the proxy value to be used for validation/search\n - max length is 35\n - conditional \n - *Supported Types*\n\n * PHONE\n - Used as an identifier for providing Mobile/Phone Number in **creditor_proxy_value**\n * EMAIL\n - Used as an identifier for providing Email ID in **creditor_proxy_value**\n * TAXID\n - Used as an identifier for providing Tax Identification No in **creditor_proxy_value**\n - *Applicable only for country_code = BR (Brazil)*\n * EVP\n - Used as an identifier for providing EVP in **creditor_proxy_value**\n - *Applicable only for country_code = BR (Brazil)*\n * NIDN\n - Used as an identifier for providing NRIC Number in **creditor_proxy_value**\n * COID\n - Used as an identifier for providing Unique Entity Number in **creditor_proxy_value**\n * MOBN\n - Used as an identifier for providing Mobile number \n - **creditor_proxy_value**\n - value of proxy type to be used for validation/search\n - max length is 70\n - conditional\n - **document_type**\n - Originating Customer's Document Type. The values are:\n 1:LE \n2:DNI \n3:LM \n4:Pasaporte \n5:Carné de Extranjería \n6:RUC. \n - **document_number**\n - Originating Customer Document Number.In case the Originating Client's account is joint, the document number must be 99999999\n - max length is 12 \n - **creditor_document_number**\n - Creditor document number of credit account (both creditor document number and creditor tax id are same). It is mandatory for Brazil and Colombia and not applicable for other countries.\n - It is a Request header with string data type.\n - max length is 14\n - example: \"11111111111111\" \n - **creditor_account_type**\n - Creditor Account Type of Credit Account. It is mandatory for Brazil and Colombia and not applicable for other countries.\n - BR - The account type must be populated with following list of dominion:SAVINGS, CHECKING, PAYMENTS, EASY, PUBLIC_ENTITY. However validation is not required at CCAPI, whatever received by CCAPI will be routed to downstream and downstream will do the validation\n - CO - The account type must be populated with following list of dominion:CUENTA_DE_AHORRO and CUENTA_CORRIENTE. However validation is not required at CCAPI, whatever received by CCAPI will be routed to downstream and downstream will do the validation \n - It is a Request header with string data type.\n - maxLength: 15\n \n - **creditor_document_type**\n - Creditor Document Type of Credit Account.It is Optional for Brazil and Mandatory for Colombia and not applicable for other countries.\n - CO - The account type must be populated with following list of dominion:CC, CD, CE, NIT, TI, PAS, IEPN, IEPJ, FD, RC It is a Request header with string data type.\n - maxLength: 5\n - example: \"11111\"\n \n - **extra_information** \n - Creditor Document Type of Credit Account. This field is optional for Colombia and it is not applicable for other countries.\n - It is a Request header with string data type.\n - maxLength: 30\n - example: \"qwertyuiopasdfgjklzxcvbnm1234\" \n * JSON combination : \n\n * With Creditor Account \n\n {\"debtor_account\":\"123123\",\"creditor_account\":\"234324234\"}. \n\n * with Proxy detials \n\n {\"debtor_account\":\"123123\",\"creditor_proxy_type\":\"EMAIL\",\"creditor_proxy_value\":\"John@citi.com\"} \n \n *Note - Usage of both **creditor_account** + **creditor_proxy_type & creditor_proxy_value** will result in error response* \n \n **Example for encrypted-params:**\n eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMTI4Q0JDLUhTMjU2In0.cM5nUBLy-Nt4bmoS3YyKpMKVgc1zG2bhX1SLFLPmfOtmuv4vMYDPrFJSStlBK6KQqnNpeia6Er-Mvtoiy6d-x_cE_wZnkZdY-s7-mPKTWdB-1mQ9ev7sripvDcrvdV46aA8yIdat7j3C1guyIrQ3pixJLAWuWwYh-Mu9oQ5Y4fbt8hSyWUcrv50BVVHDTNhl1JfC9aMedo9RSZP4uVQrkuc64cSDs65F5CPrALSINWc1kWvtBdE00rFs8VPboFlOjzh8SWKUwhEWRGziRcBo0s0Rvjr1aS6xlXFK2xduWa2Yhww_i8x4LZPl4wuG0lYUxNfYfW-i1zPgbffpxEEoTg.56JMOGxrFjQNqUnaTrDnWw._UYD1vvZk6zcPpVX0WbxpVSCv_kbZjMbMfY9zbrAeQkEwd5-6l2LJ2X0rOnQrt6bvfMdxuT8_v5A4rpOX2BlOtKOOxkt1rxO1422HJcimejh2QCG9SK65_Gq202ZHUpertZsxP1So4NXD4E5yHPCMHkhgQCxEiZYAOweVmmAGR28J7P2faMUY0_y_PEOK6L8R-MuI7MJvO95vhdQcXsn1YirgkvWYWiO9AJX9UY-ES-VnBXu5ZtH3VtEcvYsydVFjssP83vObZehaRoz-vObYFRkm8oHEXmcEGNchXgUQ-w5UtpIk4EKX-rqOG-TYPPfJTU-z-QH5s0Z9fVVUKcYpyys6-5LSgpR_LMYxkTg3nTbTvN4RoDVglgzi_pLz2fHBC8tQXLk2FpXB8l9dQPOFdfaxVyS7eq14kmEPHdkh0lRxhCKS1hFgMxIo1YRGrJoeRfrb0E7im1lviZcXm_T0ZLZTFtmLOxaRhB69ggTH38OZLHP_NFFJHSwcP3EIwQ7LS_2PC1yOBj8ctCWbd4Ig2ZjT2K7KECHaam8ugAPo1PbGrt0okk1P5fFfCwd4YPr92tnyVugI-ngSL2VpIUz3w.Sa9VUUM13fNAFvovk7L-Hg\n" in: header name: encrypted-params required: true schema: type: string responses: '200': description: "**Complete Creditor account details will be part of response**\n\n**1. Generic Response:**\n```json\n{\n \"debtor\": {\n \"name\": \"XXXYXXX\",\n \"account_id\": \"0054400063\"\n },\n \"creditor\": {\n \"name\": \"ABCDEEFGH\",\n \"alias\": \"ABCDEEFGH\",\n \"resolved_name\": \"ABCDEEFGH\",\n \"owner_type\": \"LEGAL_PERSON\",\n \"tax_id\": \"12345678\",\n \"country_code\": \"BR\",\n \"bank_code\": \"ABCD123456\",\n \"branch_id\": \"076\",\n \"account_id\": \"1234567890\",\n \"proxy_type\": \"PHONE\",\n \"proxy_value\": \"5555141910097\",\n \"account_currency\": \"USD,UYU\",\n \"account_type\": \"SAVINGS\",\n \"account_opening_date\": \"20221203\",\n \"trade_name\": \"XYZ\",\n \"document_type\": \"RUC\",\n \"document_number\": \"91991923\"\n },\n \"additional_information\": {\n \"end_to_end_id\": \"XYXYX001\",\n \"value_date\": \"20220102\",\n \"proxy_status\": \"ACTIVE\",\n \"banelco_flag\": \"Y\",\n \"clearing_system_id\": \"3233423\"\n },\n \"lookup_status_information\": {\n \"lookup_reference\": \"ModifyAlias29122\",\n \"lookup_response_status\": \"Success\",\n \"status_code\": \"200\",\n \"status_message\": \"Success\"\n }\n} \n```\n\n**2. Argentina Response (country_code = AR):**\n ```json\n{\n \"creditor\": {\n \"alias\": \"ABCDEEFGH\",\n \"resolved_name\": \"ABCDEEFGH\",\n \"tax_id\": \"12345678\",\n \"branch_id\": \"076\",\n \"account_id\": \"1234567890\",\n \"account_type\": \"SAVINGS\"\n },\n \"additional_information\": {\n \"banelco_flag\": \"Y\",\n \"clearing_system_id\": \"3233423\"\n },\n \"lookup_status_information\": {\n \"lookup_response_status\": \"Success\",\n \"status_code\": \"200\",\n \"status_message\": \"Success\"\n }\n}\n```\n**3. US Response (country_code = US):**\n```json\n{\n \"creditor\": {\n \"resolved_name\": \"ABCDEEFGH\",\n \"proxy_value\": \"5555141910097\"\n },\n \"additional_information\": {\n \"proxy_status\": \"ACTIVE\"\n },\n \"lookup_status_information\": {\n \"status_code\": \"200\",\n \"status_message\": \"Success\"\n }\n}\n```\n**4. Korea Response (country_code = KR):**\n```json\n{\n \"creditor\": {\n \"resolved_name\": \"ABCDEEFGH\"\n },\n \"lookup_status_information\": {\n \"lookup_reference\": \"ModifyAlias29122\",\n \"lookup_response_status\": \"Success\",\n \"status_code\": \"200\",\n \"status_message\": \"Success\"\n }\n}\n```\n**5. India Response (country_code = IN):**\n```json\n{\n \"creditor\": {\n \"name\": \"ABCDEEFGH\",\n \"resolved_name\": \"ABCDEEFGH\",\n \"account_id\": \"1234567890\"\n },\n \"lookup_status_information\": {\n \"lookup_reference\": \"ModifyAlias29122\",\n \"lookup_response_status\": \"Success\",\n \"status_code\": \"200\",\n \"status_message\": \"Success\"\n }\n}\n```\n **6. Indonesia Response (country_code = ID):**\n```json\n{\n \"creditor\": {\n \"name\": \"ABCDEEFGH\",\n \"resolved_name\": \"ABCDEEFGH\",\n \"account_id\": \"1234567890\"\n },\n \"lookup_status_information\": {\n \"lookup_reference\": \"ModifyAlias29122\",\n \"lookup_response_status\": \"Success\",\n \"status_code\": \"200\",\n \"status_message\": \"Success\"\n }\n}\n```\n **7. Singapore Response (country_code = SG):**\n```json\n{\n \"creditor\": {\n \"resolved_name\": \"ABCDEEFGH\",\n \"proxy_value\": \"5555141910097\"\n },\n \"additional_information\": {\n \"proxy_status\": \"ACTIVE\"\n },\n \"lookup_status_information\": {\n \"status_code\": \"200\",\n \"status_message\": \"Success\"\n }\n}\n```\n **8. Brazil Alias Resolution (country_code = BR):**\n```json\n{\n \"creditor\": {\n \"resolved_name\": \"ABCDEEFGH\",\n \"owner_type\": \"LEGAL_PERSON\",\n \"tax_id\": \"12345678\",\n \"bank_code\": \"ABCD123456\",\n \"branch_id\": \"076\",\n \"account_id\": \"1234567890\",\n \"proxy_type\": \"PHONE\",\n \"proxy_value\": \"5555141910097\",\n \"account_type\": \"SAVINGS\",\n \"account_opening_date\": \"20221203\",\n \"trade_name\": \"XYZ\"\n },\n \"additional_information\": {\n \"end_to_end_id\": \"XYXYX001\",\n \"value_date\": \"20220102\",\n \"proxy_status\": \"ACTIVE\"\n }\n}\n```\n**9. LATAM Countries| Beneficiary Search (country_code = [ MX or PA or PE or UY or BR or CO ] ):**\n```json\n{\n \"debtor\": {\n \"account_id\": \"0054400063\"\n },\n \"creditor\": {\n \"resolved_name\": \"ABCDEEFGH\",\n \"country_code\": \"MX\",\n \"bank_code\": \"ABCD123456\",\n \"account_id\": \"1234567890\",\n \"account_currency\": \"USD,UYU\",\n \"account_type\": \"SAVINGS\",\n \"document_type\": \"RUC\",\n \"document_number\": \"91991923\"\n },\n \"lookup_status_information\": {\n \"lookup_response_status\": \"Success\",\n \"status_code\": \"200\",\n \"status_message\": \"Success\"\n }\n}\n```\n**10. US_EWS Response (country_code = US_EWS):**\n```json\n{\n \"creditor\": {\n \"account_verification_status\": \"Passed\",\n \"account_verification_description\": \"Account sucessfully verfied in EWS\",\n \"account_type\": \"Saving\",\n \"account_owner_status\": \"Passed\",\n \"account_owner_description\": \"Account owner sucessfully verfied in EWS\",\n \"owner_type\": \"OWN\",\n \"firstname\": \"FMATCH\",\n \"lastname\": \"PMATCH\",\n \"dob\": \"NAVAIL\",\n \"address_line1\": \"PMATCH\",\n \"address_line2\": \"PMATCH\",\n \"city\": \"FMATCH\",\n \"state\": \"FMATCH\",\n \"zip\": \"FMATCH\",\n \"home_phone\": \"FMATCH\",\n \"work_phone\": \"FMATCH\",\n \"tax_id\": \"PMATCH\",\n \"id_type\": \"FMATCH\",\n \"id_no\": \"FMATCH\",\n \"id_issuance_place\": \"NMATCH\",\n \"additional_information\": \"TESTING EWS RESPONSE\",\n \"creditor_name\": \"FMATCH\"\n }\n}\n```\n" content: application/json: schema: $ref: '#/components/schemas/BeneficiaryValidationResponse' example: debtor: name: XXXYXXX account_id: '0054400063' creditor: name: ABCDEEFGH alias: ABCDEEFGH resolved_name: ABCDEEFGH owner_type: LEGAL_PERSON tax_id: '12345678' country_code: BR bank_code: ABCD123456 branch_id: '076' account_id: '1234567890' proxy_type: PHONE proxy_value: '5555141910097' account_currency: USD,UYU account_type: SAVINGS account_opening_date: '20221203' trade_name: XYZ document_type: RUC document_number: '91991923' additional_information: end_to_end_id: XYXYX001 value_date: '20220102' proxy_status: ACTIVE banelco_flag: Y clearing_system_id: '3233423' lookup_status_information: lookup_reference: ModifyAlias29122 lookup_response_status: Success status_code: '200' status_message: Success application/xml: schema: $ref: '#/components/schemas/BeneficiaryValidationResponse' example: debtor: name: XXXYXXX account_id: '0054400063' creditor: name: ABCDEEFGH alias: ABCDEEFGH resolved_name: ABCDEEFGH owner_type: LEGAL_PERSON tax_id: '12345678' country_code: BR bank_code: ABCD123456 branch_id: '076' account_id: '1234567890' proxy_type: PHONE proxy_value: '5555141910097' account_currency: USD,UYU account_type: SAVINGS account_opening_date: '20221203' trade_name: XYZ document_type: RUC document_number: '91991923' additional_information: end_to_end_id: XYXYX001 value_date: '20220102' proxy_status: ACTIVE banelco_flag: Y clearing_system_id: '3233423' lookup_status_information: lookup_reference: ModifyAlias29122 lookup_response_status: Success status_code: '200' status_message: Success '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: VC00002 issue: invalid value provided for property debtor_account action: please provide valid value for property debtor_account - code: VC00002 issue: invalid value provided for property country_code action: please provide valid value for property country_code, in format ^[A-Z]{2}$ - code: VC00002 issue: invalid value provided for property creditor_account action: please provide valid value for property creditor_account - code: VC00002 issue: invalid value provided for property creditor_bank_code action: please provide valid value for property creditor_bank_code application/xml: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: VC00002 issue: invalid value provided for property debtor_account action: please provide valid value for property debtor_account - code: VC00002 issue: invalid value provided for property country_code action: please provide valid value for property country_code, in format ^[A-Z]{2}$ - code: VC00002 issue: invalid value provided for property creditor_account action: please provide valid value for property creditor_account - code: VC00002 issue: invalid value provided for property creditor_bank_code action: please provide valid value for property creditor_bank_code '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00007 issue: Authorization failed action: Please try again with valid credentials. application/xml: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00007 issue: Authorization failed action: Please try again with valid credentials. '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00006 issue: requested resource not found action: please try again later. application/xml: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00006 issue: requested resource not found action: please try again later. '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00001 action: Please use valid Http Verb. issue: Method Not Allowed application/xml: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00001 issue: Method Not Allowed action: Please use valid Http Verb. '500': description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00004 action: Please try again after sometime issue: Internal error , Unable to process the request at this moment application/xml: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00004 action: Please try again after sometime issue: Internal error , Unable to process the request at this moment '503': description: Service Unavailable content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00011 issue: unable to serve your request at this moment action: Not in business hours. Please try after sometime application/xml: schema: $ref: '#/components/schemas/ErrorResponse' example: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - code: CC00011 issue: unable to serve your request at this moment action: Not in business hours. Please try after sometime tags: - Beneficiary Validation description: This API allows the client to retrieve beneficiary details. operationId: getBeneficiaryDetails summary: Retrieve the Beneficiary details for a given debit and credit account number of… components: examples: Method-Not-Allowed-Example: value: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - issue: HTTP method is not supported action: Provide valid HTTP method code: CC00001 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 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 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 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 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 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 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 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 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-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 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 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' 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 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 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 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 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 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 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-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 Bad-Request-Example: value: ref_id: 444d0f3f-4x55-7g99-8b2c-0cf2a921a5ab error_details: - issue: instructed_amount is missing action: Provide valid instructed_amount code: VC00010 Internal-Server-Error-Example: value: ref_id: ec689822-9864-4c4d-9d68-222467627902 error_details: - issue: Request was not processed code: CC00004 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' 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-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 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-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-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 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 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 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 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 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 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 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' responses: 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' Unauthorized: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Error-Response' examples: Unauthorized-Example: $ref: '#/components/examples/Unauthorized-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' 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: 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-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' 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' 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: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/Error-Response' examples: Internal-Server-Error-Example: $ref: '#/components/examples/Internal-Server-Error-Example' Method-Not-Allowed: description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/Error-Response' examples: Method-Not-Allowed-Example: $ref: '#/components/examples/Method-Not-Allowed-Example' Bad-Request-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' Bad-Request: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error-Response' examples: Bad-Request-Example: $ref: '#/components/examples/Bad-Request-Example' schemas: Address: type: string maxLength: 70 minLength: 1 maxItems: 7 description: Address title: Address 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 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. \n - For India IMPS and UPI, this field is mandatory and max length is 16 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n- 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 \n - For India IMPS and UPI , this field is mandatory and max length is 34 \n - For US EWS, this field is mandatory and max length is 40 \n - For UK, this field is mandatory and max length is 40 \n - For IN PAN, this field is mandatory and max length is 40 \n - 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.\n - For India IMPS and UPI ,this field is mandatory and max length is 99 \n - For US EWS,this field is optional and max length is 140 \n - For UK,this field is optional and max length is 140 \n - For IN PAN,this field is optional and max length is 140 \n - 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.\n - For India,this field is mandatory for UPI only and max length is 255 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India, this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable. \n - 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. \n - For IMPS India,this field is mandatory and max length is 34 \n - For UPI India, this field is optional and length should be 34 \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - 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.\n - For India IMPS and UPI,this field is optional and max length is 99 \n - 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 \n - For UK,this field is mandatory and max length is 87. Please provide first middle(if any) last name in this sequence with spaces \n - 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 \n - 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.\n - For India IMPS and UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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 \n - 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.\n - For IMPS India,this field is mandatory and length should be 11 \n - For UPI India,this field is optional and length should be 11 \n - For US EWS,this field is mandatory and length should be 9 if routing/clearing code is populated \n - For UK,this field is mandatory and length should be 8 or 11 character if bic (including branch code) is sent \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n - 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 \n - 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 \n - 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\n - For IN PAN,this field is not applicable \n - 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 \n - For India,this field is optional for UPI only if mobile number needs to be passed in creditor.proxy_id \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n- MBNO - Mobile Number \n- SHID - Scheme identification number (eg. VPA ID) \n - For IN Pay2China,this field is not applicable " enum: - MBNO - SHID title: proxy_type wallet: xml: name: Wallet type: string description: "Creditor wallet details \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - For IN Pay2China,this field is not applicable" minLength: 1 maxLength: 40 title: wallet IBAN: xml: name: Iban type: string description: "Creditor IBAN number \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional and allowed 2 lines with each line max length of 40 \n - For UK, this field is optional and allowed 2 lines with each line max length of 40 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 70 \n - For UK, this field is optional with max length 70 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 16 \n - For UK, this field is optional with max length 16 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 10 \n - For UK, this field is optional with max length 16 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 25 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is not applicable \n - For IN Pay2China,this field is not applicable" title: city state: xml: name: State maxLength: 35 minLength: 1 type: string description: "Creditor's state \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 25 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is not applicable \n - For IN Pay2China,this field is not applicable" title: state country: xml: name: Country type: string description: "Creditor's country \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 2 \n - For UK, this field is optional with max length 2 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional \n - For UK, this field is optional \n - For IN PAN,this field is mandatory \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 10 \n - For UK, this field is optional with max length 34 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 10 \n - For UK, this field is optional with max length 34 \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n- For US EWS,this field is optional \n- For UK,this field is optional \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n- For US EWS,this field is optional \n- For UK,this field is optional \n - For IN PAN,this field is mandatory with applicable value TXID \n - 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 \n- Personal Code values \n- ARNU AlienRegistrationNumber \n- CCPT PassportNumber \n- CUST CustomerIdentificationNumber \n- DRLC DriversLicenseNumber \n- EMPL EmployeeIdentificationNumber \n- NIDN NationalIdentityNumber \n- SOSE SocialSecurityNumber \n- TELE TelephoneNumber \n- TXID TaxIdentificationNumber \n- POID PersonCommercialIdentification \n - Corporate Code values \n- BANK BankPartyIdentification \n- CBID Central Bank Identification Number \n- CHID Clearing Identification Number \n- COID CountryIdentificationCode \n- CUST CustomerNumber \n- DUNS Data Universal Numbering System \n- EMPL EmployerIdentificationNumber \n- GS1G GS1GLNIdentifier \n- SREN SIREN \n- SRET SIRET \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 28 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is mandatory with max length 10\n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 6 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is not applicable \n - 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) \n - For India,this field is mandatory and allowed value is AER \n - For US EWS,this field is mandatory \n- For UK,this field is mandatory \n- Ownership - Account ownership is limited to validation of correct owner , hence the account number or equivalent ( i.e Virtual account) and Name \n- 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. \n- Structure - Structure refers to the mod 97 and the length as per the country of IBAN \n- TAXID- Validation of individual or corporate tax id/tax documentation \n - 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 \n- 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) \n- 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 \n- ACTC - Accepted" title: description required: - code - description - date_time 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. \n - For India IMPS and UPI, this field is mandatory and max length is 16 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS and UPI , this field is mandatory and max length is 34 \n - For US EWS, this field is mandatory and max length is 40 \n - For UK, this field is mandatory and max length is 40 \n - For IN PAN, this field is mandatory and max length is 40 \n - 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.\n - For India IMPS and UPI ,this field is mandatory and max length is 99 \n - For US EWS,this field is optional and max length is 140 \n - For UK,this field is optional and max length is 140 \n - For IN PAN,this field is optional and max length is 140 \n - 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.\n - For India,this field is mandatory for UPI only and max length is 255 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India, this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable. \n - 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. \n - For IMPS India,this field is mandatory and max length is 34 \n - For UPI India, this field is optional and length should be 34 \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - 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.\n - For India IMPS and UPI,this field is optional and max length is 99 \n - 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 \n - For UK,this field is mandatory and max length is 87. Please provide first middle(if any) last name in this sequence with spaces \n - 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 \n - 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.\n - For India IMPS and UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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 \n - 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.\n - For IMPS India,this field is mandatory and length should be 11 \n - For UPI India,this field is optional and length should be 11 \n - For US EWS,this field is mandatory and length should be 9 if routing/clearing code is populated \n - For UK,this field is mandatory and length should be 8 or 11 character if bic (including branch code) is sent \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n - 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 \n - 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 \n - 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\n - For IN PAN,this field is not applicable \n - 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 \n - For India,this field is optional for UPI only if mobile number needs to be passed in creditor.proxy_id \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n- MBNO - Mobile Number \n- SHID - Scheme identification number (eg. VPA ID) \n - For Pay2China, this field is not required " enum: - MBNO - SHID title: proxy_type wallet: xml: name: Wallet type: string description: "Creditor wallet details \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not required" minLength: 1 maxLength: 40 title: wallet IBAN: xml: name: Iban type: string description: "Creditor IBAN number \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional and allowed 2 lines with each line max length of 40 \n - For UK, this field is optional and allowed 2 lines with each line max length of 40 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 70 \n - For UK, this field is optional with max length 70 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 16 \n - For UK, this field is optional with max length 16 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 10 \n - For UK, this field is optional with max length 16 \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not required" title: postal_code city: xml: name: City maxLength: 35 minLength: 1 type: string description: "Creditor's city \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 25 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not required" title: city state: xml: name: State maxLength: 35 minLength: 1 type: string description: "Creditor's state \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 25 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not required" title: state country: xml: name: Country type: string description: "Creditor's country \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 2 \n - For UK, this field is optional with max length 2 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional \n - For UK, this field is optional \n - For IN PAN,this field is mandatory \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 10 \n - For UK, this field is optional with max length 34 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 10 \n - For UK, this field is optional with max length 34 \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n- For US EWS,this field is optional \n- For UK,this field is optional \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n- For US EWS,this field is optional \n- For UK,this field is optional \n - For IN PAN,this field is mandatory with applicable value TXID \n - 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 \n- Personal Code values \n- ARNU AlienRegistrationNumber \n- CCPT PassportNumber \n- CUST CustomerIdentificationNumber \n- DRLC DriversLicenseNumber \n- EMPL EmployeeIdentificationNumber \n- NIDN NationalIdentityNumber \n- SOSE SocialSecurityNumber \n- TELE TelephoneNumber \n- TXID TaxIdentificationNumber \n- POID PersonCommercialIdentification \n - Corporate Code values \n- BANK BankPartyIdentification \n- CBID Central Bank Identification Number \n- CHID Clearing Identification Number \n- COID CountryIdentificationCode \n- CUST CustomerNumber \n- DUNS Data Universal Numbering System \n- EMPL EmployerIdentificationNumber \n- GS1G GS1GLNIdentifier \n- SREN SIREN \n- SRET SIRET \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 28 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is mandatory with max length 10 \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 6 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is not applicable \n - 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) \n - For India,this field is mandatory and allowed value is AER \n - For US EWS,this field is mandatory \n- For UK,this field is mandatory \n- Ownership - Account ownership is limited to validation of correct owner , hence the account number or equivalent ( i.e Virtual account) and Name \n- 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. \n- Structure - Structure refers to the mod 97 and the length as per the country of IBAN \n- TAXID- Validation of individual or corporate tax id/tax documentation \n - 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 \n- Applicable for IN IMPS" enum: - NONPENNY - PENNY - BOTH title: penny_test required: - country - method - type Unstructured: type: string maxLength: 140 minLength: 1 description: Unstructured remitance information title: Unstructured 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. \n - For India IMPS and UPI, this field is mandatory and max length is 16 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n - For India UPI and IMPS,this field is mandatory and max length is 34 \n - For US EWS, this field is optional and max length is 40 \n - For UK, this field is optional and max length is 40 \n - For IN PAN, this field is optional and max length is 40 \n - 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.\n - For India IMPS and UPI ,this field is mandatory and max length is 99 \n - For US EWS,this field is optional and max length is 140 \n - For UK,this field is optional and max length is 140 \n - For IN PAN,this field is optional and max length is 140 \n - For Pay2China, this field is not applicable" minLength: 1 maxLength: 140 title: name proxy_id: xml: name: ProxyId type: string description: "Remitter Proxy ID.\n - For India,this field is mandatory for UPI only and max length is 255 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India, this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable. \n - 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. \n - For India IMPS ,this field is mandatory and max length is 34 \n - For India UPI ,this field is optional and max length is 34 \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not applicable" minLength: 1 maxLength: 40 title: account name: xml: name: Name type: string description: "Creditor Account Name.\n - For India IMPS and UPI,this field is optional and max length is 99 \n - 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 \n - For UK,this field is optional and max length is 87. Please provide first middle(if any) last name in this sequence with spaces \n - 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 \n - 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.\n - For India IMPS and UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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 \n - 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.\n - For India IMPS,this field is mandatory and length should be 11 \n - For India UPI ,this field is conditional(available for successful validation) and max length is 11 \n - For US EWS,this field is optional and length should be 9 if routing/clearing code is populated \n - For UK,this field is optional and length should be 8 or 11 character if bic (including branch code) is sent \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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.\n - For India IMPS and UPI,this field is mandatory and max length is 99 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n - For India,this field is mandatory for UPI only and max length is 255 (UPI ID or Mobile number can be passed) \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - 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 \n - For India,this field is optional for UPI \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n- MBNO - Mobile Number \n- SHID - Scheme identification number (eg. VPA ID) \n - 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 \n - For India,this field is conditional for UPI only and max length is 255 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - For Pay2China,this field is not applicable" minLength: 1 maxLength: 255 title: upi_id wallet: xml: name: Wallet type: string description: "Creditor wallet details \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - For Pay2China,this field is not applicable" minLength: 1 maxLength: 40 title: wallet IBAN: xml: name: Iban type: string description: "Creditor IBAN number \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - 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 \n - 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 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional and allowed 2 lines with each line max length of 40 \n - For UK, this field is optional and allowed 2 lines with each line max length of 40 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 70 \n - For UK, this field is optional with max length 70 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 16 \n - For UK, this field is optional with max length 16 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 10 \n - For UK, this field is optional with max length 16 \n - For IN PAN,this field is not applicable \n - For Pay2China,this field is not applicable" title: postal_code city: xml: name: City maxLength: 35 minLength: 1 type: string description: "Creditor's city \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 25 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is not applicable \n - For Pay2China,this field is not applicable" title: city state: xml: name: State maxLength: 35 minLength: 1 type: string description: "Creditor's state \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 25 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is not applicable \n - For Pay2China,this field is not applicable" title: state country: xml: name: Country type: string description: "Creditor's country \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 2 \n - For UK, this field is optional with max length 2 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional \n - For UK, this field is optional \n - For IN PAN, this field is optional \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 10 \n - For UK, this field is optional with max length 34 \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 10 \n - For UK, this field is optional with max length 34 \n - For IN PAN,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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. \n - For IMPS India,this field is not applicable \n - For UPI India,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n- For US EWS,this field is optional \n- For UK,this field is optional \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n- For US EWS,this field is optional \n- For UK,this field is optional \n - For IN PAN,this field is optional \n - For Pay2China,this field is not applicable \n- Personal Code values \n- ARNU AlienRegistrationNumber \n- CCPT PassportNumber \n- CUST CustomerIdentificationNumber \n- DRLC DriversLicenseNumber \n- EMPL EmployeeIdentificationNumber \n- NIDN NationalIdentityNumber \n- SOSE SocialSecurityNumber \n- TELE TelephoneNumber \n- TXID TaxIdentificationNumber \n- POID PersonCommercialIdentification \n - Corporate Code values \n- BANK BankPartyIdentification \n- CBID Central Bank Identification Number \n- CHID Clearing Identification Number \n- COID CountryIdentificationCode \n- CUST CustomerNumber \n- DUNS Data Universal Numbering System \n- EMPL EmployerIdentificationNumber \n- GS1G GS1GLNIdentifier \n- SREN SIREN \n- SRET SIRET \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 28 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is optional with max length 10 \n - For Pay2China,this field is not applicable" title: number state: xml: name: State maxLength: 35 minLength: 1 type: string description: "Creditor's document state \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS, this field is optional with max length 6 \n - For UK, this field is optional with max length 35 \n - For IN PAN,this field is not applicable \n - 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) \n - For India,this field is mandatory and allowed value is AER \n - For US EWS,this field is mandatory \n- For UK,this field is mandatory \n- Ownership - Account ownership is limited to validation of correct owner , hence the account number or equivalent ( i.e Virtual account) and Name \n- 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. \n- Structure - Structure refers to the mod 97 and the length as per the country of IBAN \n- TAXID- Validation of individual or corporate tax id/tax documentation \n - 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) \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - For Pay2China,this field is not applicable" title: network instructed_currency: xml: name: InstructedCurrency type: string description: "Currency code \n- For India IMPS and UPI, this field is conditional and applicable only for penny transaction \n- For India UPI, this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n- 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. \n- For India IMPS and UPI, this field is conditional and applicable only for penny transaction and max length is 4 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n- For India IMPS and UPI, this field is conditional and applicable only for penny transaction and max length is 8 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n- For India IMPS and UPI, this field is conditional and applicable only for penny transaction \n- 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 \n Populate the present date in local timezone \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not applicable" instructed_amount: xml: name: InstructedAmount title: instructed_amount type: string description: "Instructed Amount.\n- For India IMPS and UPI, this field is conditional and applicable only for penny transaction and max length is 17 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n- 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 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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) \n- For India IMPS and UPI, this field is conditional and applicable only for penny transaction \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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 \n - For India IMPS and UPI, this field is optional and max length is 12 \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable \n - 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. \n- To utilize the field in production, please contact with implementation manager \n - For India IMPS and UPI, local_reference is optional \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is not applicable" title: "local_reference \n - 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) \n- 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 \n- ACCC - Completed \n- RJCT - Rejected \n - ACTC - Accepted \n- 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) \n - 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 \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is mandatory \n - For UK,this field is mandatory \n - For IN PAN,this field is mandatory \n - For Pay2China, this field is not applicable \n- HR - Validation based on Historic Data if we don’t have a real time data \n - RT- Validation based on real time data and data source is present \n- 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) \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is mandatory \n - For UK,this field is mandatory \n - For IN PAN,this field is mandatory \n - 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US,this field is conditional \n - For UK,this field is conditional \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not applicable \n- HIGH - There is high risk the data subject to validations is inaccurate as per the source. \n- MEDIUM - There is moderate risk the data subject to validations is inaccurate as per the source. \n- LOW- There is Low risk the data subject to validations is inaccurate as per the source. \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is conditional \n - For UK,this field is conditional \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not applicable \n- MATCH - Validation based on account is a match \n - MISMATCH - Validation based on account is a mismatch \n- NA - Validation is not applicable" enum: - MATCH - MISMATCH - NA title: number_validation name_validation: xml: name: NameValidation type: string description: "Name validation result \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is conditional \n - For UK,this field is conditional \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not applicable \n- MATCH - Validation based on name is a match \n - MISMATCH - Validation based on name is a mismatch \n - PARTIALMATCH - Validation based on name is a partial match \n- NOTCHECKED - Validation not checked \n- NA - Validation is not applicable" enum: - MATCH - MISMATCH - PARTIALMATCH - NA - NOTCHECKED title: name_validation address_validation: xml: name: AddressValidation type: string description: "Address validation result \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is conditional \n - For UK,this field is conditional \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not applicable \n- MATCH - Validation based on address is a match \n - MISMATCH - Validation based on address is a mismatch \n - PARTIALMATCH - Validation based on address is a partial match \n- NOTCHECKED - Validation not checked \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is conditional \n - For UK,this field is conditional \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not applicable \n- MATCH - Validation based on phone number is a match \n - MISMATCH - Validation based on phone number is a mismatch \n - PARTIALMATCH - Validation based on phone number is a partial match \n- NOTCHECKED - Validation not checked \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is conditional \n - For UK,this field is conditional \n - For IN PAN,this field is not applicable \n - For Pay2China, this field is not applicable \n- MATCH - Validation based on mod 97 is a match \n - MISMATCH - Validation based on mod 97 is a mismatch \n- NOTCHECKED - Validation not checked \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is conditional \n - For Pay2China, this field is not applicable \n- MATCH - Validation based on document number is a match \n - MISMATCH - Validation based on document number is a mismatch \n- NA - Validation is not applicable" enum: - MATCH - MISMATCH - NA title: number_validation name_validation: xml: name: NameValidation type: string description: "Document name validation result \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is conditional \n - For Pay2China, this field is not applicable \n- MATCH - Validation based on document name is a match \n - MISMATCH - Validation based on document name is a mismatch \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is conditional \n - For Pay2China, this field is not applicable \n- MATCH - Validation based on document father's name is a match \n - MISMATCH - Validation based on document father's name is a mismatch \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is conditional \n - For Pay2China, this field is not applicable \n- MATCH - Validation based on date of birth is a match \n - MISMATCH - Validation based on date of birth is a mismatch \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is conditional \n - For Pay2China, this field is not applicable \n- E- EXISTING AND VALID \n- F - Marked as Fake \n- X - Marked as Deactivated \n- D - Deleted \n- N - Record (PAN) Not Found in ITD Database/Invalid PAN \n- EA - Existing and Valid but event marked as Amalgamation in ITD database \n- EC - Existing and Valid but event marked as Acquisition in ITD database \n- ED - Existing and Valid but event marked as Death in ITD database \n- EI - Existing and Valid but event marked as Dissolution in ITD database \n- EL - Existing and Valid but event marked as Liquidated in ITD database \n- EM - Existing and Valid but event marked as Merger in ITD database \n- EP - Existing and Valid but event marked as Partition in ITD database \n- ES - Existing and Valid but event marked as Split in ITD database \n- EU - Existing and Valid but event marked as Under Liquidation in ITD database \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is conditional \n - For Pay2China, this field is not applicable \n- Y – Operative PAN \n- R - Inoperative PAN \n- 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 \n - For India IMPS,this field is not applicable \n - For India UPI,this field is not applicable \n - For US EWS,this field is not applicable \n - For UK,this field is not applicable \n - For IN PAN,this field is conditional \n - For Pay2China, this field is mandatory \n- MATCH - Validation based on document number is a match \n - MISMATCH - Validation based on document number is a mismatch \n - NA - for other than MATCH/MISMATCH status from ECO" enum: - MATCH - MISMATCH title: number_validation required: - uetr - method - status AccountInfo: type: object properties: name: type: string description: Name by which a party is known and which is usually used to identify that party maxLength: 140 xml: name: Name alias: title: alias type: string description: Alias name of the party used for identification. maxLength: 140 xml: name: Alias resolved_name: type: string description: Actual account name of the party resolved by backend system. maxLength: 140 xml: name: RslvdName owner_type: type: string description: 'Describes the type of party who owns the respective proxy/alias, either an Individual(NATURAL_PERSON) or Corporate(LEGAL_PERSON) ' maxLength: 30 xml: name: OwnerTp tax_id: type: string description: 'Tax identification number of the party. ' minLength: 8 maxLength: 16 xml: name: TaxId country_code: type: string description: Country where the request is initiated for beneficiary account search/validation in ISO 3166-1 alpha-2 format maxLength: 2 xml: name: CtryCode bank_code: type: string description: 'Bank identification code of the party used for identification of a financial institution ' maxLength: 10 xml: name: BkCode branch_id: title: branch_id type: string description: 'Branch identification identification code of the party used for identification of a financial institution ' maxLength: 10 xml: name: BrnchId account_id: title: account_id type: string description: Account number of the party as provided in the Input API request maxLength: 35 xml: name: AcctId proxy_type: title: proxy_type type: string description: 'Type of the proxy value used for validation/search ' maxLength: 35 xml: name: ProxyTp proxy_value: title: proxy_value type: string description: Actual proxy value related to the proxy type used for validation/search maxLength: 70 xml: name: ProxyVal account_type: title: account_type type: string description: 'Account type of the party." ' maxLength: 20 xml: name: AcctTp account_currency: title: account_currency type: string description: 'Identification of the currency in which the account is held. Single & mMltiple account currency is supported which are seperated by comma. ' pattern: ^[A-Z]{3}(,[A-Z]{3})*$ xml: name: AcctCcy account_opening_date: title: account_opening_date type: string maxLength: 8 description: 'Date to identify when the Account is Operationally available for business transactions in business date format YYYYMMDD ' xml: name: AcctOpeningDate trade_name: title: trade_name type: string description: 'Describes the trade name of the party who owns the respective proxy/alias ' maxLength: 100 xml: name: TradeName document_type: title: document_type type: string description: 'Name of Tax ID based on the country Example - Tax ID for Peru is ''RUC''. ' maxLength: 10 xml: name: DcType document_number: title: document_number type: string description: 'Unique Tax Identification number of the party. ' maxLength: 25 xml: name: DcNumber account_verification_status: title: account_verification_status type: string description: "Account status details received from Early Warning Systems (EWS). \n" maxLength: 20 xml: name: accountverificationstatus account_verification_description: title: account_verification_description type: string description: "Account status description details received from Early Warning Systems (EWS). \n" maxLength: 200 xml: name: accountverificationdescription account_owner_status: title: account_owner_status type: string description: "Account status details received from Early Warning Systems (EWS). \n" maxLength: 20 xml: name: accountownerstatus account_owner_description: title: account_owner_description type: string description: "Account status description details received from Early Warning Systems (EWS). \n" maxLength: 200 xml: name: accountownerdescription firstname: title: firstname type: string description: "Beneficiary First Name verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: firstname lastname: title: lastname type: string description: "Beneficiary Last Name verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: lastname dob: title: dob type: string description: "Beneficiary date of birth verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: dob address_line1: title: address_line1 type: string description: "Beneficiary Address line1 verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: address_line1 address_line2: title: address_line2 type: string description: "Beneficiary Address line2 verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: address_line2 city: title: city type: string description: "Beneficiary city verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: city state: title: state type: string description: "Beneficiary city verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: state zip: title: zip type: string description: "Beneficiary zipcode verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: zip home_phone: title: home_phone type: string description: "Beneficiary home phone number verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: home_phone work_phone: title: work_phone type: string description: "Beneficiary work phone number verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: work_phone id_type: title: id_type type: string description: "Beneficiary identification type verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: id_type id_no: title: id_no type: string description: "Beneficiary identification number verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: id_no id_issuanceplace: title: id_issuanceplace type: string description: "Beneficiary identification issuance place verification response received from Early Warning Systems (EWS). \n" maxLength: 6 xml: name: id_issuanceplace additional_information: title: additional_information type: string description: "Additional information received in the payload request for Early Warning Systems (EWS). \n" maxLength: 255 xml: name: additional_information creditor_name: title: creditor_name type: string description: "Account name of the creditor intended for search/validation whose payment amount will be credited.\nFor early warning system (EWS), if the verification_type = (BANKOWN or BASICVR) either creditor_firstname & creditor_lastname or creditor_name (Business Name) should be passed. Business name maximum allowed length 87 characters. \n" maxLength: 140 minLength: 3 xml: name: creditor_name ErrorResponse: properties: ref_id: title: ref_id description: Unique ID for the Transaction maxLength: 60 type: string error_details: title: error_details items: $ref: '#/components/schemas/ErrorDetail' type: array type: object AdditionalInformation: type: object properties: end_to_end_id: type: string description: 'Unique identification assigned by the initiating party to unambiguously identify the transaction which can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. ' maxLength: 32 xml: name: EndtoEndId value_date: type: string description: 'Requested execution date post alias resolution when the payment needs to be processed for settlement, format would be YYYYMMDD. ' maxLength: 8 xml: name: ValueDate proxy_status: type: string description: 'Describes the status of Alias/Proxy - whether Active, Inactive or Deleted ' maxLength: 20 xml: name: ProxySts banelco_flag: type: string description: 'Flag will be ''Y'' for successfull search/validation & ''N'' for failure case. ' maxLength: 1 xml: name: BanFlag clearing_system_id: title: clearing_system_id type: string description: 'Unique reference, as assigned by a clearing system. ' maxLength: 16 xml: name: ClrSysId LookupStatusInformation: type: object properties: lookup_reference: type: string description: unique reference number of the request.This is e2e tracking reference from CCD. It will be provided by Concord. maxLength: 35 xml: name: LkUpRef lookup_response_status: type: string description: status(SUCCESS / FAILURE) of the request and get processed successfully. If account exist then status is SUCCESS else FAILURE. maxLength: 10 xml: name: Status status_code: type: string description: Response status of validation-Complete with data from Status Validation. maxLength: 3 xml: name: StCod status_message: type: string description: Response message of validation-Complete with data from Message Validation. maxLength: 100 xml: name: StMessage BeneficiaryValidationResponse: type: object properties: debtor: title: debtor allOf: - $ref: '#/components/schemas/AccountInfo' xml: name: Debtor creditor: title: creditor allOf: - $ref: '#/components/schemas/AccountInfo' xml: name: Creditor additional_information: title: additional_information allOf: - $ref: '#/components/schemas/AdditionalInformation' xml: name: AdditionalInformation lookup_status_information: title: lookup_status_information allOf: - $ref: '#/components/schemas/LookupStatusInformation' xml: name: LookupStatusInformation xml: name: BeneficiaryValidationResponse ErrorDetail: properties: code: description: Unique ID for the error code maxLength: 7 type: string issue: title: issue description: more details about the issue maxLength: 200 type: string action: title: action description: corrective action to be taken to resolve above issue maxLength: 350 type: string type: object 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 clientCredentials: type: oauth2 flows: clientCredentials: scopes: {} tokenUrl: https://tts.apib2b.citi.com/tts/cards/api/v1/oauth2/token description: 'All CitiConnect APIs use the oAuth2 authentication scheme, which requires a bearer token to authenticate your API call. The Token URL includes the version of authentication used by this API. See the Citi Authentication API reference for information on requesting a token. '