Citi · Schema

FinalBeneficiaryValidationResponse

BankingFinancial ServicesOpen BankingPaymentsTreasuryISO 20022Commercial CardsForeign ExchangeCustodyTrade FinanceCorporate BankingAPI Gateway

Properties

Name Type Description
end_to_end_id string Client provided reference number. - For India IMPS and UPI, this field is mandatory and max length is 16 - For US EWS,this field is not applicable - For UK,this field is not applicable - For IN PAN,th
uetr string UUID v4 format unique end-to-end transaction reference
debtor object
creditor object
method object
transaction object
creation_date_time string Request Creation Date and Time in UTC generated by CitiConnect API UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ)
network_id string Transaction identification generated for or by the network - For India IMPS and UPI, this field is optional and max length is 12 - For US EWS,this field is not applicable - For UK,this field is not ap
local_reference string This is a Citi generated payment reference which is included in the ‘Bank Reference’ field of bank statement posting for itemized transaction. - To utilize the field in production, please contact with
status object
reasons object
response object
View JSON Schema on GitHub

JSON Schema

citi-final-beneficiary-validation-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/citi/main/json-schema/citi-final-beneficiary-validation-response-schema.json",
  "title": "FinalBeneficiaryValidationResponse",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/citi-beneficiary-validation-api-openapi.yml#/components/schemas/Final-Beneficiary-Validation-Response",
  "type": "object",
  "properties": {
    "end_to_end_id": {
      "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": {
      "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": {
      "type": "object",
      "title": "debtor",
      "properties": {
        "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": {
          "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": {
          "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": {
          "type": "object",
          "title": "ultimate_debtor",
          "properties": {
            "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": {
              "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": {
      "type": "object",
      "title": "creditor",
      "properties": {
        "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": "#/$defs/Address"
          },
          "title": "address_lines"
        },
        "street_name": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "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": {
          "type": "object",
          "title": "beneficial_owner",
          "properties": {
            "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": {
              "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": {
          "type": "object",
          "title": "document",
          "properties": {
            "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": {
              "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": {
              "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": {
              "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": {
      "type": "object",
      "title": "method",
      "properties": {
        "method": {
          "type": "string",
          "description": "Method specified by the debtor for the validation",
          "enum": [
            "IMPS",
            "UPI",
            "BANKACCOUNT",
            "IBAN",
            "CARD",
            "PAYMENTID",
            "ID",
            "MERCHANTID"
          ],
          "title": "method"
        },
        "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": {
          "type": "string",
          "description": "ISO 3166 Alpha-2 code for the transaction country",
          "enum": [
            "IN",
            "US",
            "GB",
            "CN"
          ],
          "title": "country"
        },
        "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": {
          "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": {
          "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": {
      "title": "transaction",
      "type": "object",
      "properties": {
        "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": {
          "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": {
          "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": {
          "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": {
          "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": "#/$defs/Unstructured"
          }
        },
        "batch_id": {
          "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": {
      "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": {
      "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": {
      "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": {
      "type": "object",
      "title": "status",
      "properties": {
        "date_time": {
          "type": "string",
          "format": "date-time",
          "description": "UTC (ISO 8601 YYYY-MM-DDTHH:MM:SS.sssZ) \n- Date time of transaction status",
          "title": "date_time"
        },
        "code": {
          "type": "string",
          "description": "ISO 20022 acknowledegment status code",
          "enum": [
            "ACCC",
            "RJCT",
            "ACTC",
            "PDNG"
          ],
          "title": "code"
        },
        "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": {
      "type": "object",
      "title": "reasons",
      "properties": {
        "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": {
          "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": {
      "type": "object",
      "title": "response",
      "properties": {
        "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": {
          "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": {
          "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 r

# --- truncated at 32 KB (43 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/citi/refs/heads/main/json-schema/citi-final-beneficiary-validation-response-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/citi-final-beneficiary-validation-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.