Hey! These docs are for version 3.2, which is no longer officially supported. Click here for the latest version, 1.0!

Bank Account Validation

Merchant can validate beneficiary bank account, VPA using this API

The response for this API includes a JSON block for Validation Details and a block for Beneficiary Details:     (click to open tables)
ParameterTypeDescription
validateResp:wwwwwwww
 {param1, param2,.,object}
ObjectObject containing validation and account status details
  Parameters for validateResp object:
(Validation Response parameters  --   click to open)
FieldTypeDescription
subCodeStringHTTP status code of response
Example: "200"
statusString"SUCCESS" unless otherwise indicated:
  Status codes and meaning
SUCCESS
    This means that the validation request has been
    successfully executed.
PENDING
    This would mean that the validation request has
    been queued with JusPay or with the downstream
    system.
FAILURE
    We were unable to process the validation request
    successfully. You have to try again with a
    new uniqueId.
MANUAL_REVIEW
    This would mean that the validation request was
    sent an ambigious response from the payment
    gateway and the merchant has to manually
    reconcile it with the payment gateway to get
    the proper response. Also, any validation
    requests which are in pending for more than
    10 days are sent for manual review.
messageStringMessage (if any) regarding the result.
Example: "VPA verification successful"
accountStatusCodeStringStatus code for account. Required for ACCOUNT_IFSC type response.   Example: "ACCOUNT_IS_VALID"
accountStatusStringStatus of account. Required for ACCOUNT_IFSC type response.   Example: "VALID"
data:wwwwwwwwwwwnt
   {param1, param2, ...}
Object
Strings
Information on beneficiary's account.
(See table below for parameters)
 Parameters for data object:
UPI_ID response:
ParameterTypeDescription
nameAtBankwwiwStringName used for beneficiary at bank
accountExistsString"YES" or "NO"
ACCOUNT_IFSC response:
utrString
refIdStringReference ID used for bank
nameAtBankStringName used for beneficiary at bank
micrString
cityStringCity location of bank
branchStringBranch location of bank
bankNameStringName of bank
amountDepositedStringTotal amount deposited
uniqueIdStringEach verification is assigned a unique reference
statuswwiwwwString"VALID" or "INVALID"
remarkStringFor example: "VPA verification successful"
nameAtBankStringName used for beneficiary at bank
fulfillmentMethodStringMethod used for fulfillment - for instance: “CFGEN_UPI” or ”CASHFREE_IMPS”
beneDetails:wwwwwwwww
   {param, object}
ObjectJSON object for beneficiary details
  Parameters for beneDetails object:
(Beneficiary Details parameters  --   click to open)
ParameterTypeDescription
typewwwwwwwwwwwwwStringType of beneficiary validation.
UPI_ID/ACCOUNT_IFSC/IFSC
UPI_ID is for VPA validation, and ACCOUNT_IFSC or IFSC is for account validation.
details:
   {param1, param2,...}
Object
Strings
JSON object for name/vpa/account details of beneficiary
 Parameters for details object:
ParameterTypeDescription
namewwwwwwwwwwwiStringname of beneficiary
vpaStringVPA to be verified. Required for UPI_ID type response.
ifscStringIFSC code of beneficiary's bank account. Required for ACCOUNT_IFSC/IFSC type response.
accountStringAccount number of beneficiary. Required for ACCOUNT_IFSC type response.
Request Parameter Details     (click to open table)
- includes object for Beneficiary Details
ParameterTypeDescription
beneId*StringFor each verification to have a unique reference
customerId*StringMerchant's customer ID
emailwwwwwwwwwwntStringEmail ID of benefiiary
phoneStringPhone number of beneficiary
commandStringValidate” -> Create and validate
Create” -> only Create
By default it will be “create”
preferredGatewayStringPreffered gateway through which beneficiary validation should happen
metadata: {...}JSONAdditional metadata
beneDetails:
   {param, object}
*ObjectJSON object for beneficiary details
    Parameters for beneDetails object:
ParameterTypeDescription
typewwwwwwwwwww*StringType of beneficiary validation.
UPI_ID/ACCOUNT_IFSC/IFSC. Pass UPI_ID for VPA validation, and ACCOUNT_IFSC or IFSC for account validation
details:
   {param1, param2,...}
*ObjectJSON object for name/vpa/account details of beneficiary
 Parameters for details object:
ParameterTypeDescription
namewwwwwwwwwStringname of beneficiary
vpa*StringVPA to be verified. Required for UPI_ID type validation.
ifsc*StringIFSC code of beneficiary's bank account. Required for ACCOUNT_IFSC/IFSC type validation.
account*StringAccount number of beneficiary. Required for ACCOUNT_IFSC type validation.
* = Required
* = Conditionally required depending on type
Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!