Body
Beneficiary Creation
Merchant can create beneficiary account using this API
Request
Response
API Endpoints
Sandbox Link
POST
https://api.sandbox.juspay.io/payout/merchant/v2/benedetails
Production Link
POST
https://api.juspay.io/payout/merchant/v2/benedetails
Authorization Header
Basic Auth
*
String
Required
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
Content-Type
*
String
Mandatory
application/json
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
walletIdentifier
*
String
Mandatory
Value related to beneficiary’s brand you are selecting.
Example :-
Brand WalletIdentifier
PAYPAL paypalId123
brand
*
String
Required
Values :- PAYPAL | VENMO
PAYPAL used for Paypal payout.
VENMO used for Venmo payout.
walletIdentifierType
*
String
Mandatory
Brand Type name of the wallet
Required in case of Wallet only.
Values :- PAYPAL_ID | EMAIL | PHONE | VENMO_ID
PAYPAL_ID | EMAIL | PHONE —> For Paypal
EMAIL | PHONE | VENMO_ID —> For Venmo
payeeAdditionalDetails
Object
Add additional Details
email
String
Provide valid email
name
String
Provide valid name
country
String
Provide valid country
state
String
Provide valid State
accountVerificationStatus
String
Provide account varification status
payerId
String
Provide valid payer Id
type
*
string
Required
Type of beneficiary validation. WALLET
preferredGateway
string
Preffered gateway through which bene validation should happen
metadata
string
Additional metadata
command
string
Action recommended to Juspay on provided beneficiary details.
‘create’ - this command will create the beneficiary at Juspay end.
email
string
Email id of beneficiary
phone
string
Phone number of beneficiary
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