Skip to main content
POST
Create a new wallet asset for a customer

Authorizations

Authorization
string
header
required

Token from POST /auth/token

Headers

Idempotency-Key
string
required

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

Path Parameters

id
string
required

Customer ID (cst_ prefix).

Body

application/json

Request body for creating a wallet: the asset to hold and the chain it lives on.

asset
string
required

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

chain
string
required

Chain the wallet lives on.

Response

201 - application/json

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

A wallet holding a single asset on one chain for a customer. internal wallets are OMS-managed; external wallets are held outside OMS.

id
string

Wallet ID.

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
object
enum<string>

Resource type discriminator. Always "wallet".

Available options:
wallet
customerId
string

The OMS customer that owns this record (cst_ prefix).

Pattern: ^[a-z]+_([0-9a-hjkmnp-tv-z]{26}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$
type
enum<string>

internal (OMS-managed) or external (held outside OMS).

Available options:
internal,
external
asset
string

Asset held by this wallet.

chain
string

Chain the wallet lives on.

blockchainAsset
object

Resolved asset/network detail for the wallet's asset.

address
string

On-chain address of the wallet.

status
enum<string>

Current lifecycle status of the wallet.

Available options:
active,
suspended,
frozen,
closed
createdAt
string<date-time>

When the wallet was created.

updatedAt
string<date-time>

When the wallet was last updated.