Schemas(v1)

Unique identifier for the account

Workspace ID the account belongs to

Account type

Account name

Creation timestamp

Last update timestamp

Name of the financial institution

Type of bank code (e.g., SWIFT, BIC, IBAN, ROUTING, SORT_CODE)

Bank identifier code value

Tenant ID (if account belongs to a tenant)

Counterparty ID (if account belongs to a counterparty)

SWIFT code

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

Currency symbol

Available balance in smallest unit

Unique identifier for the account

Workspace ID the account belongs to

Account type

Account name

Creation timestamp

Last update timestamp

Liquidity provider that manages this ledger account

Tenant ID (if account belongs to a tenant)

Counterparty ID (if account belongs to a counterparty)

Ledger assets with balances

Currency symbol

Blockchain network

Available balance in smallest unit

Unique identifier for the account

Workspace ID the account belongs to

Account type

Account name

Creation timestamp

Last update timestamp

Blockchain wallet address

Whether this is a managed wallet (provisioned by Tesser), or unmanaged (not provisioned by Tesser)

Tenant ID (if account belongs to a tenant)

Counterparty ID (if account belongs to a counterparty)

Wallet assets with balances

Currency symbol

Available balance in smallest unit

Blockchain network (only for wallet accounts)

Unique identifier for the account

Workspace ID the account belongs to

Account type

Account name

Creation timestamp

Last update timestamp

Tenant ID (if account belongs to a tenant)

Counterparty ID (if account belongs to a counterparty)

Bank name (only for fiat_bank accounts)

Bank code type (only for fiat_bank accounts)

Bank identifier code (only for fiat_bank accounts)

SWIFT code (only for fiat_bank accounts)

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

Crypto wallet address (only for wallet accounts)

Is managed wallet (only for wallet accounts)

Ledger provider (only for ledger accounts)

Account assets with balances (for wallet and ledger accounts)

Current page number.

Number of items per page.

Total number of items.

Total number of pages.

Whether there is a next page.

Whether there is a previous page.

Human-readable name for the bank account

Name of the financial institution

Type of bank code (e.g., SWIFT, BIC, IBAN, ROUTING, SORT_CODE)

Bank identifier code value

Bank account number. SECURE FIELD: Encrypted and stored in vault, never returned in responses. Required in API request.

Tenant ID (mutually exclusive with counterparty_id). Links this account to a specific tenant.

Counterparty ID (mutually exclusive with tenant_id). Links this account to a specific counterparty.

SWIFT code

Human-readable name for the wallet account

Stablecoin network type. Determines which blockchain network the wallet operates on.

Tenant ID (mutually exclusive with counterparty_id). Links this wallet to a specific tenant.

Counterparty ID (mutually exclusive with tenant_id). Links this wallet to a specific counterparty.

A cryptographic stamp used to verify the integrity and authenticity of the request. This ensures the request was signed by an authorized key. Required for managed wallets (is_managed=true). See Documentation > Signing for more details.

Whether this is a managed wallet (provisioned by Tesser), or unmanaged (not provisioned by Tesser). Managed wallets (true) require a signature and automatically create USDC/USDT assets. Unmanaged wallets (false) require a wallet_address. Defaults to false.

Blockchain wallet address. Required for unmanaged wallets (is_managed=false). Auto-generated for managed wallets.

Human-readable name for the ledger account

Liquidity provider that manages this ledger account. CIRCLE_MINT for Circle Mint accounts, KRAKEN for Kraken exchange accounts.

Tenant ID (mutually exclusive with counterparty_id). Links this ledger account to a specific tenant.

Counterparty ID (mutually exclusive with tenant_id). Links this ledger account to a specific counterparty.

New account name

Display name for the currency (e.g., 'Circle USD')

Currency code/key (e.g., 'USDC', 'USD')

Number of decimal places for the currency

Blockchain network (e.g., 'POLYGON') or null for fiat currencies. See GET /networks for supported values.

List of all supported currencies

Network key/identifier (e.g., 'POLYGON', 'POLYGON_AMOY')

Display name for the network (e.g., 'Polygon')

List of all supported networks

Unique identifier for the counterparty

Workspace ID the counterparty belongs to

Classification: individual (person) or business (company)

Creation timestamp in ISO 8601 format

Last update timestamp in ISO 8601 format

Optional reference to a tenant entity this counterparty belongs to

First name (for individuals)

Last name (for individuals)

Country code in ISO 3166-1 format (for individuals)

Date of birth (for individuals)

National identification number (for individuals)

Street address line 1 (for individuals)

Street address line 2 (for individuals)

City (for individuals)

State/region (for individuals)

Postal code (for individuals)

Legal business name (for businesses)

DBA - Doing Business As (for businesses)

Country code in ISO 3166-1 format (for businesses)

Street address line 1 (for businesses)

Street address line 2 (for businesses)

City (for businesses)

State/region (for businesses)

Legal Entity Identifier (for businesses)

Classification: 'individual' or 'business'.

ID of the tenant entity (optional).

First name (required if classification is 'individual'). Secure field, returned based on include_secure.

Last name (required if classification is 'individual'). Secure field, returned based on include_secure.

ISO 3166-1 alpha-2 or alpha-3 country code.

