Skip to main content
POST
Create Escrow Wallet (BitGo Custodial or Self-custody)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
network
enum<string>
required
Available options:
ethereum,
tron,
solana
purpose
enum<string>
required
Available options:
remittance_escrow,
order_escrow,
platform_reserve,
testing,
other
status
enum<string>

Defaults to active when omitted.

Available options:
active,
inactive,
suspended
label
string

BitGo wallet label when using BitGo custody. Provide label or name.

Maximum string length: 512
name
string

Alias for label when label is empty.

Maximum string length: 512

Response

Created

id
string<uuid>

Escrow wallet ID.

network
enum<string>

Network name.

Available options:
ethereum,
tron,
solana
address
string

Chain address.

status
string

Escrow wallet status (e.g.

purpose
string

Escrow role (e.g.

label
string

Human-readable label stored with the row.

custody_provider
enum<string>
Available options:
self,
bitgo
is_provider_managed
boolean
provider_wallet_id
string

BitGo wallet id when custody is bitgo.

provider_address_id
string

BitGo address id when custody is bitgo.

total_balance
string

Total balance.

available_balance
string

Available balance.

reserved_balance
string

Reserved balance.

last_reconciled_at
object
created_at
string<date-time>
updated_at
string<date-time>