Create a Recipient
Creates a new recipient with the provided details
Request
This endpoint expects an object.
given_name
The recipient's given name
family_name
The recipient's family name
address
Address information for the recipient
type
Recipient type (e.g. individual, business)
Allowed values:
financial_account
Financial account details for the recipient
email
The recipient's email address
phone
The recipient's phone number
document
Document information for identity verification
legal_name
Legal name (only required for business recipients)
Response
Create a Recipient
id
Unique public identifier for the recipient
address
Address information for the recipient
document
Document information for identity verification
financial_account
Associated financial account details
email
Recipient's email address
phone
Recipient's phone number
given_name
Recipient's given name
family_name
Recipient's family name
legal_name
Legal name for business recipients
status
Current status of the recipient
Allowed values:
type
The type of recipient (‘individual’ or ‘business’)
Allowed values:
created_at
ISO 8601 timestamp when the recipient was created
updated_at
ISO 8601 timestamp when the recipient was last updated
