Skip to main content
POST
Custody Wallet Transfer

Authorizations

x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
custody_wallet_id
string<uuid>
required

The unique identifier of the custody wallet

Example:

"c10dad79-4bd8-47f4-933e-4f197c5af680"

user_id
string<uuid>
required

The unique identifier of the user

Example:

"810b82b7-bd72-48c2-980f-0887fe20f08e"

to_address
string
required

The destination wallet address

Example:

"3BsSGETYNCjfULdgYEBVmzwXgaspS6E5pgncJr3bfBeU"

crypto
string
required

The cryptocurrency to transfer

Example:

"usdc"

amount
number
required

The amount to transfer

Example:

1

customer_fee
number

Fee charged to the customer for this transfer (denominated in the same crypto currency)

Example:

0.1

customer_transaction_id
string

Customer-provided transaction identifier for tracking and idempotency

Example:

"3n39b7-bd72-48c2-980f-0887fe20f08e"

Response

Transfer initiated successfully

id
string<uuid>

Unique identifier of the transfer

Example:

"6956a36c-528b-43c3-bc39-6000dc234fd8"

custody_wallet_id
string<uuid>

Source custody wallet ID

Example:

"c10dad79-4bd8-47f4-933e-4f197c5af680"

to_address
string

Destination wallet address

Example:

"3BsSGETYNCjfULdgYEBVmzwXgaspS6E5pgncJr3bfBeU"

crypto
string

Cryptocurrency transferred

Example:

"usdc"

status
string

Transfer status

Example:

"INITIATED"