v1

latestOpenAPI 3.1.0Proprietary2026-07-2464170247.4 KB

Deposit Instructions

Get Crypto Deposit Address by Idempotency Key

Look up a crypto deposit instruction using the idempotency key provided during creation.

Use Case: Verify if a crypto deposit instruction was successfully created when network issues or timeouts occurred during the create request.

For EVM wallets, the network field indicates whether it was created as a specific chain (e.g., ETHEREUM) or as the virtual EVM network.

get/v1/customers/{customer_id}/deposit_instruction

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

Unique wallet identifier assigned by the custody provider

networkstring required

Network name accepted by deposit-wallet creation surfaces.

Unlike [Network], this type intentionally accepts the virtual EVM network group used by Web/OpenAPI deposit-address creation.

addressstring required

On-chain deposit address.

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"
}