The recipient object

A recipient is somewhere money can be sent — a person or a company, plus the account details a payout needs. You create one once and reference it by recipient_id on every payout and quotation afterwards. Which name fields come back depends on whether the recipient is a person or a company, and account_details changes shape entirely with the rail.

Example

{
  "recipient_id": "cccccccc-dddd-eeee-ffff-000000000000",
  "type": "business",
  "company_name": "Acme Supplies LLC",
  "email": "ap@example.com",
  "address": {
    "street_name": "500 Howard Street",
    "city": "San Francisco",
    "state": "CA",
    "postal_code": "94105",
    "country": "US"
  },
  "account_type": "WIRE",
  "account_details": {
    "routing_number": "000000001",
    "account_number": "1000000001",
    "type": "checking",
    "bank_name": "Example Bank National Association",
    "doc_type": "ein",
    "doc_number": "123456789"
  },
  "created_ts": "2026-09-01T12:00:00.000Z",
  "updated_ts": "2026-09-01T12:00:00.000Z",
  "metadata": {}
}

Who the recipient is

Field	Type	Description
`recipient_id`	string, uuid	The recipient’s identifier. Send it on a payout or a quotation.
`type`	string	Whether the recipient is a person or a company. Values
`first_name`	string	Given name. On a person.
`middle_name`	string	Middle name. On a person, when provided.
`last_name`	string	Family name. On a person.
`company_name`	string	Registered name. On a company.
`email`	string	Email address.
`phone`	string	Phone number.
`address`	object	The recipient’s own address, which is not the bank’s.
`metadata`	object	Key-value pairs you attached. `{}` when you attached none — see Metadata.
`created_ts`	string, date-time	When the recipient was created, ISO 8601.
`updated_ts`	string, date-time	When it last changed, ISO 8601.

Where the money goes

Field	Type	Description
`account_type`	string	Which rail the money travels on. Values
`account_details`	object	Where the money goes. Its fields depend on `account_type`.

account_details is a different object per rail, so read account_type first and branch on it:

`account_type`	What `account_details` carries
`WALLET`	`token`, `address`, `network` — see Token and Network
`ACH`	`account_number`, `routing_number`, `type`, `bank_name`, `bank_address`
`WIRE`	The same as `ACH`, plus `swift_code`

All three also carry doc_type and doc_number, the identifying document of the account holder.

Across the API

Authentication

Versioning

Users

Virtual Accounts

Recipients

Quotations

Payouts

Catalogs

RFIs

The recipient object

Example

Who the recipient is

Where the money goes

​Example

​Who the recipient is

​Where the money goes

Example

Who the recipient is

Where the money goes