Skip to main content
POST
Add recipient

Authorizations

X-API-KEY
string
header
required

Your partner API key.

X-API-SECRET
string
header
required

Your partner API secret.

Path Parameters

userId
string<uuid>
required

Identifier of the end user the resource belongs to.

Example:

"8f14e45f-ceea-467a-9a3f-1b2c0d4e5f60"

Body

application/json
alias
string
required

Label for the recipient.

type
string
required

BUSINESS or INDIVIDUAL.

currency
string
required

Currency the recipient is paid in.

payoutRail
string
required

Rail used to reach the recipient.

recipientCountry
string
required

ISO-3166 alpha-3 country code.

bankName
string

Receiving bank name.

bankAccountNumber
string

Receiving account number.

ifsc
string

Rail-specific bank code — IFSC for Indian rails.

Response

Recipient created

code
integer
Example:

201

message
string
Example:

"Recipient created"

status
enum<string>
Available options:
SUCCESS,
ERROR
Example:

"SUCCESS"

data

Successful responses share the standard envelope. The shape of data for this endpoint is not yet captured in this specification — see the note on the API reference overview.

errors
object[]
Example: