postCreate off-ramp session

Required capabilityramps.create

Authentication: Send Authorization: Bearer <access_token>.

Initiates an off-ramp session. amount is the principal to debit from the account; target_currency is the asset the recipient will receive; target_rail selects the outbound delivery rail (fiat or crypto), and destination carries the matching typed withdrawal destination command. Crypto commands include a nullable destination_id, network and strict address/memo; fiat commands must identify an existing stored withdrawal destination and restate its routing. Caller fiat bank details may include bank_address and account_type where applicable; provider-issued receive details are refused. An amount with more fractional digits than the catalog scale of its asset is refused with 400 invalid_request and data.reason = amount_scale_exceeded before anything is held; trailing zeros do not count, and an asset the catalog has no scale for (including crypto assets missing scale metadata) is not checked. Supply Idempotency-Key or body client_idempotency_key for idempotent retries; the header takes precedence. If both are absent, edge generates a fresh key, so a retry creates another operation.

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
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})$
amount object Yes No additional fields
client_idempotency_key string No minLength: 1
destination object Yes No additional fields
target_currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
target_rail "crypto" Yes

Additional fields are not accepted.

Request body schema: alternative 1.amount
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

Request body schema: alternative 1.destination
Field Type Required Description and constraints
destination object Yes No additional fields
destination_id string or null Yes
network string Yes minLength: 1

Additional fields are not accepted.

Request body schema: alternative 1.destination.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.destination.destination.memo

At least one alternative must match.

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

Type: string.

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

Type: null.

Request body schema: alternative 1.destination.destination_id

At least one alternative must match.

Request body schema: alternative 1.destination.destination_id: alternative 1

Type: string. 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)$

Request body schema: alternative 1.destination.destination_id: 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})$
amount object Yes No additional fields
client_idempotency_key string No minLength: 1
destination object Yes No additional fields
target_currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
target_rail "fiat" Yes

Additional fields are not accepted.

Request body schema: alternative 2.amount
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

Request body schema: alternative 2.destination
Field Type Required Description and constraints
destination object Yes No additional fields
fiat_rail "sepa_credit_transfer" / "faster_payments" / "swift" / "local_bank_transfer" / "fedwire" Yes
method "bank_transfer" Yes
payment_reference string or null Yes
route_owner_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})$
withdrawal_destination_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)$

Additional fields are not accepted.

Request body schema: alternative 2.destination.destination
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.destination.destination.bank_coordinates

Exactly one alternative must match.

Request body schema: alternative 2.destination.destination.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.destination.destination.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.destination.destination.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.destination.destination.bank_coordinates: alternative 1.bank_address: alternative 1.lines

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

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

Type: string. minLength: 1; maxLength: 140

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

At least one alternative must match.

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

Type: string. minLength: 1; maxLength: 32

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

Type: null.

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

At least one alternative must match.

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

Type: string. minLength: 1; maxLength: 140

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

Type: null.

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

Type: null.

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

At least one alternative must match.

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

Type: string. minLength: 1; maxLength: 140

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

Type: null.

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

At least one alternative must match.

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

Type: string. minLength: 1; maxLength: 11

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

Type: null.

Request body schema: alternative 2.destination.destination.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.destination.destination.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.destination.destination.bank_coordinates: alternative 2.account_type: alternative 1

Type: "checking" / "savings".

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

Type: null.

Request body schema: alternative 2.destination.destination.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.destination.destination.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.destination.destination.bank_coordinates: alternative 2.bank_address: alternative 1.lines

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

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

Type: string. minLength: 1; maxLength: 140

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

At least one alternative must match.

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

Type: string. minLength: 1; maxLength: 32

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

Type: null.

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

At least one alternative must match.

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

Type: string. minLength: 1; maxLength: 140

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

Type: null.

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

Type: null.

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

At least one alternative must match.

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

Type: string. minLength: 1; maxLength: 140

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

Type: null.

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

At least one alternative must match.

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

Type: string. minLength: 1; maxLength: 11

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

