Skip to main content
POST
Add a Payee

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

user_id
string<uuid>
required

The unique ID of the user who owns this payee.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

Body

application/json

Request body for POST /tenant/payees.

first_name
string | null
Maximum string length: 255
middle_name
string | null
Maximum string length: 255
last_name
string | null
Maximum string length: 255
maiden_name
string | null
Maximum string length: 255
date_of_birth
string | null
Maximum string length: 20
nationality
string | null
Maximum string length: 10
gender
string | null
Maximum string length: 1
doc_number
string | null
Maximum string length: 100
doc_type
string | null
Maximum string length: 50
doc_issue_country
string | null
Maximum string length: 10
doc_issue_date
string | null
Maximum string length: 20
doc_due_date
string | null
Maximum string length: 20
doc_issuer
string | null
Maximum string length: 255
state
string | null
Maximum string length: 255
city
string | null
Maximum string length: 255
street
string | null
Maximum string length: 500
postal_code
string | null

Recipient's ZIP / postal code. Required by some payout corridors (e.g. US) — the payout is rejected without it.

Maximum string length: 20
is_business
boolean
default:false

Set to true when this payee is a business/organization rather than an individual. When true, send business_name; first/last name are optional (used for international/UniTeller payouts). This is fixed at creation and cannot be changed later.

business_name
string | null

Organization name. Required when is_business is true; leave empty for an individual.

Maximum string length: 255
email
string<email> | null
phone
string | null
Maximum string length: 40
metadata
Metadata · object

Response

The newly created payee.

status_code
integer
required

HTTP status code for the response.

data
PayeeRead · object
required

Payload or error details.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.