postRegister withdrawal destination

Required capabilitywithdrawal_destinations.create

Authentication: Send Authorization: Bearer <access_token>.

Registers a crypto withdrawal destination with typed {asset, network, destination: {address, memo}, label} routing and scope_ref. Fiat destination creation requires account_ref and canonical fiat rails routing {fiat_rail, method, currency, beneficiary_name, bank_coordinates, reference_hint}; the pooled fiat route owner is derived server-side. Supply Idempotency-Key for replay-safe creation; it takes precedence over body idempotency_key. Fiat creation requires a key in either location. Crypto creation generates a key when both are absent, so retrying without a caller-supplied key does not replay the original request.

Parameters

Name Location Type Required Description and constraints
Idempotency-Key header string No Client-generated key, 1-128 characters. Accepted on POST requests and required where marked. For the same concrete path and caller/subject/tenant scope, an identical body replays the original status and body; a different body returns 409 idempotency_conflict. Keep query parameters unchanged when retrying. minLength: 1; maxLength: 128

Request

Required request body.

Request body schema

Exactly one alternative must match.

Request body schema: alternative 1

Field Type Required Description and constraints
crypto_routing object Yes No additional fields
idempotency_key string No minLength: 1
rail_class "crypto" Yes
scope_ref string Yes pattern: ^(enterprises|platform-operators|clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Additional fields are not accepted.

Request body schema: alternative 1.crypto_routing
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
destination object Yes No additional fields
label string or null No
network string Yes minLength: 1

Additional fields are not accepted.

Request body schema: alternative 1.crypto_routing.destination
Field Type Required Description and constraints
address string Yes minLength: 1; maxLength: 256
memo string or null Yes

Additional fields are not accepted.

Request body schema: alternative 1.crypto_routing.destination.memo

At least one alternative must match.

Request body schema: alternative 1.crypto_routing.destination.memo: alternative 1

Type: string.

Request body schema: alternative 1.crypto_routing.destination.memo: alternative 2

Type: null.

Request body schema: alternative 1.crypto_routing.label

At least one alternative must match.

Request body schema: alternative 1.crypto_routing.label: alternative 1

Type: string.

Request body schema: alternative 1.crypto_routing.label: alternative 2

Type: null.

Request body schema: alternative 2

Field Type Required Description and constraints
account_ref string Yes pattern: ^(master-accounts|client-accounts)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
fiat_routing object Yes No additional fields
idempotency_key string No minLength: 1
rail_class "fiat" Yes

Additional fields are not accepted.

Request body schema: alternative 2.fiat_routing
Field Type Required Description and constraints
bank_coordinates object or object Yes
beneficiary_name string Yes minLength: 1; maxLength: 140
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
fiat_rail "sepa_credit_transfer" / "faster_payments" / "swift" / "local_bank_transfer" / "fedwire" Yes
method "bank_transfer" Yes
reference_hint string or null Yes

Additional fields are not accepted.

Request body schema: alternative 2.fiat_routing.bank_coordinates

Exactly one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1
Field Type Required Description and constraints
account_holder_name string Yes minLength: 1; maxLength: 140
bank_address object or null No Postal address of the bank that holds the account.
bank_name string or null Yes
bic string or null Yes
country string Yes pattern: ^[A-Z]{2}$
iban string Yes minLength: 1; maxLength: 34
scheme "iban" Yes

Additional fields are not accepted.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address

Postal address of the bank that holds the account.

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 1.postal_code

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 1.postal_code: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 1.region

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 1.region: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_address: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_name

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_name: alternative 1

Type: string. minLength: 1; maxLength: 140

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bank_name: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bic

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bic: alternative 1

Type: string. minLength: 1; maxLength: 11

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 1.bic: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2
Field Type Required Description and constraints
account_holder_name string Yes minLength: 1; maxLength: 140
account_number string Yes minLength: 1; maxLength: 64
account_type "checking" / "savings" or null No Checking or savings. Required by some payout rails (a US domestic wire); null or absent where the rail has no such concept.
bank_address object or null No Postal address of the bank that holds the account.
bank_name string or null Yes
bic string or null Yes
country string Yes pattern: ^[A-Z]{2}$
routing_codes object[] Yes minItems: 1; maxItems: 16
scheme "local_account" Yes

Additional fields are not accepted.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.account_type

Checking or savings. Required by some payout rails (a US domestic wire); null or absent where the rail has no such concept.

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.account_type: alternative 1

Type: "checking" / "savings".

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.account_type: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address

Postal address of the bank that holds the account.

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 1.postal_code

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 1.postal_code: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 1.region

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 1.region: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_address: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_name

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_name: alternative 1

Type: string. minLength: 1; maxLength: 140

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bank_name: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bic

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bic: alternative 1

Type: string. minLength: 1; maxLength: 11

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.bic: alternative 2

Type: null.

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.routing_codes

Type: object[]. minItems: 1; maxItems: 16

Request body schema: alternative 2.fiat_routing.bank_coordinates: alternative 2.routing_codes item
Field Type Required Description and constraints
type string Yes minLength: 1; maxLength: 64
value string Yes minLength: 1; maxLength: 64

Additional fields are not accepted.

Request body schema: alternative 2.fiat_routing.reference_hint

At least one alternative must match.

Request body schema: alternative 2.fiat_routing.reference_hint: alternative 1

Type: string. minLength: 1; maxLength: 140

Request body schema: alternative 2.fiat_routing.reference_hint: alternative 2

Type: null.

Request URL

POST
POST /withdrawal-destinations

Request Body

application/json
{
  "crypto_routing": {
    "asset": "USDC",
    "destination": {
      "address": "0xAbCd1234567890AbCd1234567890AbCd12345678",
      "memo": null
    },
    "label": "My ETH wallet",
    "network": "ethereum"
  },
  "rail_class": "crypto",
  "scope_ref": "clients/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
}

Responses

Response

application/json
{
  "asset": "USDC",
  "created_at": "2026-05-01T10:00:00Z",
  "crypto_routing": {
    "asset": "USDC",
    "destination": {
      "address": "0xAbCd1234567890AbCd1234567890AbCd12345678",
      "memo": null
    },
    "label": "My ETH wallet",
    "network": "ethereum"
  },
  "fiat_routing": null,
  "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "label": "My ETH wallet",
  "rail_class": "crypto",
  "scope_ref": "clients/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "status": "active",
  "updated_at": "2026-05-01T10:00:00Z"
}

Resource created successfully.

Response 201 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
asset string or null No
created_at 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))$
crypto_routing object or null No
fiat_routing object or null No
id 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)$
label string or null No
rail_class "fiat" / "crypto" Yes
scope_ref string Yes pattern: ^(enterprises|platform-operators|clients)\/([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
status "active" / "disabled" / "retired" Yes
updated_at 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))$

