Read deposit instructions for an owned, server-verified wallet connection.
GET /api/v1/me/wallets/{connectionId}/deposit-instructions. Read deposit instructions for an owned, server-verified wallet connection.
Request
GET /api/v1/me/wallets/{connectionId}/deposit-instructions
Authentication is required. Supported credentials: a signed-in customer session token in Authorization: Bearer …. This route does not accept customer API keys.
Parameters
| Name | In | Type | Required | Constraints | Description |
|---|---|---|---|---|---|
connectionId | path | string | Yes | format: uuid | — |
X-Service-Act-As | header | string | No | min length: 3; max length: 512 | Service-principal path only (local and devnet stages; refused by configuration on mainnet). With an OAuth client-credentials bearer token from the validator, names the allow-listed Party the client acts as. Missing: 400 SERVICE_ACT_AS_REQUIRED; not allow-listed: 403 SERVICE_PARTY_NOT_ALLOWED. Ignored for customer session tokens. |
X-Request-Id | header | string | No | min length: 8; max length: 128; pattern: ^[A-Za-z0-9._:-]+$ | Optional client correlation identifier. The server always generates a separate authoritative request ID and retains a valid supplied value only as secondary audit correlation metadata. |
cURL
Set CONNECTION_ID to the path and required query values before running this example. URL-encode path values as needed.
curl --fail-with-body --silent --show-error \
--request GET \
--url "https://launch-api.supanova.app/api/v1/me/wallets/${CONNECTION_ID}/deposit-instructions" \
--header "Authorization: Bearer $SUPANOVA_SESSION_TOKEN"Responses
200
Owned wallet deposit destination.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
assetAcceptance | "wallet-and-ledger-controlled" | Yes | — | — |
destination | object · Schema 1 | Yes | — | — |
instructions | array of object · Schema 2 | Yes | min items: 2; max items: 4 | — |
provenance | object · Schema 3 | Yes | — | — |
providerDirectoryId | one or more variants · Schema 4 | Yes | — | — |
providerId | string | Yes | min length: 3; max length: 64; pattern: ^[a-z0-9](?:[a-z0-9.-]{1,62}[a-z0-9])$ | — |
walletConnectionId | string | Yes | format: uuid; pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$ | — |
Additional fields are not allowed.
400
The wallet connection identifier is invalid. Also: VALIDATION_FAILED, AMBIGUOUS_CREDENTIALS, SERVICE_ACT_AS_REQUIRED.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
401
Credentials are missing, malformed, expired or revoked. Codes: AUTHENTICATION_REQUIRED, INVALID_AUTHORIZATION_HEADER, INVALID_ACCESS_TOKEN, SESSION_REVOKED.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
403
The credential may not call this route. Codes: ACCOUNT_RESTRICTED, ANONYMOUS_ACCOUNT_NOT_ALLOWED, API_KEY_ROUTE_NOT_ALLOWED, SERVICE_PARTY_NOT_ALLOWED, SERVICE_PRINCIPAL_NOT_ALLOWED, SIGNUP_NOT_INVITED.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
404
No owned wallet connection exists on this network.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
429
The caller exceeded an IP or principal request budget.
| Header | Type | Description |
|---|---|---|
Retry-After | integer | Whole seconds to wait before retrying a rate-limited request. |
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
503
A reviewed Canton-backed deposit read adapter is not configured. Also: AUTHENTICATION_UNAVAILABLE, AUTHORIZATION_UNAVAILABLE.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
default
Machine-readable API error. The HTTP status identifies the error class.
| Header | Type | Description |
|---|---|---|
X-Request-Id | string | Server-generated request correlation identifier to retain for support and reconciliation. |
Content type: application/json
Standard envelope: error.code, error.message, optional error.details, and requestId. See error handling and the full code registry.
Nested schemas
Field links above lead to the complete nested object, array, and variant definitions below. Required fields are scoped to their containing object.
Schema 1
Response 200.destination
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
address | string | Yes | min length: 3; max length: 512 | Opaque, case-sensitive Canton Party ID containing 3-512 Unicode scalar values with no normalization, edge whitespace, or C0/C1 control characters. |
addressKind | "canton-party-id" | Yes | — | — |
copyValue | string | Yes | min length: 3; max length: 512 | Opaque, case-sensitive Canton Party ID containing 3-512 Unicode scalar values with no normalization, edge whitespace, or C0/C1 control characters. |
networkId | string | Yes | pattern: ^canton:[-_a-zA-Z0-9]{1,32}$ | — |
partyId | string | Yes | min length: 3; max length: 512 | Opaque, case-sensitive Canton Party ID containing 3-512 Unicode scalar values with no normalization, edge whitespace, or C0/C1 control characters. |
Additional fields are not allowed.
Schema 2
Response 200.instructions
Type: array of object.
min items: 2; max items: 4
Array items: object · Schema 5.
Schema 3
Response 200.provenance
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
appStage | string | Yes | allowed: "local", "preview", "devnet", "mainnet" | — |
asOf | string | Yes | format: date-time; pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$ | — |
dataMode | string | Yes | allowed: "projected", "simulated" | — |
disclaimer | string | Yes | min length: 1; max length: 1024 | — |
sourceAuthority | string | Yes | allowed: "canton-projection", "verified-preview-wallet-binding" | — |
Additional fields are not allowed.
Schema 4
Response 200.providerDirectoryId
Type: one or more variants.
At least one of these variants must match:
- Variant 1: string. allowed:
"supanova","loop","console","bron","walley" - Variant 2: null.
Schema 5
Response 200.instructions item
Type: object.
| Field | Type | Required | Constraints | Description |
|---|---|---|---|---|
body | string | Yes | min length: 1; max length: 500 | — |
step | integer | Yes | minimum: 1; maximum: 4 | — |
title | string | Yes | min length: 1; max length: 100 | — |
Additional fields are not allowed.
Source contract
This page is generated from the checked-in customer OpenAPI snapshot. Download JSON, download YAML, or compare the live API reference. Snapshot provenance records the retrieval date and checksum.