BankAccountData
idUnique identifier for the account
workspace_idWorkspace ID the account belongs to
typeAccount type
nameAccount name
created_atCreation timestamp
updated_atLast update timestamp
bank_nameName of the financial institution
bank_code_typeType of bank code (e.g., SWIFT, BIC, IBAN, ROUTING, SORT_CODE)
bank_identifier_codeBank identifier code value
tenant_idTenant ID (if account belongs to a tenant)
counterparty_idCounterparty ID (if account belongs to a counterparty)
bank_account_numberBank account number (masked, only with include_secure=true)
LedgerAssetDto
currencyCurrency symbol
available_balanceAvailable balance in smallest unit
LedgerAccountData
idUnique identifier for the account
workspace_idWorkspace ID the account belongs to
typeAccount type
nameAccount name
created_atCreation timestamp
updated_atLast update timestamp
providerLiquidity provider that manages this ledger account
tenant_idTenant ID (if account belongs to a tenant)
counterparty_idCounterparty ID (if account belongs to a counterparty)
Ledger assets with balances
WalletAssetDto
currencyCurrency symbol
networkBlockchain network
available_balanceAvailable balance in smallest unit
WalletAccountData
idUnique identifier for the account
workspace_idWorkspace ID the account belongs to
typeAccount type
nameAccount name
created_atCreation timestamp
updated_atLast update timestamp
crypto_wallet_addressBlockchain wallet address
is_managedWhether this is a managed wallet (provisioned by Tesser), or unmanaged (not provisioned by Tesser)
tenant_idTenant ID (if account belongs to a tenant)
counterparty_idCounterparty ID (if account belongs to a counterparty)
Wallet assets with balances
AccountAssetDto
currencyCurrency symbol
available_balanceAvailable balance in smallest unit
networkBlockchain network (only for wallet accounts)
AccountData
idUnique identifier for the account
workspace_idWorkspace ID the account belongs to
typeAccount type
nameAccount name
created_atCreation timestamp
updated_atLast update timestamp
tenant_idTenant ID (if account belongs to a tenant)
counterparty_idCounterparty ID (if account belongs to a counterparty)
bank_nameBank name (only for fiat_bank accounts)
bank_code_typeBank code type (only for fiat_bank accounts)
bank_identifier_codeBank identifier code (only for fiat_bank accounts)
bank_account_numberBank account number (masked, only with include_secure=true)
crypto_wallet_addressCrypto wallet address (only for wallet accounts)
is_managedIs managed wallet (only for wallet accounts)
providerLedger provider (only for ledger accounts)
Account assets with balances (for wallet and ledger accounts)
PaginationMeta
pageCurrent page number
limitItems per page
totalTotal number of items
total_pagesTotal number of pages
has_nextHas next page
has_prevHas previous page
CreateBankAccountRequestDto
nameHuman-readable name for the bank account
bank_nameName of the financial institution
bank_code_typeType of bank code (e.g., SWIFT, BIC, IBAN, ROUTING, SORT_CODE)
bank_identifier_codeBank identifier code value
bank_account_numberBank account number. SECURE FIELD: Encrypted and stored in vault, never returned in responses. Required in API request.
tenant_id^([0-9a-fA-F]{8}-[0-…Tenant ID (mutually exclusive with counterparty_id). Links this account to a specific tenant.
counterparty_id^([0-9a-fA-F]{8}-[0-…Counterparty ID (mutually exclusive with tenant_id). Links this account to a specific counterparty.
CreateWalletAccountRequestDto
nameHuman-readable name for the wallet account
typeStablecoin network type. Determines which blockchain network the wallet operates on.
tenant_id^([0-9a-fA-F]{8}-[0-…Tenant ID (mutually exclusive with counterparty_id). Links this wallet to a specific tenant.
counterparty_id^([0-9a-fA-F]{8}-[0-…Counterparty ID (mutually exclusive with tenant_id). Links this wallet to a specific counterparty.
signatureA 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_managedWhether 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.
wallet_addressBlockchain wallet address. Required for unmanaged wallets (is_managed=false). Auto-generated for managed wallets.
CreateLedgerAccountRequestDto
nameHuman-readable name for the ledger account
providerLiquidity provider that manages this ledger account. CIRCLE_MINT for Circle Mint accounts, KRAKEN for Kraken exchange accounts.
tenant_id^([0-9a-fA-F]{8}-[0-…Tenant ID (mutually exclusive with counterparty_id). Links this ledger account to a specific tenant.
counterparty_id^([0-9a-fA-F]{8}-[0-…Counterparty ID (mutually exclusive with tenant_id). Links this ledger account to a specific counterparty.
Currency
nameDisplay name for the currency (e.g., 'Circle USD')
keyCurrency code/key (e.g., 'USDC', 'USD')
decimalsNumber of decimal places for the currency
networkBlockchain network (e.g., 'POLYGON') or null for fiat currencies. See GET /networks for supported values.
Network
keyNetwork key/identifier (e.g., 'POLYGON', 'POLYGON_AMOY')
nameDisplay name for the network (e.g., 'Polygon')
CounterpartyData
idUnique identifier for the counterparty
workspace_idWorkspace ID the counterparty belongs to
classificationClassification: individual (person) or business (company)
created_atCreation timestamp in ISO 8601 format
updated_atLast update timestamp in ISO 8601 format
tenant_idOptional reference to a tenant entity this counterparty belongs to
individual_first_nameFirst name (for individuals)
individual_last_nameLast name (for individuals)
individual_address_countryCountry code in ISO 3166-1 format (for individuals)
individual_date_of_birthDate of birth (for individuals)
individual_national_identification_numberNational identification number (for individuals)
individual_street_address1Street address line 1 (for individuals)
individual_street_address2Street address line 2 (for individuals)
individual_cityCity (for individuals)
individual_stateState/region (for individuals)
individual_postal_codePostal code (for individuals)
business_legal_nameLegal business name (for businesses)
business_dbaDBA - Doing Business As (for businesses)
business_address_countryCountry code in ISO 3166-1 format (for businesses)
business_street_address1Street address line 1 (for businesses)
business_street_address2Street address line 2 (for businesses)
business_cityCity (for businesses)
business_stateState/region (for businesses)
business_legal_entity_identifierLegal Entity Identifier (for businesses)
PaginationInfoData
pageCurrent page number
limitNumber of items per page
totalTotal number of items
total_pagesTotal number of pages
has_nextWhether there is a next page
has_prevWhether there is a previous page
CounterpartyListResponseDto
Pagination info (only present when page/limit are provided)
CreateCounterpartyRequestDto
classificationClassification: 'individual' or 'business'.
tenant_id^([0-9a-fA-F]{8}-[0-…ID of the tenant entity (optional).
individual_first_nameFirst name (required if classification is 'individual'). Secure field, returned based on include_secure.
individual_last_nameLast name (required if classification is 'individual'). Secure field, returned based on include_secure.
individual_address_country^[A-Za-z]{2,3}$ISO 3166-1 alpha-2 or alpha-3 country code.
individual_date_of_birthDate of birth (for individuals).
individual_national_identification_numberNational identification number (for individuals). Secure field, returned based on include_secure.
individual_street_address1Street address line 1 (for individuals). Secure field, returned based on include_secure.
individual_street_address2Street address line 2 (for individuals). Secure field, returned based on include_secure.
individual_cityCity (for individuals). Secure field, returned based on include_secure.
individual_stateState/region (for individuals). Secure field, returned based on include_secure.
individual_postal_codePostal code (for individuals). Secure field, returned based on include_secure.
business_legal_nameLegal business name (required if classification is 'business').
business_dbaDoing Business As name (optional).
business_address_country^[A-Za-z]{2,3}$ISO 3166-1 alpha-2 or alpha-3 country code.
business_street_address1Street address line 1 (for businesses).
business_street_address2Street address line 2 (for businesses).
business_cityCity (for businesses).
business_stateState/region (for businesses).
business_legal_entity_identifierLegal Entity Identifier (for businesses). Secure field, returned based on include_secure.
TenantData
idUnique identifier for the tenant
workspace_idWorkspace ID the tenant belongs to
nameDisplay name derived from business fields
created_atCreation timestamp in ISO 8601 format
updated_atLast update timestamp in ISO 8601 format
business_legal_nameLegal business name
business_dbaDBA - Doing Business As
business_address_countryCountry code in ISO 3166-1 format
webhook_urlWebhook URL for payment creation notifications
business_street_address1Street address line 1
business_street_address2Street address line 2
business_cityCity
business_stateState/region
business_postal_codePostal code
business_legal_entity_identifierLegal Entity Identifier
TenantPaginationInfo
pageCurrent page number
limitNumber of items per page
totalTotal number of items
total_pagesTotal number of pages
has_nextWhether there is a next page
has_prevWhether there is a previous page
TenantListResponseDto
Pagination info (only present when limit is specified)
CreateTenantRequestDto
business_legal_nameLegal business name (required)
business_dbaDBA - Doing Business As name
business_address_country^[A-Za-z]{2,3}$Country code in ISO 3166-1 alpha-2 or alpha-3 format
webhook_urlWebhook URL for payment creation notifications
business_street_address1Street address line 1
business_street_address2Street address line 2
business_cityCity
business_stateState/region
business_postal_codePostal code
business_legal_entity_identifierLegal Entity Identifier
CreateApiKeyRequestDto
namedescriptionApiKeyDto
id^([0-9a-fA-F]{8}-[0-… · requirednamedescriptionmaskedClientIdstatuslastUsedAt^(?:(?:\d\d[2468][04… · requiredcreatedAt^(?:(?:\d\d[2468][04… · requiredupdatedAt^(?:(?:\d\d[2468][04… · requiredSignupRequestDto
entityNameemail^(?!\.)(?!.*\.\.)([A… · requiredUserProfileDto
idemailteamIdcreatedAtupdatedAtTeamDto
idnamecreatedAtupdatedAtturnkeySubOrgIdReviewer
idReviewer user ID
emailReviewer email address
first_nameReviewer first name
last_nameReviewer last name
Payment__schema0
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = string | |
| type = number | |
| type = boolean | |
| type = array | |
| type = object |
Payment
idUnique identifier for the payment.
workspace_idWorkspace ID the payment belongs to.
directionPayment direction: 'inbound', 'outbound', 'internal'.
from_amountAmount to send.
from_currencySource currency code.
to_amountAmount to receive.
to_currencyDestination currency code.
risk_statusCurrent risk status.
created_at^(?:(?:\d\d[2468][04… · requiredISO 8601 timestamp of creation.
updated_at^(?:(?:\d\d[2468][04… · requiredISO 8601 timestamp of last update.
expires_at^(?:(?:\d\d[2468][04… · requiredISO 8601 timestamp when the quote expires.
organization_reference_idOptional external reference ID.
funding_account_idID of the funding account.
from_account_idID of the source account (paying wallet).
from_networkSource blockchain network.
to_account_idID of the destination account.
to_networkDestination blockchain network.
risk_status_reasonsList of reasons for risk status.
risk_reviewed_byID of the user who performed the risk review.
risk_reviewed_at^(?:(?:\d\d[2468][04…Timestamp of risk review.
balance_statusBalance reservation status.
balance_reserved_at^(?:(?:\d\d[2468][04…Timestamp when balance was reserved.
Optional list of system-generated steps that make up this payment/transfer route.
PaymentFee
fee_amountFee amount in smallest currency units
fee_currencyCurrency code for the fee
fee_typeType of fee (e.g., 'gas', 'service')
Additional metadata about the fee
PaymentStep
idUnique step identifier
transfer_idID of the parent payment/transfer
step_sequenceOrder of this step in the payment flow
step_typeType of step
from_amountAmount being sent from source
from_currencySource currency code
to_amountAmount being received at destination
to_currencyDestination currency code
Fees associated with this step
statusCurrent status of this step
status_reasonsReasons for the current status
created_atStep creation timestamp
updated_atStep last update timestamp
from_account_idSource account ID for this step
from_networkSource blockchain network
to_account_idDestination account ID for this step
to_networkDestination blockchain network
transaction_hashBlockchain transaction hash
provider_keyProvider used for this step
submitted_atTimestamp when step was submitted
confirmed_atTimestamp when step was confirmed
finalized_atTimestamp when step was finalized
failed_atTimestamp when step failed
PaymentResponseData
idUnique payment identifier
workspace_idWorkspace ID the payment belongs to
directionPayment direction
from_amountAmount in source currency
from_currencySource currency code
to_amountAmount in destination currency
to_currencyDestination currency code
risk_statusRisk assessment status
risk_status_reasonsReasons for risk status
Payment execution steps
created_atPayment creation timestamp
updated_atPayment last update timestamp
expires_atPayment expiration timestamp
organization_reference_idExternal reference ID for tracking
funding_account_idFunding account ID
from_account_idSource account ID
from_networkSource blockchain network
to_account_idDestination account ID
to_networkDestination blockchain network
risk_reviewed_byUser ID who reviewed the risk
risk_reviewed_atTimestamp when risk was reviewed
balance_statusBalance reservation status
balance_reserved_atTimestamp when balance was reserved
CreatePaymentRequest
from_currencySource currency code (e.g., 'USDC'). See GET /currencies for supported values.
to_currencyDestination currency code (e.g., 'USD'). See GET /currencies for supported values.
organization_reference_idOptional external reference ID for the organization.
funding_account_idID of the funding account.
from_account_idID of the source account (e.g., wallet).
from_amountAmount to send in source currency units. Required if to_amount is not provided.
from_networkBlockchain network for source currency (e.g., 'POLYGON'). See GET /networks for supported values.
to_account_idID of the destination account.
to_amountAmount to receive in destination currency units. Required if from_amount is not provided.
to_networkBlockchain network for destination currency (if applicable). See GET /networks for supported values.
UpdatePaymentRequest
funding_account_idID of the funding account.
from_account_idID of the source account (e.g., wallet).
to_account_idID of the destination account.
organization_reference_idOptional external reference ID to update.
Fee__schema0
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = string | |
| type = number | |
| type = boolean | |
| type = array | |
| type = object |
Fee
fee_amountFee amount.
fee_currencyFee currency code.
fee_typeFee type (e.g., 'gas', 'provider').
Additional metadata for the fee.
TransferStep__schema0
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = string | |
| type = number | |
| type = boolean | |
| type = array | |
| type = object |
TransferStep
idUnique identifier for the step.
transfer_idID of the parent payment/transfer.
step_sequenceStep sequence number (0-based or 1-based).
step_typeStep type: 'transfer', 'swap'.
from_amountAmount sent in this step.
from_currencyCurrency code sent in this step.
to_amountAmount received in this step.
to_currencyCurrency code received in this step.
statusStep status: 'created', 'submitted', 'confirmed', 'finalized', 'failed'.
created_at^(?:(?:\d\d[2468][04… · requiredISO 8601 timestamp of creation.
updated_at^(?:(?:\d\d[2468][04… · requiredISO 8601 timestamp of last update.
from_account_idSource account ID for this step.
from_networkSource network for this step.
to_account_idDestination account ID for this step.
to_networkDestination network for this step.
transaction_hashBlockchain transaction hash (for crypto steps).
List of fees associated with this step.
provider_keyProvider key used for this step (if applicable).
status_reasonsArray of reasons explaining the current status (if any).
submitted_at^(?:(?:\d\d[2468][04…Submitted timestamp.
confirmed_at^(?:(?:\d\d[2468][04…Confirmed timestamp.
finalized_at^(?:(?:\d\d[2468][04…Finalized timestamp.
completed_at^(?:(?:\d\d[2468][04…Completed timestamp.
failed_at^(?:(?:\d\d[2468][04…Failed timestamp.
CreateDepositRequest
from_currencySource currency code.
to_currencyDestination currency code.
from_amountAmount to send.
to_account_idDestination account ID.
from_account_idSource account ID. Required for Circle deposits.
from_networkNetwork for the source.
to_networkNetwork for the deposit.
CreateWithdrawalRequest
from_currencySource currency code.
to_currencyDestination currency code.
from_amountAmount to send.
from_account_idSource account ID.
to_account_idDestination account ID.
from_networkNetwork for the withdrawal.
to_networkNetwork for the destination.
CurrencyBalanceDto
currencyCurrency symbol
availableAvailable balance from managed accounts (sum across all networks)
pendingReviewTotal payment amount pending review
rejectedTotal payment amount rejected
OrgUserDto
idemailfirstNamelastNamerolestatuslastActiveAtcreatedAtupdatedAtCreateUserRequestDto
email^(?!\.)(?!.*\.\.)([A… · requiredfirstNamelastNamerole