Additional fields are not accepted.

application/json body.asset

At least one alternative must match.

application/json body.asset: alternative 1

Currency code (ISO-4217 or on-chain ticker)

Type: string. pattern: ^[A-Z0-9]{1,16}$

application/json body.asset: alternative 2

Type: null.

application/json body.crypto_routing

At least one alternative must match.

application/json body.crypto_routing: alternative 1
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
destination object Yes No additional fields
label string or null Yes
network string Yes minLength: 1

Additional fields are not accepted.

application/json body.crypto_routing: alternative 1.destination
Field Type Required Description and constraints
address string Yes minLength: 1; maxLength: 256
memo string or null Yes

Additional fields are not accepted.

application/json body.crypto_routing: alternative 1.destination.memo

At least one alternative must match.

application/json body.crypto_routing: alternative 1.destination.memo: alternative 1

Type: string.

application/json body.crypto_routing: alternative 1.destination.memo: alternative 2

Type: null.

application/json body.crypto_routing: alternative 1.label

At least one alternative must match.

application/json body.crypto_routing: alternative 1.label: alternative 1

Type: string.

application/json body.crypto_routing: alternative 1.label: alternative 2

Type: null.

application/json body.crypto_routing: alternative 2

Type: null.

application/json body.fiat_routing

At least one alternative must match.

application/json body.fiat_routing: alternative 1
Field Type Required Description and constraints
bank_coordinates object or object Yes
beneficiary_name string Yes minLength: 1; maxLength: 140
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
fiat_rail "sepa_credit_transfer" / "faster_payments" / "swift" / "local_bank_transfer" / "fedwire" Yes
method "bank_transfer" Yes
reference_hint string or null Yes

Additional fields are not accepted.

application/json body.fiat_routing: alternative 1.bank_coordinates

Exactly one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1
Field Type Required Description and constraints
account_holder_name string Yes minLength: 1; maxLength: 140
bank_address object or null No Postal address of the bank that holds the account.
bank_name string or null Yes
bic string or null Yes
country string Yes pattern: ^[A-Z]{2}$
iban string Yes minLength: 1; maxLength: 34
scheme "iban" Yes

Additional fields are not accepted.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address

Postal address of the bank that holds the account.

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 1.postal_code

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 1.postal_code: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 1.region

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 1.region: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_address: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_name

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_name: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bank_name: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bic

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bic: alternative 1

