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

GET /v1/customers/{customer_id}/deposit_instruction

Changed on

Request

Path parameters

customer_idstring required

Customer ID (UUID format)

Query parameters

idempotency_keystring required

HTTP Idempotency-Key header value. Stricter than other IDs: ≤64 ASCII chars per the common REST API convention.

The idempotency key used during resource creation. Used to safely retrieve or check the status of a resource after creation, especially useful for handling network failures or timeout scenarios.

Response

Successfully retrieved crypto deposit instruction

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