Schemas

Download schema

Money

string · pattern: ^[0-9]+(\.[0-9]+)?$

QuoteStatus

string · enum

Enum values:

CREATED

ACCEPTED

DEPOSIT_REPORTED

CREDIT_SENT

CREDIT_CONFIRMED

PAYMENT_COMPLETED

PAYMENT_FAILED

PAYMENT_RETURNED

PaymentStatus

string · enum

Enum values:

COMPLETED

FAILED

RETURNED

Outcome of the payout. The call performs the payout and answers with the outcome, so COMPLETED or FAILED can both come back synchronously. RETURNED, and a FAILED that only surfaces on the rail after a COMPLETED response, arrive later via the failure webhook.

RiskStatus

string · enum

Enum values:

unchecked

awaiting_decision

automatically_approved

manually_approved

automatically_rejected

manually_rejected

RiskStatusReason

risk_status_reason_type

string · enum · required

Enum values:

ENTITY

ACCOUNT

OWNERSHIP

COUNTERPARTY

INDIRECT

BEHAVIORAL

ERROR

risk_status_reason_category

string

risk_status_reason_message

string

ErrorEnvelope

object[] · required

request_id

string · required

WebhookEnvelope

event_id

string · uuid · required

event_type

string · required

occurred_at

string · date-time · required

data

object · required

AccountAssetDto

currency

string · required

Currency symbol

available_balance

string · required

Available balance as a decimal string in currency units. Precision depends on the currency, network, and account provider.

network

string

Blockchain network (only for wallet accounts)

AccountData

id

string · required

Unique identifier for the account

workspace_id

string · required

Workspace ID the account belongs to

type

string · required

Account type

name

string · required

Account name

created_by

string · enum · required

Whether the customer registered this account (CUSTOMER) or Tesser synthesized it (SYSTEM).

Enum values:

CUSTOMER

SYSTEM

created_at

string · required

Creation timestamp

updated_at

string · required

Last update timestamp

tenant_id

string

Tenant ID (if account belongs to a tenant)

counterparty_id

string

Counterparty ID (if account belongs to a counterparty)

bank_name

string

Bank name (only for fiat_bank accounts)

bank_code_type

string

Bank code type (only for fiat_bank accounts)

bank_identifier_code

string

Bank identifier code (only for fiat_bank accounts)

bank_swift_code

string

SWIFT code (only for fiat_bank accounts)

bank_account_number

string

Bank account number (masked, only with include_secure=true)

crypto_wallet_address

string

Crypto wallet address (only for wallet accounts)

is_managed

boolean

Is managed wallet (only for wallet accounts)

generic_account_number

string

Account identifier (only for generic accounts)

provider

string · enum

Ledger provider (only for ledger accounts)

Enum values:

CIRCLE_MINT

KRAKEN

OPENFX

ZUBA

AccountAssetDto[]

Account assets with balances (for wallet and ledger accounts)

AccountResponseDto

AccountData · required

CreateWithdrawalRequest

object · required

Caller's stated intent for the withdrawal.

organization_reference_id

string

Optional client-supplied identifier.

StatusReason

error_code

string · required

error_message

string · required

StepFee

fee_amount

string · required

Fee amount.

fee_currency

string · required

Fee currency code.

fee_type

string · required

Fee type (e.g., 'gas', 'provider', 'tesser_fee').

object

Additional metadata for the fee (JSON object).

Withdrawal

id

string · required

Unique withdrawal identifier

workspace_id

string · required

Workspace ID the withdrawal belongs to

direction

string · enum · required

Resource direction.

Enum values:

outbound

object · required

Caller's stated intent at creation. Frozen, never overwritten.

object · required

Tesser's projection for how the withdrawal will proceed.

object · required

What actually settled. Populated when the withdrawal reaches a terminal state.

balance_status

string · enum · required

Balance reservation status.

Enum values:

unreserved

awaiting_funds

reserved

balance_reserved_at

string · date-time · required

Timestamp when balance was reserved.

WithdrawalStep[] · required

Withdrawal execution steps.

created_at

string · required

ISO 8601 timestamp of creation.

updated_at

string · required

ISO 8601 timestamp of last update.

expires_at

string · required

ISO 8601 timestamp when the withdrawal expires.

organization_reference_id

string

External reference ID for tracking

WithdrawalActualFromLeg

Source side.

account_id

string · required

Account ID.

amount

string · required

WithdrawalStep

id

string · required

Unique step identifier

withdrawal_id

string · required

ID of the parent withdrawal

step_sequence

integer · required

Order of this step in the withdrawal flow (1-based)

step_type

string · enum · required

Type of step

Enum values:

transfer

swap

object · required

Planned values for this step.

object · required

Settled values once the step reaches a terminal state. All-null until then.

StepFee[] · required

Fees associated with this step

status

string · enum · required

Current status of this step

Enum values:

created

signature_requested

signed

submitted

confirmed

completed

failed

created_at

string · date-time · required

