Tesser API

Schemas(v1)

BankAccountData

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_at

string · required

Creation timestamp

updated_at

string · required

Last update timestamp

bank_name

string · required

Name of the financial institution

bank_code_type

string · required

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

bank_identifier_code

string · required

Bank identifier code value

tenant_id

string

Tenant ID (if account belongs to a tenant)

counterparty_id

string

Counterparty ID (if account belongs to a counterparty)

bank_swift_code

string

SWIFT code

bank_account_number

string

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

CreateBankAccountResponseDto

object · required

LedgerAssetDto

currency

string · required

Currency symbol

available_balance

string · required

Available balance in smallest unit

LedgerAccountData

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_at

string · required

Creation timestamp

updated_at

string · required

Last update timestamp

provider

string · enum · required

Liquidity provider that manages this ledger account

Enum values:

CIRCLE_MINT

KRAKEN

tenant_id

string

Tenant ID (if account belongs to a tenant)

counterparty_id

string

Counterparty ID (if account belongs to a counterparty)

object[]

Ledger assets with balances

CreateLedgerAccountResponseDto

object · required

WalletAssetDto

currency

string · required

Currency symbol

network

string · required

Blockchain network

available_balance

string · required

Available balance in smallest unit

WalletAccountData

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_at

string · required

Creation timestamp

updated_at

string · required

Last update timestamp

crypto_wallet_address

string · required

Blockchain wallet address

is_managed

boolean · required

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

tenant_id

string

Tenant ID (if account belongs to a tenant)

counterparty_id

string

Counterparty ID (if account belongs to a counterparty)

object[]

Wallet assets with balances

CreateWalletAccountResponseDto

object · required

AccountAssetDto

currency

string · required

Currency symbol

available_balance

string · required

Available balance in smallest unit

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_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)

provider

string · enum

Ledger provider (only for ledger accounts)

Enum values:

CIRCLE_MINT

KRAKEN

object[]

Account assets with balances (for wallet and ledger accounts)

Pagination

page

number · required

Current page number.

limit

number · required

Number of items per page.

total

number · required

Total number of items.

total_pages

number · required

Total number of pages.

has_next

boolean · required

Whether there is a next page.

has_prev

boolean · required

Whether there is a previous page.

AccountListResponse

object[] · required

object · required

AccountResponseDto

object · required

UpdateAccountResponseDto

object · required

CreateBankAccountRequestDto

name

string · minLength: 1 · maxLength: 255 · required

Human-readable name for the bank account

bank_name

string · minLength: 1 · maxLength: 255 · required

Name of the financial institution

bank_code_type

string · minLength: 1 · maxLength: 50 · required

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

bank_identifier_code

string · minLength: 1 · maxLength: 255 · required

Bank identifier code value

bank_account_number

string · minLength: 1 · maxLength: 255 · required

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

tenant_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

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

counterparty_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

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

bank_swift_code

string · minLength: 1

SWIFT code

CreateWalletAccountRequestDto

name

string · minLength: 1 · maxLength: 255 · required

Human-readable name for the wallet account

type

string · enum · required

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

Enum values:

stablecoin_ethereum

stablecoin_solana

stablecoin_stellar

tenant_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

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

counterparty_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

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

signature

string

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.

is_managed

boolean

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.

Default: false

wallet_address

string

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

CreateLedgerAccountRequestDto

name

string · minLength: 1 · maxLength: 255 · required

Human-readable name for the ledger account

provider

string · enum · required

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

Enum values:

CIRCLE_MINT

KRAKEN

tenant_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

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

counterparty_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

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

UpdateAccountRequestDto

name

string · minLength: 1

New account name

CreateInvitationRequestDto

email