Date of birth (for individuals).

National identification number (for individuals). Secure field, returned based on include_secure.

Street address line 1 (for individuals). Secure field, returned based on include_secure.

Street address line 2 (for individuals). Secure field, returned based on include_secure.

City (for individuals). Secure field, returned based on include_secure.

State/region (for individuals). Secure field, returned based on include_secure.

Postal code (for individuals). Secure field, returned based on include_secure.

Legal business name (required if classification is 'business').

Doing Business As name (optional).

ISO 3166-1 alpha-2 or alpha-3 country code.

Street address line 1 (for businesses).

Street address line 2 (for businesses).

City (for businesses).

State/region (for businesses).

Legal Entity Identifier (for businesses). Secure field, returned based on include_secure.

Unique identifier for the tenant

Workspace ID the tenant belongs to

Display name derived from business fields

Creation timestamp in ISO 8601 format

Last update timestamp in ISO 8601 format

Legal business name

DBA - Doing Business As

Country code in ISO 3166-1 format

Webhook URL for payment creation notifications

Street address line 1

Street address line 2

City

State/region

Postal code

Legal Entity Identifier

Legal business name (required)

DBA - Doing Business As name

Country code in ISO 3166-1 alpha-2 or alpha-3 format

Webhook URL for payment creation notifications

Street address line 1

Street address line 2

City

State/region

Postal code

Legal Entity Identifier

The risk profile for compliance screening

New risk profile

Previous risk profile

Timestamp of the update

Current risk profile

The secret provider (CIRCLE_MINT or OPENFX)

The secret key name (must be a known organization secret key)

Secret payload. A string for single-value secrets, or an object for bundled credentials (e.g., OPENFX_CREDENTIALS).

Whether the secret was stored successfully

Masked version of the stored secret (e.g., '****abc123')

Account ID.

Amount.

Currency code.

Blockchain network.

Account ID.

Amount.

Currency code.

Blockchain network.

Source side.

Destination side.

Account ID.

Amount.

Currency code.

Blockchain network.

Account ID.

Amount.

Currency code.

Blockchain network.

Source side.

Destination side.

Account ID.

Amount.

Currency code.

Blockchain network.

Account ID.

Amount.

Currency code.

Blockchain network.

Source side.

Destination side.

Account ID.

Amount.

Currency code.

Blockchain network.

Account ID.

Amount.

Currency code.

Blockchain network.

Source side.

Destination side.

Account ID.

Amount.

Currency code.

Blockchain network.

Account ID.

Amount.

Currency code.

Blockchain network.

Source side.

Destination side.

Fee amount.

Fee currency code.

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

Additional metadata for the fee (JSON object).

Unique step identifier

ID of the parent payment

Order of this step in the payment flow

Type of step

Planned values for this step.

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

Fees associated with this step.

Current status of this step

Step creation timestamp

Step last update timestamp

Blockchain transaction hash

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

Provider used for this step

Reasons for the current status

Provider-specific data (JSON object).

Timestamp when step was submitted

Timestamp when step was confirmed

Timestamp when step completed

Timestamp when step failed

Unique payment identifier

Workspace ID the payment belongs to

Payment direction.

Funding account ID. Payment-only field. Top-level (not part of any overlay).

Caller's stated intent at creation. Frozen except by the two-step PATCH flow which fills account IDs.

Tesser's projection for how the payment will proceed.

What actually settled. Populated once at least one step has status: completed.

Risk assessment status.

Balance reservation status.

Timestamp when balance was reserved.

Payment execution steps.

ISO 8601 timestamp of creation.

ISO 8601 timestamp of last update.

ISO 8601 timestamp when the payment expires.

External reference ID for tracking.

Reasons for risk status.

User ID who reviewed the risk.

Timestamp when risk was reviewed.

Payment data

Entity unique identifier

Entity classification: 'individual' or 'business'

Account unique identifier

Account name

Computed payment status for UI

Approve (true) or reject (false) the payment.

Source currency code.

Source account ID. May be omitted at POST and supplied later via PATCH (two-step PATCH flow).

Source amount. Exactly one of desired.from.amount or desired.to.amount must be supplied.

Source blockchain network. Required when desired.from.currency is a stablecoin.

Destination currency code.

Destination account ID. May be omitted at POST and supplied later via PATCH (two-step PATCH flow).

Destination amount. Exactly one of desired.from.amount or desired.to.amount must be supplied.

Destination blockchain network. Required for crypto-to-crypto payments.

Source side of the payment.

Destination side of the payment.

Caller's stated intent for the payment.

Optional external reference ID for tracking.

Funding account ID. Optional at POST to support the two-step PATCH creation flow; required together with desired.from.account_id and desired.to.account_id once any of the three is supplied.

Source account ID.

Destination account ID.

Source side of the payment (account-only update).

Destination side of the payment (account-only update).

Funding account ID for the payment.

Account IDs to attach to the payment.

Optional external reference ID for tracking.

Base64-encoded JSON envelope { body, stamp } where body is the JSON-encoded Turnkey ACTIVITY_TYPE_SIGN_TRANSACTION_V2 activity and stamp is the X-Stamp header value produced by stamping that body. Wire format: base64(JSON.stringify({ body, stamp })).