GuidesAPI ReferenceChangelog
API Reference

Create Recipient

Create a new recipient (third-party counterparty) for a customer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Functionality:

  • Registers a new recipient that can receive fiat or crypto payments
  • Supports both individual and company recipient types
  • Automatically assigns a unique recipient_id upon successful creation

Required Fields:

  • relationship: Recipient's relationship to the customer (e.g., VENDOR, EMPLOYEE)
  • address: Recipient address details

Idempotency & Duplicate Detection:

  • Required: Include an Idempotency-Key header with a unique UUID for each new recipient creation
Path Params
string
required

Unique identifier of the customer

Body Params

Request body for creating a recipient

string
enum
required

Recipient type: INDIVIDUAL or COMPANY

Allowed:
string | null

First name (required for INDIVIDUAL)

string | null

Last name (required for INDIVIDUAL)

string | null

Company name (required for COMPANY)

string | null

Display name for the recipient

string | null

Email address

string | null

Mobile country code (e.g., +1)

string | null

Mobile number

string
enum
required

Relationship to the customer (required for bank account operations).
Supported: EMPLOYEE, CONTRACTOR, VENDOR, SUBSIDIARY, MERCHANT, CUSTOMER, LANDLORD, FAMILY, OTHER

address
object
required

Recipient address (required for bank account operations)

bank_accounts
array of objects | null

Bank accounts to create with the recipient (reuses ExternalAccountRequest)

bank_accounts
Headers
string
required

UUID v4 for idempotent requests

Responses

Language
Credentials
Bearer
OneMoney-HMAC-SHA256
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json