Body
Bank Account Validation
Merchant can validate beneficiary bank account, VPA using this API
Request
Response
API Endpoints
Production Link
POST
https://api.juspay.in/payout/merchant/v1/benedetails
Authorization Header
Basic Auth
*
String
Mandatory
Consists of two parts.
Username: API Key obtained from Juspay dashboard
Password: Empty string
Example:- Basic MUQ2QUxxxxxxxxxxxxU5QTIxQzNFNTQwNkFDMEZCOg==
Headers
x-merchantid
string
Please pass merchant id provided by Juspay
Parameters
beneId
*
string
Required
For each verification to have a unique reference
customerId
*
string
Required
Merchant customerId
beneDetails
object
Json Object for bene details
details
object
name
String
name of beneficiary
Example:- *Do not pass any special characters in name
ifsc
*
String
Required
IFSC code of bene bank account. Required for ACCOUNT_IFSC
account
*
String
Required
Account number of beneficiary. Required for ACCOUNT_IFSC
vpa
*
String
Required
VPA to be verified. Required for UPI_ID type when mobile is not being passed
mobile
*
String
Required
Mobile number against which primary VPA needs to be fetched. Required for UPI_ID type when vpa is not being passed
type
*
string
Required
Type of beneficiary validation. UPI_ID/ACCOUNT_IFSC/IFSC
preferredGateway
string
Preffered gateway through which bene validation should happen
metadata
string
Additional metadata
command
string
Action recommended to Juspay on provided beneficiary details.
‘validate’ - this command will create and validate the beneficiary
‘create’ - this command will create the beneficiary at Juspay end
‘resolve’ - this command will fetch primary VPA linked to the mobile number passed in beneficiary details
email
string
Email id of beneficiary
phone
string
Phone number of beneficiary
200 : Success
Response Body
200 : UPI_ID
Object
validateResp
Object
subCode
String
status
String
message
String
data. nameAtBank
String
data. accountExists
String
uniqueId
String
status
String
remark
String
nameAtBank
String
fulfillmentMethod
String
beneDetails
Object
details.vpa
String
details.name
String
type
String
200 : Account_IFSC
Object
validateResp
Object
subCode
String
status
String
message
String
data. utr
String
data. refId
String
data. nameAtBank
String
data. micr
Integer
data. city
String
data.branch
String
data.bankName
String
data. amountDeposited
String
accountStatusCode
String
accountStatus
String
uniqueId
String
status
String
remark
String
nameAtBank
String
fulfillmentMethod
String
beneDetails
Object
details.name
String
details.ifsc
String
details.account
String
type
String
400 : Invalid Input data
Response Body
error
boolean
errorCode
string
E05
errorMessage
string
Duplicate BeneId.
userMessage
string
Bad request
Have questions?
- Need help? Contact support
- LLM? Read llms.txt