Skip to main content
POST
cURL

Create Payout Customer

Part of the payout-only onboarding flow. See the payout-only onboarding guide for the order of calls and the fields each country requires.

Authorizations

X-API-KEY
string
header
required

API Key for authentication

X-TIMESTAMP
string
header
required

Current timestamp in seconds since epoch

X-SIGNATURE
string
header
required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json
client_reference_id
string

Your unique ID for this beneficiary

Example:

"beneficiary-001"

full_name
string

Beneficiary name. Required when client_reference_id is not sent.

Example:

"Maria Silva"

email
string<email>

Email

Example:

"maria@example.com"

phone
string

Exactly 10 digits

Example:

"9876543210"

alpha_3_country_code
string

Beneficiary country, ISO alpha-3. Must be a supported payout-only country; defaults to IND.

Example:

"BRA"

Response

Success

status
boolean
Example:

true

message
string
Example:

"Success"

data
object