REST API V3 (RECOMMENDED)

Beneficiary Validation API

Description

The person to whom the payment is to be made must be added as a ‘Beneficiary,’ and his/her bank account information
must be provided for the funds to be transferred.

This API is used to determine whether the validation request is for a bank account or a vpa. The API returns if the details sent
are valid or not. There will be a transfer of funds for bank account validation and hence charges are levied on the account.

Method: GET

URL/Path: rest/v3/beneficiaries/validations

Request Body:

For Bank Account

        {
            "type": "BANK_ACCOUNT",
            "accountNumber": "31221313221312321",
            "ifscCode": "001000000abc",
            "email": "test@gmail.com",
            "name": "abc test",
            "telephone": "+918888888888",
            "refno": "312312323233121"
        }
For UPI
                            
        {
            "type": "UPI",
            "vpa": "test@okhdfc",
            "email": "test@gmail.com",
            "name": "abc test",
            "telephone": "+918888888888",
            "refno": "312312323233121"
        }
Request Parameters
Field Name Mandatory Data Type Length Description
refno yes string 25 Customer provided reference number
type yes string 15 Transaction type identifier. Accepted values are BANK_ACCOUNT, UPI
accountNumber yes string 35 Account number of bank account. It is mandatory if the type is a bank account.
ifscCode yes string 11 IFSC Code of bank account. It is mandatory if type is bank account.
vpa yes string 100 UPI ID of the account. It is mandatory if the type is UPI.
email no string 100 It can be used for sending notification in the future
name yes string 150 Account holder name.
telephone no string E.164 format It can be used for sending notification in the future
e.g.: +918888888888
Sample Response
  • Sample Response 202 

{
    "code": 0,
    "message": "Validation request successfully accepted",
    "messages": []
}

Note: Response code will be always returned as 202 in case of success

  • Sample Response 400
    • Response Parameters
    
{
    "code": 6053,
    "message": "Could not process your request, please try again",
    "messages": []
}
    Response Parameters
    Field Name Data Type Mandatory/Optional Description Example
    code number no Code 6053
    message string no Message Could not process your request, please try again
    messages array no
    Error Codes
    Status Code Description
    6053 Could not process your request. Please try again later.

    Articles

    Last updated on:

    ← Product API Order API (Create) →