Type: string. minLength: 1; maxLength: 11

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 1.bic: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2
Field Type Required Description and constraints
account_holder_name string Yes minLength: 1; maxLength: 140
account_number string Yes minLength: 1; maxLength: 64
account_type "checking" / "savings" or null No Checking or savings. Required by some payout rails (a US domestic wire); null or absent where the rail has no such concept.
bank_address object or null No Postal address of the bank that holds the account.
bank_name string or null Yes
bic string or null Yes
country string Yes pattern: ^[A-Z]{2}$
routing_codes object[] Yes minItems: 1; maxItems: 16
scheme "local_account" Yes

Additional fields are not accepted.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.account_type

Checking or savings. Required by some payout rails (a US domestic wire); null or absent where the rail has no such concept.

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.account_type: alternative 1

Type: "checking" / "savings".

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.account_type: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address

Postal address of the bank that holds the account.

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 1
Field Type Required Description and constraints
city string Yes minLength: 1; maxLength: 140
country string Yes pattern: ^[A-Z]{2}$
lines string[] Yes minItems: 1; maxItems: 4
postal_code string or null Yes
region string or null Yes

Additional fields are not accepted.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 1.lines

Type: string[]. minItems: 1; maxItems: 4

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 1.lines item

Type: string. minLength: 1; maxLength: 140

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 1.postal_code

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 1.postal_code: alternative 1

Type: string. minLength: 1; maxLength: 32

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 1.postal_code: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 1.region

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 1.region: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 1.region: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_address: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_name

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_name: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bank_name: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bic

At least one alternative must match.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bic: alternative 1

Type: string. minLength: 1; maxLength: 11

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.bic: alternative 2

Type: null.

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.routing_codes

Type: object[]. minItems: 1; maxItems: 16

application/json body.fiat_routing: alternative 1.bank_coordinates: alternative 2.routing_codes item
Field Type Required Description and constraints
type string Yes minLength: 1; maxLength: 64
value string Yes minLength: 1; maxLength: 64

Additional fields are not accepted.

application/json body.fiat_routing: alternative 1.reference_hint

At least one alternative must match.

application/json body.fiat_routing: alternative 1.reference_hint: alternative 1

Type: string. minLength: 1; maxLength: 140

application/json body.fiat_routing: alternative 1.reference_hint: alternative 2

Type: null.

application/json body.fiat_routing: alternative 2

Type: null.

application/json body.label

At least one alternative must match.

application/json body.label: alternative 1

Type: string.

application/json body.label: alternative 2

Type: null.

Response 400 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 401 schema

Content type: application/json.

application/json body

Field Type Required Description and constraints
code string Yes
data object No No additional fields
details object No Additional fields allowed
message string Yes

Additional fields are not accepted.

application/json body.data
Field Type Required Description and constraints
acr_values string No RFC 9470 step-up challenge (insufficient_user_authentication).
blockers object[] No For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.
code string No For legal refusals: the document code the refusal is about.
max_age string No RFC 9470 step-up challenge (insufficient_user_authentication).
max_source_amount object or null No For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum. No additional fields
min_source_amount object No For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included. No additional fields
published_version string No For document_version_superseded: the version currently published.
reason string No Typed refinement of code, from the failing service's contract.
resource string No Resource kind a resource_not_found refers to.
retry_after_ms integer or null No Suggested back-off in milliseconds for throttling or temporary unavailability; null means no delay is known. minimum: 0
source string No For not_admissible: the gate that denied (verification, lifecycle, policy, compliance).

Additional fields are not accepted.

application/json body.data.blockers

For closure_preconditions_not_met on a terminal lifecycle verb: what must be resolved before the transition.

Type: object[].

application/json body.data.blockers item
Field Type Required Description and constraints
description string Yes
type "non_zero_balance" / "active_sub_resources" / "pending_operations" / "active_users" / "active_service_accounts" / "active_role_assignments" Yes
assets object[] No minItems: 1
count integer No minimum: 0; maximum: 9007199254740991

Additional fields are not accepted.

application/json body.data.blockers item.assets

Type: object[]. minItems: 1

application/json body.data.blockers item.assets item
Field Type Required Description and constraints
asset string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
kind "balance" / "held" / "owed" / "unsettled" Yes

Additional fields are not accepted.

application/json body.data.max_source_amount

For amount_below_minimum / amount_above_maximum: the product maximum in source asset units; null means no maximum.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

application/json body.data.min_source_amount

For amount_below_minimum / amount_above_maximum: the effective minimum in source asset units, fees included.

Field Type Required Description and constraints
currency string Yes
value string Yes

Additional fields are not accepted.

Response 403 schema

Content type: application/json.

See response 401 schema.

Response 409 schema

Content type: application/json.

See response 401 schema.

Response 500 schema

Content type: application/json.

See response 401 schema.

Response 502 schema

Content type: application/json.

See response 400 schema.

Response 503 schema

Content type: application/json.

See response 400 schema.