Skip to main content

Create Recipient

Creates a new recipient and initiates KYB verification. Accounts (on-ramp or off-ramp) are created separately after KYB approval.

Request

name
string
required
Business name
type
string
default:"business"
Business type
external_id
string
Your internal reference ID for this recipient
address
object
Physical address. Optional at creation, but required before creating off-ramp accounts.

Response


List Recipients

Returns all recipients with KYB status, account counts, and volume summaries.

Query Parameters

page
integer
default:"1"
Page number
per_page
integer
default:"20"
Results per page (max 100)

Response


Get Recipient

Returns a single recipient with full detail, including all on-ramp and off-ramp accounts.
id
integer
required
Recipient ID

Response


Create On-Ramp Account

Creates a virtual bank account for the recipient. Requires KYB approval.
id
integer
required
Recipient ID
destination_wallet_id
integer
required
OrgWallet ID where USDC/USDT will be delivered
destination_asset
string
default:"USDC"
Destination asset: USDC or USDT
rail
string
default:"ach"
Payment rail: ach, fedwire, or swift

Response


Create Off-Ramp Account

Creates a crypto deposit address for the recipient. Requires KYB approval and a recipient address on file.
id
integer
required
Recipient ID
org_wallet_id
integer
required
Source OrgWallet ID (where crypto is sent from)
source_asset
string
default:"USDC"
Source crypto asset
rail
string
default:"ach"
Payment rail: ach, fedwire, or swift
bank_details
object
required
Bank account where USD will be delivered

Response


List Off-Ramp Accounts

id
integer
required
Recipient ID

Response

Returns an array of off-ramp accounts for the recipient.

Archive Recipient

Archives a recipient, removing them from all lists.
id
integer
required
Recipient ID