Type: null.

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

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

Request body schema: alternative 2.destination.destination.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.destination.destination.reference_hint

At least one alternative must match.

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

Type: string. minLength: 1; maxLength: 140

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

Type: null.

Request body schema: alternative 2.destination.payment_reference

At least one alternative must match.

Request body schema: alternative 2.destination.payment_reference: alternative 1

Type: string. minLength: 1; maxLength: 140

Request body schema: alternative 2.destination.payment_reference: alternative 2

Type: null.

Request URL

POST
POST /off-ramp-sessions

Request Body

application/json
{
  "account_ref": "client-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "amount": {
    "currency": "USDC",
    "value": "250.00"
  },
  "destination": {
    "destination": {
      "bank_coordinates": {
        "account_holder_name": "Acme Treasury",
        "bank_name": "Demo Bank",
        "bic": "NWBKGB2L",
        "country": "GB",
        "iban": "GB29NWBK60161331926819",
        "scheme": "iban"
      },
      "beneficiary_name": "Acme Treasury",
      "currency": "EUR",
      "fiat_rail": "sepa_credit_transfer",
      "method": "bank_transfer",
      "reference_hint": null
    },
    "fiat_rail": "sepa_credit_transfer",
    "method": "bank_transfer",
    "payment_reference": "RF18539007547034",
    "route_owner_ref": "clients/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
    "withdrawal_destination_id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
  },
  "target_currency": "EUR",
  "target_rail": "fiat"
}

Responses

Response

application/json
{
  "account_ref": "client-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "approval_ref": null,
  "created_at": "2026-05-01T10:00:00Z",
  "failure_reason": null,
  "family": "off_ramp",
  "family_params": {
    "destination_payload": {
      "destination": {
        "bank_coordinates": {
          "account_holder_name": "Acme Treasury",
          "bank_name": "Demo Bank",
          "bic": "NWBKGB2L",
          "country": "GB",
          "iban": "GB29NWBK60161331926819",
          "scheme": "iban"
        },
        "beneficiary_name": "Acme Treasury",
        "currency": "EUR",
        "fiat_rail": "sepa_credit_transfer",
        "method": "bank_transfer",
        "reference_hint": null
      },
      "fiat_rail": "sepa_credit_transfer",
      "method": "bank_transfer",
      "payment_reference": "RF18539007547034",
      "withdrawal_destination_id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
    },
    "intermediate_ref": "client-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
    "source_amount": {
      "currency": "USDC",
      "value": "250.00"
    },
    "source_ref": "client-accounts/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
    "target_currency": "EUR",
    "target_rail": "fiat"
  },
  "fee_summary": null,
  "fill_rate": null,
  "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "principal_amount": {
    "currency": "USDC",
    "value": "250.00"
  },
  "settled_at": null,
  "status": "admissible",
  "subject_attribution": {
    "actor": null,
    "approved_by": null,
    "authenticated_principal": {
      "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "kind": "user",
      "tenant_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
    },
    "enterprise_binding": {
      "tenant_type": "enterprise",
      "topology_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
    },
    "federation": null,
    "identity_source": "platform-managed",
    "initiated_by": null,
    "subject": {
      "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
      "kind": "user",
      "tenant_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b"
    }
  },
  "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
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})$
admission_hold_reason "CLIENT_NOT_VERIFIED" / "ENTERPRISE_NOT_VERIFIED" / "ENTERPRISE_NOT_OPERATIONAL" / "ENTERPRISE_RESTRICTED" / "ACCOUNT_SUSPENDED" / "ACCOUNT_CLOSED" / "CLIENT_SUSPENDED" / "CLIENT_CLOSED" or null No
approval_ref object or null Yes
compliance_assessment_ref string or null No
created_at string or string Yes
failure_reason string or null Yes
family "deposit" / "withdrawal" / "conversion" / "external_settlement_conversion" / "internal_transfer" / "on_ramp" / "off_ramp" / "loan_origination" / "loan_repayment" / "loan_liquidation" / "loan_closing" / "loan_extension" Yes
family_params object Yes
fee_summary object or null Yes
fill_rate string or null Yes
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)$
principal_amount object Yes No additional fields
settled_at string or string or null Yes
status "requested" / "admissible" / "executing" / "pending_approval" / "pending_admission" / "pending_compliance" / "executed" / "settled" / "ledger_visible" / "failed" / "cancelled" / "partially_settled" Yes
subject_attribution object Yes No additional fields
updated_at string or string Yes

