1M1money
crate::connectivity::controller::openapi::deposit_instructions

Accept an additional deposit wallet for asynchronous provisioning. A new request returns PENDING with an empty address and a stable deposit_instruction_id. Retrieve that ID (or the same idempotency key) until READY, or consume deposit_instruction.ready. An idempotent replay returns the current state and may already be READY.

Changed on
post/v1/customers/{customer_id}/deposit_instruction

Request

Path parameters

customer_idstring required

Customer ID (UUID format)

Headers

Idempotency-Keystring required

Required. valid UUID for idempotent request.

Request body

networkstring required

Blockchain network identifier for a deposit wallet.

Allowed values: EVM, ETHEREUM, POLYGON, BNBCHAIN, AVALANCHE, BASE, ARBITRUM, SOLANA, TRON, BITCOIN.

EVM is a virtual group for supported EVM-compatible networks.

nicknamestring nullable

Optional nickname for the deposit address

Example request

{
  "network": "EVM",
  "nickname": "My second deposit address"
}

Response

Deposit instruction already exists (idempotent replay)

deposit_instruction_idstring required

Stable local deposit-wallet identifier, available before custody provisioning completes

networkstring required

Blockchain network identifier for a deposit wallet.

Allowed values: EVM, ETHEREUM, POLYGON, BNBCHAIN, AVALANCHE, BASE, ARBITRUM, SOLANA, TRON, BITCOIN.

EVM is a virtual group for supported EVM-compatible networks.

addressstring required

On-chain deposit address. Populated only while status is READY; empty while status is PENDING.

is_defaultboolean required

Whether this is the default deposit wallet for the network. Each customer has exactly one default wallet per network, created automatically during onboarding; additional wallets are non-default.

nicknamestring required

Human-readable label. Empty string when not set.

status'PENDING' | 'READY' | 'FAILED' required
created_atstring required

Example response

{
  "network": "EVM",
  "created_at": "2025-08-21T07:56:57.981Z"
}

Changes

  • d213edbaccb6Revision changes
    • info

      api tag crate::connectivity::controller::openapi::deposit_instructions added

    • info

      api tag Deposit Instructions removed