v1

latestOpenAPI 3.0.32026-07-2650226215.9 KB

Wallet

Create a new wallet asset for a customer

Provisions a crypto wallet for a customer for the requested asset and chain, returning the created wallet. Pass an Idempotency-Key header to safely retry without provisioning duplicates.

post/customers/{id}/wallets

Path parameters

idstring required

Customer ID (cst_ prefix).

Headers

Idempotency-Keystring required

Required on POST and PUT requests. Use a unique value per logical mutation attempt, for example a UUID.

Request body

assetstring required

Asset the wallet will hold (e.g. usdc).

chainstring required

Chain the wallet lives on.

Example request

{
  "asset": "usdc",
  "chain": "ethereum"
}

Response

The request has succeeded and a new resource has been created as a result.

idstring

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

object'wallet'

Resource type discriminator. Always "wallet".

customerIdstring

Public TypeID, e.g. txn_01h455vb4pex5vsknk084sn02q; legacy UUID suffixes are accepted until non-v7 rows are retired.

type'internal' | 'external'

Whether a wallet is internal (OMS-managed) or external (held outside OMS).

assetstring

Asset held by this wallet.

chainstring

Chain the wallet lives on.

addressstring

On-chain address of the wallet.

status'active' | 'suspended' | 'frozen' | 'closed'

createdAtstring date-time

When the wallet was created.

updatedAtstring date-time

When the wallet was last updated.