post https://api.juspay.in/payout/merchant/v1/benedetails#IFSC
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)
Parameter | Type | Description |
---|---|---|
validateResp:wwwwiww {param1, param2,.,object} | Object | Object containing validation details |
Parameters for validateResp
object:(Validation Response parameters -- click to open)
Field | Type | Description |
---|---|---|
subCode | String | HTTP status code of response Example: "200" |
status | String | "SUCCESS" unless otherwise indicated:Status codes and meaningSUCCESS 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. |
message | String | Message (if any) regarding the result. Example: "VPA verification successful" |
data:wwwwwwwwwwwnn {param1, param2, ...} | Object Strings | Information on beneficiary's account. (See table below for parameters) |
Parameters for
data
object: upi | String | Mode of payment to a beneficiary (push to VPA) |
swiftCode | String | |
state | String | |
rtgs | String | |
neft | String | Mode of payment to a beneficiary (payment rail) |
nbin | Integer | |
micr | Integer | |
imps | String | Mode of payment to a beneficiary (payment rail) |
ifscSubcode | String | Subcode for IFSC |
ifsc | String | IFSC code of beneficiary's bank account. |
ft | String | |
city | String | City location of bank |
category | String | |
card | String | Type of card |
branch | String | Branch location of bank |
bank | String | Name of bank |
address | String | Address of bank |
beneId | String | Unique reference ID for the verification request |
statuswwiwww | String | "VALID" or "INVALID" |
remark | String | For example: "VPA verification successful" |
fulfillmentMethod | String | Method used for fulfillment - for instance: “CFGEN_UPI” or ”CASHFREE_IMPS” |
beneDetails:wwwwwwwww {param, object} | Object | JSON object for beneficiary details |
Parameters for beneDetails
object:(Beneficiary Details parameters -- click to open)
Parameter | Type | Description |
---|---|---|
typewwwwwwwwwwwww | String | Type of beneficiary validation. UPI_ID/ACCOUNT_IFSC/IFSC "IFSC" in this instance |
details: {param1, param2,...} | Object Strings | JSON object for name/account details of beneficiary |
Parameters for
details
object: Parameter | Type | Description |
---|---|---|
ifsc wwwwwwwwwwwi | String | IFSC code of beneficiary's bank account. Always sent in IFSC type response. |
Request Parameter Details (click to open table)
- includes object for Beneficiary Details
- includes object for Beneficiary Details
Parameter | Type | Description | |
---|---|---|---|
beneId | * | String | Unique reference ID for the verification request |
preferredGatewaywwww | String | Preferred gateway through which beneficiary validation is required to happen | |
beneDetails: {param, object} | * | Object | JSON object for beneficiary details |
Parameters for
beneDetails
object: Parameter | Type | Description | |
---|---|---|---|
typewwwwwwwwwww | * | String | Type of beneficiary validation. UPI_ID/ACCOUNT_IFSC/IFSC "IFSC" in this instance |
details: {param1, param2,...} | * | Object | JSON object for IFSC details of beneficiary |
Parameters for
details
object: Parameter | Type | Description | |
---|---|---|---|
namewwwwwwwww | String | name of beneficiary | |
vpa | * | String | VPA to be verified. Only required for UPI_ID type validation. |
ifsc | * | String | IFSC code of beneficiary's bank account that has to be verified. Always required for IFSC verification |
account | * | String | Account number of beneficiary. Only required for ACCOUNT_IFSC type validation. |
* = Required
* = Conditionally required depending on type
* = Conditionally required depending on type