string · email · pattern: ^(?!\.)(?!.*\.\.)([A… · required

Currency

name

string · required

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

key

string · required

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

decimals

number · required

Number of decimal places for the currency

network

string · required

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

CurrenciesResponse

object[] · required

List of all supported currencies

Network

key

string · required

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

name

string · required

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

NetworksResponse

object[] · required

List of all supported networks

CounterpartyData

id

string · required

Unique identifier for the counterparty

workspace_id

string · required

Workspace ID the counterparty belongs to

classification

string · enum · required

Classification: individual (person) or business (company)

Enum values:

individual

business

created_at

string · required

Creation timestamp in ISO 8601 format

updated_at

string · required

Last update timestamp in ISO 8601 format

tenant_id

string

Optional reference to a tenant entity this counterparty belongs to

individual_first_name

string

First name (for individuals)

individual_last_name

string

Last name (for individuals)

individual_address_country

string

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

individual_date_of_birth

string

Date of birth (for individuals)

individual_national_identification_number

string

National identification number (for individuals)

individual_street_address1

string

Street address line 1 (for individuals)

individual_street_address2

string

Street address line 2 (for individuals)

individual_city

string

City (for individuals)

individual_state

string

State/region (for individuals)

individual_postal_code

string

Postal code (for individuals)

business_legal_name

string

Legal business name (for businesses)

business_dba

string

DBA - Doing Business As (for businesses)

business_address_country

string

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

business_street_address1

string

Street address line 1 (for businesses)

business_street_address2

string

Street address line 2 (for businesses)

business_city

string

City (for businesses)

business_state

string

State/region (for businesses)

business_legal_entity_identifier

string

Legal Entity Identifier (for businesses)

CreateCounterpartyResponseDto

object · required

CounterpartyListResponse

object[] · required

object · required

CounterpartyResponseDto

object · required

CreateCounterpartyRequestDto

classification

string · enum · required

Classification: 'individual' or 'business'.

Enum values:

individual

business

tenant_id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…

ID of the tenant entity (optional).

individual_first_name

string · maxLength: 255

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

individual_last_name

string · maxLength: 255

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

individual_address_country

string · minLength: 2 · maxLength: 3 · pattern: ^[A-Za-z]{2,3}$

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

individual_date_of_birth

string · maxLength: 255

Date of birth (for individuals).

individual_national_identification_number

string · maxLength: 255

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

individual_street_address1

string · maxLength: 255

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

individual_street_address2

string · maxLength: 255

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

individual_city

string · maxLength: 255

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

individual_state

string · maxLength: 255

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

individual_postal_code

string · maxLength: 255

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

business_legal_name

string · maxLength: 255

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

business_dba

string · maxLength: 255

Doing Business As name (optional).

business_address_country

string · minLength: 2 · maxLength: 3 · pattern: ^[A-Za-z]{2,3}$

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

business_street_address1

string · maxLength: 255

Street address line 1 (for businesses).

business_street_address2

string · maxLength: 255

Street address line 2 (for businesses).

business_city

string · maxLength: 255

City (for businesses).

business_state

string · maxLength: 255

State/region (for businesses).

business_legal_entity_identifier

string · maxLength: 255

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

TenantData

id

string · required

Unique identifier for the tenant

workspace_id

string · required

Workspace ID the tenant belongs to

name

string · required

Display name derived from business fields

created_at

string · required

Creation timestamp in ISO 8601 format

updated_at

string · required

Last update timestamp in ISO 8601 format

business_legal_name

string

Legal business name

business_dba

string

DBA - Doing Business As

business_address_country

string

Country code in ISO 3166-1 format

webhook_url

string

Webhook URL for payment creation notifications

business_street_address1

string

Street address line 1

business_street_address2

string

Street address line 2

business_city

string

City

business_state

string

State/region

business_postal_code

string

Postal code

business_legal_entity_identifier

string

Legal Entity Identifier

CreateTenantData

object · required

CreateTenantResponseDto

object · required

TenantListResponse

object[] · required

object · required

TenantResponseDto

object · required

CreateTenantRequestDto

business_legal_name

string · minLength: 1 · maxLength: 255 · required

Legal business name (required)

business_dba

string · maxLength: 255

DBA - Doing Business As name

business_address_country

string · minLength: 2 · maxLength: 3 · pattern: ^[A-Za-z]{2,3}$

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

webhook_url

string · uri

Webhook URL for payment creation notifications

business_street_address1

string · maxLength: 255

Street address line 1

business_street_address2

string · maxLength: 255

Street address line 2

business_city

string · maxLength: 255

City

business_state

string · maxLength: 255

State/region

business_postal_code

string · maxLength: 50

Postal code

business_legal_entity_identifier

string · maxLength: 255

Legal Entity Identifier

CreateApiKeyRequestDto

name

string · minLength: 1 · maxLength: 100 · required

description

string · maxLength: 500

CreateApiKeyResponseDto

message

string · required

object · required

ListApiKeysResponseDto

message

string · required

object[] · required

ApiKeyDto

id

string · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required

name

string · required

description

string · required

maskedClientId

string · required

status

string · enum · required

Enum values:

active

revoked

lastUsedAt

string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

createdAt

string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

updatedAt

string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

RevokeApiKeyResponseDto

message

string · required

object · required

DeleteApiKeyResponseDto

message

string · required

ListOrgUsersResponseDto

message

string · required

object[] · required

OrgUserDto

id

string · required

email

string · required

firstName

string · required

lastName

string · required

role

string · enum · required

Enum values:

owner

admin

operator

compliance

viewer

status

string · enum · required

Enum values:

active

pending

inactive

lastActiveAt

string · required

createdAt

string · required

updatedAt

string · required

CreateUserRequestDto

email

string · email · pattern: ^(?!\.)(?!.*\.\.)([A… · required

firstName

string · minLength: 1 · maxLength: 100 · required

lastName

string · minLength: 1 · maxLength: 100 · required

role

string · enum

Enum values:

owner

admin

operator

compliance

viewer

Default: viewer

CreateUserResponseDto

message

string · required

object · required

UpdateUserRequestDto

firstName

string · minLength: 1 · maxLength: 100

lastName

string · minLength: 1 · maxLength: 100

role

string · enum

Enum values:

owner

admin

operator

compliance

viewer

status

string · enum

Enum values:

active

pending

inactive

UpdateUserResponseDto

message

string · required

object · required

UpdateRiskProfileRequest

riskProfile

string · enum · required

The risk profile for compliance screening

Enum values:

conservative

balanced

aggressive

UpdateRiskProfileResponse

riskProfile

string · enum · required

New risk profile

Enum values:

conservative

balanced

aggressive

oldRiskProfile

string · enum · required

Previous risk profile

Enum values:

conservative

balanced

aggressive

updatedAt

string · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

Timestamp of the update

RiskProfileResponse

riskProfile

string · enum · required

Current risk profile

Enum values:

conservative

balanced

aggressive

CreateSecretRequest

provider

string · enum · required

The secret provider (currently only CIRCLE_MINT supported)

Enum values:

CIRCLE_MINT

key

string · enum · required

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

Enum values:

CIRCLE_MINT_API_KEY

value

string · minLength: 1 · required

The secret value to store securely

CreateSecretResponse

success

boolean · required

Whether the secret was stored successfully

maskedValue

string · required

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

entityName

string · minLength: 1 · maxLength: 100 · required

email

string · email · pattern: ^(?!\.)(?!.*\.\.)([A… · required

message

string · required

object · required

UserProfileDto

id

string · required

email

string · required

teamId

string · required

createdAt

string · required

updatedAt

string · required

TeamDto

id

string · required

name

string · required

createdAt

string · required

updatedAt

string · required

turnkeySubOrgId

string

UserProfileDataDto

object · required

UserProfileResponseDto

message

string · required

object · required

PaymentFee

fee_amount

string · required

Fee amount in smallest currency units

fee_currency

string · required

Currency code for the fee

fee_type

string · required

Type of fee (e.g., 'gas', 'service')

object

Additional metadata about the fee

PaymentStep

id

string · required

Unique step identifier

transfer_id

string · required

ID of the parent payment/transfer

step_sequence

integer · required

Order of this step in the payment flow

step_type

string · enum · required

Type of step

Enum values:

transfer

swap

from_amount

string · required

Amount being sent from source

from_currency

string · required

Source currency code

to_amount

string · required

Amount being received at destination

to_currency

string · required

Destination currency code

status

string · enum · required

Current status of this step

Enum values:

created

submitted

confirmed

finalized

completed

failed

created_at

string · date-time · required

Step creation timestamp

updated_at

string · date-time · required

Step last update timestamp

from_account_id

string

Source account ID for this step

from_network

string

Source blockchain network

to_account_id

string

Destination account ID for this step

to_network

string

Destination blockchain network

transaction_hash

string

Blockchain transaction hash

object[]

Fees associated with this step

provider_key

string · enum

Provider used for this step

Enum values:

alfred

circle_mint

status_reasons

string[]

Reasons for the current status

submitted_at

string · date-time

Timestamp when step was submitted

confirmed_at

string · date-time

Timestamp when step was confirmed

finalized_at

string · date-time

Timestamp when step was finalized

completed_at

string · date-time

Timestamp when step was completed

failed_at

string · date-time

Timestamp when step failed

Payment

id

string · required

Unique payment identifier

workspace_id

string · required

Workspace ID the payment belongs to

direction

string · enum · required

Payment direction

Enum values:

inbound

outbound

rebalance

from_amount

string · required

Amount in source currency

from_currency

string · required

Source currency code

to_amount

string · required

Amount in destination currency

to_currency

string · required

Destination currency code

risk_status

string · enum · required

Risk assessment status

Enum values:

unchecked

awaiting_decision

auto_approved

manually_approved

auto_rejected

manually_rejected

created_at

string · date-time · required

Payment creation timestamp

updated_at

string · date-time · required

Payment last update timestamp

expires_at

string · date-time · required

Payment expiration timestamp

organization_reference_id

string

External reference ID for tracking

funding_account_id

string

Funding account ID

from_account_id

string

Source account ID

from_network

string

Source blockchain network

to_account_id

string

Destination account ID

to_network

string

Destination blockchain network

risk_status_reasons

string[]

Reasons for risk status

risk_reviewed_by

string

User ID who reviewed the risk

risk_reviewed_at

string · date-time

Timestamp when risk was reviewed

balance_status

string · enum

Balance reservation status

Enum values:

unreserved

reserved

awaiting_funds

balance_reserved_at

string · date-time

Timestamp when balance was reserved

object[]

Payment execution steps

PaymentListResponse

object[] · required

object · required

PaymentResponse

object · required

Payment data

ReviewPaymentRequest

is_approved

boolean · required

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

CreatePaymentRequest

from_currency

string · minLength: 1 · required

Source currency code (e.g., 'USDC'). See GET /currencies for supported values.

to_currency

string · minLength: 1 · required

Destination currency code (e.g., 'USD'). See GET /currencies for supported values.

organization_reference_id

string

Optional external reference ID for the organization.

funding_account_id

string

ID of the funding account.

from_account_id

string

ID of the source account (e.g., wallet).

from_amount

string

Amount to send in source currency units. Required if to_amount is not provided.

from_network

string · minLength: 1

Blockchain network for source currency (e.g., 'POLYGON'). See GET /networks for supported values.

to_account_id

string

ID of the destination account.

to_amount

string

Amount to receive in destination currency units. Required if from_amount is not provided.

to_network

string · minLength: 1

Blockchain network for destination currency (if applicable). See GET /networks for supported values.

UpdatePaymentRequest

funding_account_id

string · required

ID of the funding account.

from_account_id

string · required

ID of the source account (e.g., wallet).

to_account_id

string · required

ID of the destination account.

organization_reference_id

string

Optional external reference ID to update.

SignPaymentStepRequest

signature

string · required

The signed transaction or message.

CreateWithdrawalRequest

from_currency

string · required

Source currency code.

to_currency

string · required

Destination currency code.

from_amount

string · required

Amount to send.

from_account_id

string · required

Source account ID.

to_account_id

string · required

Destination account ID.

from_network

string

Network for the withdrawal.

to_network

string

Network for the destination.

CurrencyBalanceDto

currency

string · required

Currency symbol

available

string · required

Available balance from managed accounts (sum across all networks)

pendingReview

string · required

Total payment amount pending review

rejected

string · required

Total payment amount rejected

TreasuryBalancesDataDto

object[] · required

TreasuryBalancesResponseDto

message

string · required

object · 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').

object

Additional metadata for the fee (JSON object).

DepositStep

id

string · required

Unique identifier for the step.

transfer_id

string · required

ID of the parent payment/transfer.

step_sequence

number · required

Step sequence number (0-based or 1-based).

step_type

string · enum · required

Step type: 'transfer', 'swap'.

Enum values:

transfer

swap

from_amount

string · required

Amount sent in this step.

from_currency

string · required

Currency code sent in this step.

to_amount

string · required

Amount received in this step.

to_currency

string · required

Currency code received in this step.

object[] · required

List of fees associated with this step.

status

string · enum · required

Step status: 'created', 'submitted', 'confirmed', 'finalized', 'failed'.

Enum values:

created

submitted

confirmed

finalized

completed

failed

created_at

string · required

ISO 8601 timestamp of creation.

updated_at

string · required

ISO 8601 timestamp of last update.

from_account_id

string

Source account ID for this step.

from_network

string

Source network for this step.

to_account_id

string

Destination account ID for this step.

to_network

string

Destination network for this step.

transaction_hash

string

Blockchain transaction hash (for crypto steps).

provider_key

string · enum

Provider key used for this step (if applicable).

Enum values:

alfred

circle_mint

status_reasons

string[]

Array of reasons explaining the current status (if any).

submitted_at

string

Submitted timestamp.

confirmed_at

string

Confirmed timestamp.

finalized_at

string

Finalized timestamp.

completed_at

string

Completed timestamp.

failed_at

string

Failed timestamp.

Deposit

id

string · required

Unique identifier for the payment.

workspace_id

string · required

Workspace ID the payment belongs to.

direction

string · enum · required

Payment direction: 'inbound', 'outbound', 'rebalance'.

Enum values:

inbound

outbound

rebalance

from_account_id

string · required

ID of the source account (paying wallet).

from_amount

string · required

Amount to send.

from_currency

string · required

Source currency code.

to_account_id

string · required

ID of the destination account.

to_amount

string · required

Amount to receive.

to_currency

string · required

Destination currency code.

created_at

string · required

ISO 8601 timestamp of creation.

updated_at

string · required

ISO 8601 timestamp of last update.

organization_reference_id

string

Optional external reference ID.

funding_account_id

string

ID of the funding account.

from_network

string

Source blockchain network.

to_network

string

Destination blockchain network.

object[]

Optional list of system-generated steps that make up this payment/transfer route.

expires_at

string

ISO 8601 timestamp when the deposit expires, or null for auto-created deposits.

CreateDepositResponse

object · required

DepositBankAccount

id

string · required

Account ID.

name

string · required

Account name.

bank_name

string · required

Bank name.

bank_account_number

string · required

Bank account number.

bank_code_type

string · required

Bank code type (e.g., 'routing').

bank_identifier_code

string · required

Bank identifier code (routing number, sort code, etc.).

bank_swift_code

string

Bank SWIFT code.

BeneficiaryBusinessInfo

business_legal_name

string · required

Business legal name.

business_city

string · required

City.

business_state

string · required

State.

business_postal_code

string · required

Postal code.

business_country

string · required

Country code.

business_street_address1

string

Street address line 1.

business_street_address2

string

Street address line 2.

WireInstructionsBankAccount

id

string · required

Account ID.

name

string · required

Account name.

bank_name

string · required

Bank name.

bank_account_number

string · required

Bank account number (VAN).

bank_code_type

string · required

Bank code type (e.g., ROUTING).

bank_identifier_code

string · required

Bank identifier code (routing number).

bank_swift_code

string · required

Bank SWIFT code.

object · required

Beneficiary business info (legal entity receiving the wire).

tracking_reference

string

Wire transfer tracking reference.

DepositInstructionsData

object · required

Source account information (for reference).

object · required

Wire instructions for completing the deposit.

amount

string · required

Deposit amount.

currency

string · required

Deposit currency.

DepositInstructionsResponse

object · required

ListDepositsResponse

object[] · required

object · required

CreateDepositRequest

from_currency

string · required

Source currency code.

to_currency

string · required

Destination currency code.

from_amount

string · required

Amount to send.

to_account_id

string · required

Destination account ID.

from_account_id

string

Source account ID. Optional for Circle deposits (uses ledger's configured source bank).

from_network

string

Network for the source.

to_network

string

Network for the deposit.

RebalanceStep

id

string · required

Unique step identifier

transfer_id

string · required

ID of the parent rebalance

step_sequence

integer · required

Order of this step in the rebalance flow

step_type

string · enum · required

Type of step

Enum values:

transfer

swap

from_amount

string · required

Amount being sent from source

from_currency

string · required

Source currency code

to_amount

string · required

Amount being received at destination

to_currency

string · required

Destination currency code

status

string · enum · required

Current status of this step

Enum values:

created

submitted

confirmed

finalized

failed

created_at

string · date-time · required

Step creation timestamp

updated_at

string · date-time · required

Step last update timestamp

from_account_id

string

Source account ID for this step

from_network

string

Source blockchain network

to_account_id

string

Destination account ID for this step

to_network

string

Destination blockchain network

transaction_hash

string

Blockchain transaction hash

object[]

Fees associated with this step

provider_key

string · enum

Provider used for this step

Enum values:

alfred

circle_mint

status_reasons

string[]

Reasons for the current status

submitted_at

string · date-time

Timestamp when step was submitted

confirmed_at

string · date-time

Timestamp when step was confirmed

finalized_at

string · date-time

Timestamp when step was finalized

failed_at

string · date-time

Timestamp when step failed

Rebalance

id

string · required

Unique rebalance identifier

workspace_id

string · required

Workspace ID the rebalance belongs to

direction

string · enum · required

Payment direction

Enum values:

rebalance

from_account_id

string · required

Source account ID

from_amount

string · required

Amount in source currency

from_currency

string · required

Source currency code

to_account_id

string · required

Destination account ID

to_amount

string · required

Amount in destination currency

to_currency

string · required

Destination currency code

created_at

string · date-time · required

Rebalance creation timestamp

updated_at

string · date-time · required

Rebalance last update timestamp

expires_at

string · date-time · required

Rebalance expiration timestamp

organization_reference_id

string

External reference ID for tracking

from_network

string

Source blockchain network

to_network

string

Destination blockchain network

balance_status

string · enum

Balance reservation status

Enum values:

unreserved

awaiting_funds

reserved

balance_reserved_at

string · date-time

Timestamp when balance was reserved

object[]

Rebalance execution steps

RebalanceResponse

object · required

Rebalance data

ListRebalancesResponse

object[] · required

object · required

CreateRebalanceRequest

from_account_id

string · required

Source account ID.

from_currency

string · required

Source currency code.

to_account_id

string · required

Destination account ID.

to_currency

string · required

Destination currency code.

organization_reference_id

string

Optional reference ID for the rebalance.

from_amount

string

Amount to send from the source account.

from_network

string

Network for the source account.

to_amount

string

Amount to receive at the destination account.

to_network

string

Network for the destination account.

Schemas(v1)

BankAccountData

CreateBankAccountResponseDto

LedgerAssetDto

LedgerAccountData

CreateLedgerAccountResponseDto

WalletAssetDto

WalletAccountData

CreateWalletAccountResponseDto

AccountAssetDto

AccountData

Pagination

AccountListResponse

AccountResponseDto

UpdateAccountResponseDto

CreateBankAccountRequestDto

CreateWalletAccountRequestDto

CreateLedgerAccountRequestDto

UpdateAccountRequestDto

CreateInvitationRequestDto

Currency

CurrenciesResponse

Network

NetworksResponse

CounterpartyData

CreateCounterpartyResponseDto

CounterpartyListResponse

CounterpartyResponseDto

CreateCounterpartyRequestDto

TenantData

CreateTenantData

CreateTenantResponseDto

TenantListResponse

TenantResponseDto

CreateTenantRequestDto

CreateApiKeyRequestDto

CreateApiKeyResponseDto

ListApiKeysResponseDto

ApiKeyDto

RevokeApiKeyResponseDto

DeleteApiKeyResponseDto

ListOrgUsersResponseDto

OrgUserDto

CreateUserRequestDto

CreateUserResponseDto

UpdateUserRequestDto

UpdateUserResponseDto

UpdateRiskProfileRequest

UpdateRiskProfileResponse

RiskProfileResponse

CreateSecretRequest

CreateSecretResponse

SignupRequestDto

SignupResponseDto

UserProfileDto

TeamDto

UserProfileDataDto

UserProfileResponseDto

PaymentFee

PaymentStep

Payment

PaymentListResponse

PaymentResponse

ReviewPaymentRequest

CreatePaymentRequest

UpdatePaymentRequest

SignPaymentStepRequest

CreateWithdrawalRequest

CurrencyBalanceDto

TreasuryBalancesDataDto

TreasuryBalancesResponseDto

StepFee

DepositStep

Deposit

CreateDepositResponse

DepositBankAccount

BeneficiaryBusinessInfo

WireInstructionsBankAccount

DepositInstructionsData

DepositInstructionsResponse