Payout

Endpoint: POST v3/payout

ParameterError CodeError Message
amount20003Please provide a valid amount
currency20061Field is required and must be valid ISO 4217 alpha-3 currency code
holding_currency20061Field is required and must be valid ISO 4217 alpha-3 currency code
beneficiary20165Please provide either the beneficiary details or a beneficiary ID. One of these fields is mandatory for processing.
beneficiary_details20165Please provide either the beneficiary details or a beneficiary ID. One of these fields is mandatory for processing.
txn_source20174Please provide a valid transaction source
on_behalf_of20197Please provide valid on_behalf_of, should be valid id type with prefix 'ent_'

Endpoint: POST v3/beneficiary

ParameterError CodeError Message
name20150Field is required, please provide a valid name
email20151Please provide a valid email address
type20152Please provide a valid type
destination_details20153Please provide a valid beneficiary_details
bank_name20154Please provide a valid bank_name
country20155Please provide a valid country. Must be alpha-2 country code. Ex: IN, SG
currency20156Please provide a valid currency
bank_codes20157Please provide a valid bank codes
deposit_address20158Please provide a valid payout_wallet deposit_address
documents.url20164Field 'url' is required and must be a valid url
account_type20270"Invalid or missing account type. Please provide a valid account type. Accepted values are 'savings', 'checking', or 'payment'"

Endpoint: GET v3/payout/:id

ParameterError CodeError Message
id20195Field is required and must be a valid payout_id

Endpoint: GET v3/beneficiary/:id

ParameterError CodeError Message
id20161Field is required and must be a valid beneficiary id. Example: bnf_xid