Additional fields are not accepted.

application/json body.admission_hold_reason

At least one alternative must match.

application/json body.admission_hold_reason: alternative 1

Type: "CLIENT_NOT_VERIFIED" / "ENTERPRISE_NOT_VERIFIED" / "ENTERPRISE_NOT_OPERATIONAL" / "ENTERPRISE_RESTRICTED" / "ACCOUNT_SUSPENDED" / "ACCOUNT_CLOSED" / "CLIENT_SUSPENDED" / "CLIENT_CLOSED".

application/json body.admission_hold_reason: alternative 2

Type: null.

application/json body.approval_ref

At least one alternative must match.

application/json body.approval_ref: alternative 1
Field Type Required Description and constraints
approval_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)$
expires_at string or string Yes
reason_code string or null Yes

Additional fields are not accepted.

application/json body.approval_ref: alternative 1.expires_at

At least one alternative must match.

application/json body.approval_ref: alternative 1.expires_at: alternative 1

Type: string. 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))$

application/json body.approval_ref: alternative 1.expires_at: alternative 2

Type: string. format: date-time

application/json body.approval_ref: alternative 1.reason_code

At least one alternative must match.

application/json body.approval_ref: alternative 1.reason_code: alternative 1

Type: string.

application/json body.approval_ref: alternative 1.reason_code: alternative 2

Type: null.

application/json body.approval_ref: alternative 2

Type: null.

application/json body.compliance_assessment_ref

At least one alternative must match.

application/json body.compliance_assessment_ref: alternative 1

Type: string. pattern: ^(compliance-assessments)\/([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})$

application/json body.compliance_assessment_ref: alternative 2

Type: null.

application/json body.created_at

At least one alternative must match.

application/json body.created_at: alternative 1

Type: string. 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))$

application/json body.created_at: alternative 2

Type: string. format: date-time

application/json body.failure_reason

At least one alternative must match.

application/json body.failure_reason: alternative 1

Type: string. minLength: 1

application/json body.failure_reason: alternative 2

Type: null.

application/json body.fee_summary

At least one alternative must match.

application/json body.fee_summary: alternative 1
Field Type Required Description and constraints
components object[] Yes
total object Yes No additional fields

Additional fields are not accepted.

application/json body.fee_summary: alternative 1.components

Type: object[].

application/json body.fee_summary: alternative 1.components item
Field Type Required Description and constraints
amount object Yes No additional fields
kind "platform_fee" / "enterprise_fee" / "network_fee" / "spread" Yes

Additional fields are not accepted.

application/json body.fee_summary: alternative 1.components item.amount
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.fee_summary: alternative 1.total
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.fee_summary: alternative 2

Type: null.

application/json body.fill_rate

At least one alternative must match.

application/json body.fill_rate: alternative 1

Type: string.

application/json body.fill_rate: alternative 2

Type: null.

application/json body.principal_amount
Field Type Required Description and constraints
currency string Yes Currency code (ISO-4217 or on-chain ticker) pattern: ^[A-Z0-9]{1,16}$
value string Yes DecimalString pattern: ^(0|[1-9][0-9]{0,29})(\.[0-9]{1,18})?$

Additional fields are not accepted.

application/json body.settled_at

At least one alternative must match.

application/json body.settled_at: alternative 1

At least one alternative must match.

application/json body.settled_at: alternative 1: alternative 1

Type: string. 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))$

application/json body.settled_at: alternative 1: alternative 2

Type: string. format: date-time

application/json body.settled_at: alternative 2

Type: null.