Step creation timestamp

updated_at

string · date-time · required

Step last update timestamp

transaction_hash

string

Blockchain transaction hash

unsigned_transaction

string

Unsigned transaction bytes for client signing. Present only for Turnkey-signed steps in signature_requested status.

provider_key

string · enum

Provider used for this step

Enum values:

circle_mint

kraken

turnkey

openfx

zuba

StatusReason[]

Reasons for the current status

signature_requested_at

string · date-time

Timestamp when a signature was requested for the step

signed_at

string · date-time

Timestamp when the step was cryptographically signed

submitted_at

string · date-time

Timestamp when step was submitted

confirmed_at

string · date-time

Timestamp when step was confirmed

completed_at

string · date-time

Timestamp when step completed

failed_at

string · date-time

Timestamp when step failed

WithdrawalStepActualFromLeg

Source side.

account_id

string · required

Account ID.

amount

string · required

Planned values for this step.

WithdrawalStepEstimatedFromLeg · required

Source side.

WithdrawalStepEstimatedToLeg · required

Destination side.

WithdrawalStepEstimatedToLeg

Destination side.

account_id

string · required

Account ID.

amount

string · required

Amount.

currency

string · required

Currency code.

network

string · required

Blockchain network.

PaymentStatus

string · enum

Enum values:

COMPLETED

FAILED

RETURNED

AccountData

id

string · required

Unique identifier for the account

workspace_id

string · required

Workspace ID the account belongs to

type

string · required

Account type

name

string · required

Account name

created_by

string · enum · required

Whether the customer registered this account (CUSTOMER) or Tesser synthesized it (SYSTEM).

Enum values:

CUSTOMER

SYSTEM

created_at

string · required

Creation timestamp

updated_at

string · required

Last update timestamp

tenant_id

string

Tenant ID (if account belongs to a tenant)

counterparty_id

string

Counterparty ID (if account belongs to a counterparty)

bank_name

string

Bank name (only for fiat_bank accounts)

bank_code_type

string

Bank code type (only for fiat_bank accounts)

bank_identifier_code

string

Bank identifier code (only for fiat_bank accounts)

bank_swift_code

string

SWIFT code (only for fiat_bank accounts)

bank_account_number

string

Bank account number (masked, only with include_secure=true)

crypto_wallet_address

string

Crypto wallet address (only for wallet accounts)

is_managed

boolean

Is managed wallet (only for wallet accounts)

generic_account_number

string

Account identifier (only for generic accounts)

provider

string · enum

Ledger provider (only for ledger accounts)

Enum values:

CIRCLE_MINT

KRAKEN

OPENFX

ZUBA

AccountAssetDto[]

Account assets with balances (for wallet and ledger accounts)

Withdrawal

id

string · required

Unique withdrawal identifier

workspace_id

string · required

Workspace ID the withdrawal belongs to

direction

string · enum · required

Resource direction.

Enum values:

outbound

object · required

Caller's stated intent at creation. Frozen, never overwritten.

object · required

Tesser's projection for how the withdrawal will proceed.

object · required

What actually settled. Populated when the withdrawal reaches a terminal state.

balance_status

string · enum · required

Balance reservation status.

Enum values:

unreserved

awaiting_funds

reserved

balance_reserved_at

string · date-time · required

Timestamp when balance was reserved.

WithdrawalStep[] · required

Withdrawal execution steps.

created_at

string · required

ISO 8601 timestamp of creation.

updated_at

string · required

ISO 8601 timestamp of last update.

expires_at

string · required

ISO 8601 timestamp when the withdrawal expires.

organization_reference_id

string

External reference ID for tracking

WithdrawalStep

id

string · required

Unique step identifier

withdrawal_id

string · required

ID of the parent withdrawal

step_sequence

integer · required

Order of this step in the withdrawal flow (1-based)

step_type

string · enum · required

Type of step

Enum values:

transfer

swap

object · required

Planned values for this step.

object · required

Settled values once the step reaches a terminal state. All-null until then.

StepFee[] · required

Fees associated with this step

status

string · enum · required

Current status of this step

Enum values:

created

signature_requested

signed

submitted

confirmed

completed

failed

created_at

string · date-time · required

Step creation timestamp

updated_at

string · date-time · required

Step last update timestamp

transaction_hash

string

Blockchain transaction hash

unsigned_transaction

string

Unsigned transaction bytes for client signing. Present only for Turnkey-signed steps in signature_requested status.

provider_key

string · enum

Provider used for this step

Enum values:

circle_mint

kraken

turnkey

openfx

zuba

StatusReason[]

Reasons for the current status

signature_requested_at

string · date-time

Timestamp when a signature was requested for the step

signed_at

string · date-time

Timestamp when the step was cryptographically signed

submitted_at

string · date-time

Timestamp when step was submitted

confirmed_at

string · date-time

Timestamp when step was confirmed

completed_at

string · date-time

Timestamp when step completed

failed_at

string · date-time

Timestamp when step failed