Skip to main content
POST
Create Payee

Headers

X-Platform-ID
string<uuid>
required

Unique platform identifier (UUID). You receive this during onboarding. Must be sent with every API request.

X-Signature
string
required

HMAC-SHA256 request signature for authentication. Use your platform secret key to compute it as: METHOD + PATH + QUERY + BODY_HASH.

Path Parameters

user_id
string<uuid>
required

Unique identifier (UUID) of the user who creates the payee.

Body

application/json
name
string
required

Full name of the payee

Maximum string length: 50
Example:

"John Doe"

email
string<email> | null

Email address of the payee

Maximum string length: 100
Example:

"john.doe@example.com"

phone_country_code
string | null

International dialing code of the payee’s phone number (e.g., +1 for US).

Maximum string length: 5
Example:

"+1"

phone
string | null

Payee’s local phone number, excluding country code.

Maximum string length: 15
Example:

"1234567890"

Response

Successful Response

success
boolean
default:true

Indicates whether the request was processed successfully.

Example:

true

message
string
default:Success

A short, human-readable message describing the result of the request.

Example:

"Operation completed."

data
ExternalContactsRead · object | null

The main response payload, if applicable

queryGeneratedTime
number | null
default:1783679844.273462

The Unix timestamp (in seconds) indicating when the response was generated.

Example:

1718006400