application/json body.subject_attribution
Field Type Required Description and constraints
actor object or null Yes
approved_by object or null Yes
authenticated_principal object Yes No additional fields
enterprise_binding object Yes No additional fields
federation object or null Yes
identity_source "platform-managed" / "federated" / "system" Yes
initiated_by object or null Yes
subject object or null Yes

Additional fields are not accepted.

application/json body.subject_attribution.actor

At least one alternative must match.

application/json body.subject_attribution.actor: alternative 1
Field Type Required Description and constraints
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)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.subject_attribution.actor: alternative 1.tenant_ref

At least one alternative must match.

application/json body.subject_attribution.actor: alternative 1.tenant_ref: alternative 1

Type: string. 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})$

application/json body.subject_attribution.actor: alternative 1.tenant_ref: alternative 2

Type: null.

application/json body.subject_attribution.actor: alternative 2

Type: null.

application/json body.subject_attribution.approved_by

At least one alternative must match.

application/json body.subject_attribution.approved_by: alternative 1
Field Type Required Description and constraints
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)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.subject_attribution.approved_by: alternative 1.tenant_ref

At least one alternative must match.

application/json body.subject_attribution.approved_by: alternative 1.tenant_ref: alternative 1

Type: string. 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})$

application/json body.subject_attribution.approved_by: alternative 1.tenant_ref: alternative 2

Type: null.

application/json body.subject_attribution.approved_by: alternative 2

Type: null.

application/json body.subject_attribution.authenticated_principal
Field Type Required Description and constraints
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)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.subject_attribution.authenticated_principal.tenant_ref

At least one alternative must match.

application/json body.subject_attribution.authenticated_principal.tenant_ref: alternative 1

Type: string. 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})$

application/json body.subject_attribution.authenticated_principal.tenant_ref: alternative 2

Type: null.

application/json body.subject_attribution.enterprise_binding
Field Type Required Description and constraints
tenant_type "enterprise" / "platform_operator" Yes
topology_ref string or null Yes

Additional fields are not accepted.

application/json body.subject_attribution.enterprise_binding.topology_ref

At least one alternative must match.

application/json body.subject_attribution.enterprise_binding.topology_ref: alternative 1

Type: string. 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})$

application/json body.subject_attribution.enterprise_binding.topology_ref: alternative 2

Type: null.

application/json body.subject_attribution.federation

At least one alternative must match.

application/json body.subject_attribution.federation: alternative 1
Field Type Required Description and constraints
external_subject string Yes minLength: 1
issuer string Yes minLength: 1

Additional fields are not accepted.

application/json body.subject_attribution.federation: alternative 2

Type: null.

application/json body.subject_attribution.initiated_by

At least one alternative must match.

application/json body.subject_attribution.initiated_by: alternative 1
Field Type Required Description and constraints
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)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.subject_attribution.initiated_by: alternative 1.tenant_ref

At least one alternative must match.

application/json body.subject_attribution.initiated_by: alternative 1.tenant_ref: alternative 1

Type: string. 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})$

application/json body.subject_attribution.initiated_by: alternative 1.tenant_ref: alternative 2

Type: null.

application/json body.subject_attribution.initiated_by: alternative 2

Type: null.

application/json body.subject_attribution.subject

At least one alternative must match.

application/json body.subject_attribution.subject: alternative 1
Field Type Required Description and constraints
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)$
kind "user" / "service" / "system" Yes
tenant_ref string or null No

Additional fields are not accepted.

application/json body.subject_attribution.subject: alternative 1.tenant_ref

At least one alternative must match.

application/json body.subject_attribution.subject: alternative 1.tenant_ref: alternative 1

Type: string. 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})$

application/json body.subject_attribution.subject: alternative 1.tenant_ref: alternative 2

Type: null.

application/json body.subject_attribution.subject: alternative 2

Type: null.

application/json body.updated_at

At least one alternative must match.

application/json body.updated_at: alternative 1

Type: string. 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))$

application/json body.updated_at: alternative 2

Type: string. format: date-time

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 422 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.