Tesser Payments API

Schemas

Payment

idstring · required
Unique payment identifier
idempotency_keystring · required
Idempotency key for the payment
externalIdstring · required
External identifier for the payment
payment_typestring · enum · required
Payment type: 'onchain' for wallet-to-wallet, 'offramp' for crypto-to-fiat
Enum values:
onchain
offramp
toAccountstring · required
Destination account: wallet address for onchain payments, fiat account UUID for offramp payments
toAmountinteger · int64 · required
Amount to be sent to destination in smallest unit (e.g., 1000000 = $1.00 USDC)
fromCurrencystring · required
Source currency code
toCurrencystring · required
Destination currency code
lastStepToCurrencystring · required
Final destination currency code from the last step
createdAtstring · required
Payment creation timestamp
updatedAtstring · required
Payment last updated timestamp
statusstring · enum · required
Payment status based on current state
Enum values:
queued
processing
ready-to-submit
rejected
sent
need-review
compliance-blocked
insufficient-balance
sourceWalletAddressstring · required
Source wallet address
blockchainstring · required
Blockchain network

originatorNamestring
Originator business name
originatorAddressstring
Originator address
originatorCitystring
Originator city
originatorZipCodestring
Originator zip code
originatorStatestring
Originator state
originatorCountrystring
Originator country
riskScorenumber | null
Compliance risk score (0-15, null if not screened)
screenedAtstring | null
Timestamp when compliance screening was performed
numRiskIndicatorsnumber | null
Number of risk indicators found during screening
numTransactionsnumber | null
Number of transactions associated with the address
complianceReviewedByUserIdstring | null
ID of user who performed manual compliance review
complianceReviewedAtstring | null
Timestamp when manual compliance review was performed
complianceIsApprovedboolean | null
Whether payment was approved after manual compliance review
confirmedAtstring | null
Timestamp when transaction was confirmed on blockchain
exchangeRatestring | null
Exchange rate from quote (for offramp payments)
localAmountstring | null
Local fiat amount (for offramp payments)
localCurrencystring | null
Local fiat currency (for offramp payments)
beneficiaryCountrystring | null
Beneficiary country (for offramp payments)
beneficiaryBankNamestring | null
Beneficiary bank name (for offramp payments)
beneficiaryAccountNumberstring | null
Beneficiary account number (for offramp payments)
recipientNamestring
Recipient business name
accountNumberstring
Account number
accountTypestring
Account type
financialInstitutionIdstring
Financial institution ID
accountCountrystring
Account country
bankNamestring
Bank name
txHashstring
Transaction hash
reviewerobject | null
Reviewer user information

PaginationInfo

pagenumber · required
Current page number (1-based)
limitnumber · required
Number of items per page
totalnumber · required
Total number of items
totalPagesnumber · required
Total number of pages
hasNextboolean · required
Whether there is a next page
hasPrevboolean · required
Whether there is a previous page

PaymentListResponse

dataobject[] · required
List of payments

paginationobject
Pagination information

SendPaymentIntentRequest

idempotencyKeystring · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
originatorIdstring · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
fromAccountstring · required
toAccountstring · required
toAmountstring · pattern: ^\d+$ · required
fromCurrencystring · required
toCurrencystring · required

paymentTypestring · enum
Enum values:
onchain
offramp
Default: onchain
externalIdstring

SendPaymentIntentResponse

dataobject · required
Payment details

SendPaymentRequest

signedTransactionstring · required
paymentIdstring · required
externalIdstring · required
fromWalletAddressstring · required
toAccountstring · required
toAmountstring · pattern: ^\d+$ · required
currencystring · required

SendPaymentResponse

datastring · required

ReviewPaymentRequest

isApprovedboolean · required

ReviewPayment

isApprovedboolean · required
Whether the payment is approved after manual review
reviewedAtstring · required
Timestamp when the payment was reviewed
reviewedByUserIdstring · required
User ID of the person who reviewed the payment
reviewedByUserobject · required
User details of the reviewer

ReviewPaymentResponse

messagestring · required
Success message
dataobject · required
Review details

entityNamestring · maxLength: 100 · required
emailstring · email · pattern: ^(?!\.)(?!.*\.\.)([A… · required

dataobject · required

UserProfileResponseDto

messagestring · required
dataobject · required

UpdateRiskProfileRequest

riskProfilestring · enum · required
Enum values:
conservative
balanced
aggressive

UpdateRiskProfileResponse

riskProfilestring · enum · required
Enum values:
conservative
balanced
aggressive
oldRiskProfilestring · enum · required
Enum values:
conservative
balanced
aggressive
updatedAtstring · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

RiskProfileResponse

riskProfilestring · enum · required
Enum values:
conservative
balanced
aggressive

CreateAppDto

namestring · minLength: 1 · maxLength: 100 · required

descriptionstring · maxLength: 500

CreateAppResponseDto

appIdstring · required
clientIdstring · required
clientSecretstring · required
namestring · required
apiKeyIdstring · required

CreateOriginatorRequestDto

businessNamestring · minLength: 1 · required

firstNamestring
lastNamestring
addressstring
citystring
zipCodestring
statestring
countrystring

OriginatorDto

idstring · required
Unique identifier of the originator
Example: 123e4567-e89b-12d3-a456-426614174000
typestring · required
Type of the entity (always 'ORIGINATOR' for originators)
Example: ORIGINATOR
businessNamestring · required
Business name of the originator
Example: Acme Corp
firstNamestring | null · required
First name of the originator
Example: John
lastNamestring | null · required
Last name of the originator
Example: Doe
addressstring | null · required
Address of the originator
Example: 123 Main St
citystring | null · required
City of the originator
Example: New York
zipCodestring | null · required
ZIP code of the originator
Example: 10001
statestring | null · required
State of the originator
Example: NY
countrystring | null · required
Country of the originator
Example: United States
financialInstitutionstring | null · required
Financial institution identifier
Example: 23456P
accountNumberstring | null · required
Account number
Example: 9876543210
teamIdstring · required
Team ID that owns this originator
Example: 123e4567-e89b-12d3-a456-426614174000
isCounterpartyboolean · required
Whether this entity is a counterparty
Example: false
createdAtstring · required
Creation timestamp
Example: 2024-01-01T00:00:00.000Z
updatedAtstring · required
Last update timestamp
Example: 2024-01-01T00:00:00.000Z

CreateOriginatorResponseDto

messagestring · required
Success message
Example: Originator created successfully
dataobject · required
Originator data

OriginatorListResponseDto

dataobject[] · required
List of originators
totalnumber · required
Total count of originators
Example: 10

UpdateOriginatorRequestDto

businessNamestring · minLength: 1
firstNamestring
lastNamestring
addressstring
citystring
zipCodestring
statestring
countrystring

UpdateOriginatorResponseDto

messagestring · required
Success message
Example: Originator updated successfully
dataobject · required
Originator data

WalletDto

idstring · required
namestring · required
addressstring · required
typestring · required
entityIdstring · required
currencystring · required
networkstring · required
availableBalancestring · required
pendingBalancestring · required
createdAtstring · required
updatedAtstring · required

walletIdstring

WalletListResponseDto

messagestring · required
dataobject[] · required

PaymentStatsDto

currencystring · required
Currency code (e.g., USDC, USDT)
Example: USDC
transactionCountnumber · required
Total number of transactions in the period
Example: 15
averageAmountstring · required
Average transaction amount (in smallest unit)
Example: 1500000
totalVolumestring · required
Total transaction volume (in smallest unit)
Example: 22500000
periodHoursnumber · required
Time period in hours for the statistics
Example: 24

PaymentStatsResponseDto

messagestring · required
Success message
Example: Payment statistics retrieved successfully
dataobject[] · required
Payment statistics by currency

EntityData

idstring · required
namestring · required
typestring | null · required
teamIdstring · required
isCounterpartyboolean · required
webhookUrlstring | null · required
createdAtstring · required
updatedAtstring · required

EntityListResponseDto

dataobject[] · required

CreateEntityRequestDto

namestring · minLength: 1 · maxLength: 255 · required

isCounterpartyboolean
Default: true
webhookUrl

CreateEntityResponseDto

dataobject · required

CreateAccountRequestDto

namestring · minLength: 1 · maxLength: 255 · required
addressstring · minLength: 1 · required
typestring · minLength: 1 · required
currencystring · minLength: 1 · required
networkstring · minLength: 1 · required

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

AccountData

idstring · required
namestring · required
addressstring · required
typestring · required
walletIdstring | null · required
entityIdstring · required
currencystring · required
networkstring · required
availableBalancestring · required
pendingBalancestring · required
createdAtstring · required
updatedAtstring · required

CreateAccountResponseDto

accountsobject[] · required
entityIdstring · required

CreateFiatAccountRequestDto

providerstring · enum · required
Enum values:
ALFRED
countrystring · minLength: 2 · maxLength: 2 · required
accountTypestring · enum · required
Enum values:
PIX
SPEI
COELSA
accountNumberstring · minLength: 1 · required
accountDetailsobject · required

entityIdstring · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
isExternalboolean
Default: false

FiatAccountData

idstring · required
teamIdstring · required
entityIdstring | null · required
externalIdstring · required
providerstring · required
providerCustomerIdstring · required
providerFiatAccountIdstring · required
countrystring · required
accountTypestring · required
accountNumberstring · required
accountDetailsobject | null · required
bankNamestring | null · required
isExternalboolean · required
createdAtstring · required
updatedAtstring · required

CreateFiatAccountResponseDto

dataobject · required

OrgUserDto

idstring · required
emailstring · required
firstNamestring · required
lastNamestring · required
rolesstring[] · required
Enum values:
admin
developer
compliance_manager
payments_operator
statusstring · required
lastActiveAtstring · required
createdAtstring · required
updatedAtstring · required

ListOrgUsersResponseDto

dataobject[] · required
messagestring · required

CreateUserRequestDto

emailstring · email · pattern: ^(?!\.)(?!.*\.\.)([A… · required
firstNamestring · minLength: 1 · maxLength: 100 · required
lastNamestring · minLength: 1 · maxLength: 100 · required

rolesstring[] · minItems: 1
Enum values:
admin
developer
compliance_manager
payments_operator
Default: ["developer"]

CreateUserResponseDto

messagestring · required
dataobject · required

UpdateUserRequestDto

firstNamestring · minLength: 1 · maxLength: 100
lastNamestring · minLength: 1 · maxLength: 100
rolesstring[] · minItems: 1
Enum values:
admin
developer
compliance_manager
payments_operator
statusstring · enum
Enum values:
active
pending
inactive

UpdateUserResponseDto

messagestring · required
dataobject · required

Tesser Payments API

Schemas

Payment

idstring · required
Unique payment identifier
idempotency_keystring · required
Idempotency key for the payment
externalIdstring · required
External identifier for the payment
payment_typestring · enum · required
Payment type: 'onchain' for wallet-to-wallet, 'offramp' for crypto-to-fiat
Enum values:
onchain
offramp
toAccountstring · required
Destination account: wallet address for onchain payments, fiat account UUID for offramp payments
toAmountinteger · int64 · required
Amount to be sent to destination in smallest unit (e.g., 1000000 = $1.00 USDC)
fromCurrencystring · required
Source currency code
toCurrencystring · required
Destination currency code
lastStepToCurrencystring · required
Final destination currency code from the last step
createdAtstring · required
Payment creation timestamp
updatedAtstring · required
Payment last updated timestamp
statusstring · enum · required
Payment status based on current state
Enum values:
queued
processing
ready-to-submit
rejected
sent
need-review
compliance-blocked
insufficient-balance
sourceWalletAddressstring · required
Source wallet address
blockchainstring · required
Blockchain network

originatorNamestring
Originator business name
originatorAddressstring
Originator address
originatorCitystring
Originator city
originatorZipCodestring
Originator zip code
originatorStatestring
Originator state
originatorCountrystring
Originator country
riskScorenumber | null
Compliance risk score (0-15, null if not screened)
screenedAtstring | null
Timestamp when compliance screening was performed
numRiskIndicatorsnumber | null
Number of risk indicators found during screening
numTransactionsnumber | null
Number of transactions associated with the address
complianceReviewedByUserIdstring | null
ID of user who performed manual compliance review
complianceReviewedAtstring | null
Timestamp when manual compliance review was performed
complianceIsApprovedboolean | null
Whether payment was approved after manual compliance review
confirmedAtstring | null
Timestamp when transaction was confirmed on blockchain
exchangeRatestring | null
Exchange rate from quote (for offramp payments)
localAmountstring | null
Local fiat amount (for offramp payments)
localCurrencystring | null
Local fiat currency (for offramp payments)
beneficiaryCountrystring | null
Beneficiary country (for offramp payments)
beneficiaryBankNamestring | null
Beneficiary bank name (for offramp payments)
beneficiaryAccountNumberstring | null
Beneficiary account number (for offramp payments)
recipientNamestring
Recipient business name
accountNumberstring
Account number
accountTypestring
Account type
financialInstitutionIdstring
Financial institution ID
accountCountrystring
Account country
bankNamestring
Bank name
txHashstring
Transaction hash
reviewerobject | null
Reviewer user information

PaginationInfo

pagenumber · required
Current page number (1-based)
limitnumber · required
Number of items per page
totalnumber · required
Total number of items
totalPagesnumber · required
Total number of pages
hasNextboolean · required
Whether there is a next page
hasPrevboolean · required
Whether there is a previous page

PaymentListResponse

dataobject[] · required
List of payments

paginationobject
Pagination information

SendPaymentIntentRequest

idempotencyKeystring · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
originatorIdstring · uuid · pattern: ^([0-9a-fA-F]{8}-[0-… · required
fromAccountstring · required
toAccountstring · required
toAmountstring · pattern: ^\d+$ · required
fromCurrencystring · required
toCurrencystring · required

paymentTypestring · enum
Enum values:
onchain
offramp
Default: onchain
externalIdstring

SendPaymentIntentResponse

dataobject · required
Payment details

SendPaymentRequest

signedTransactionstring · required
paymentIdstring · required
externalIdstring · required
fromWalletAddressstring · required
toAccountstring · required
toAmountstring · pattern: ^\d+$ · required
currencystring · required

SendPaymentResponse

datastring · required

ReviewPaymentRequest

isApprovedboolean · required

ReviewPayment

isApprovedboolean · required
Whether the payment is approved after manual review
reviewedAtstring · required
Timestamp when the payment was reviewed
reviewedByUserIdstring · required
User ID of the person who reviewed the payment
reviewedByUserobject · required
User details of the reviewer

ReviewPaymentResponse

messagestring · required
Success message
dataobject · required
Review details

entityNamestring · maxLength: 100 · required
emailstring · email · pattern: ^(?!\.)(?!.*\.\.)([A… · required

dataobject · required

UserProfileResponseDto

messagestring · required
dataobject · required

UpdateRiskProfileRequest

riskProfilestring · enum · required
Enum values:
conservative
balanced
aggressive

UpdateRiskProfileResponse

riskProfilestring · enum · required
Enum values:
conservative
balanced
aggressive
oldRiskProfilestring · enum · required
Enum values:
conservative
balanced
aggressive
updatedAtstring · date-time · pattern: ^(?:(?:\d\d[2468][04… · required

RiskProfileResponse

riskProfilestring · enum · required
Enum values:
conservative
balanced
aggressive

CreateAppDto

namestring · minLength: 1 · maxLength: 100 · required

descriptionstring · maxLength: 500

CreateAppResponseDto

appIdstring · required
clientIdstring · required
clientSecretstring · required
namestring · required
apiKeyIdstring · required

CreateOriginatorRequestDto

businessNamestring · minLength: 1 · required

firstNamestring
lastNamestring
addressstring
citystring
zipCodestring
statestring
countrystring

OriginatorDto

idstring · required
Unique identifier of the originator
Example: 123e4567-e89b-12d3-a456-426614174000
typestring · required
Type of the entity (always 'ORIGINATOR' for originators)
Example: ORIGINATOR
businessNamestring · required
Business name of the originator
Example: Acme Corp
firstNamestring | null · required
First name of the originator
Example: John
lastNamestring | null · required
Last name of the originator
Example: Doe
addressstring | null · required
Address of the originator
Example: 123 Main St
citystring | null · required
City of the originator
Example: New York
zipCodestring | null · required
ZIP code of the originator
Example: 10001
statestring | null · required
State of the originator
Example: NY
countrystring | null · required
Country of the originator
Example: United States
financialInstitutionstring | null · required
Financial institution identifier
Example: 23456P
accountNumberstring | null · required
Account number
Example: 9876543210
teamIdstring · required
Team ID that owns this originator
Example: 123e4567-e89b-12d3-a456-426614174000
isCounterpartyboolean · required
Whether this entity is a counterparty
Example: false
createdAtstring · required
Creation timestamp
Example: 2024-01-01T00:00:00.000Z
updatedAtstring · required
Last update timestamp
Example: 2024-01-01T00:00:00.000Z

CreateOriginatorResponseDto

messagestring · required
Success message
Example: Originator created successfully
dataobject · required
Originator data

OriginatorListResponseDto

dataobject[] · required
List of originators
totalnumber · required
Total count of originators
Example: 10

UpdateOriginatorRequestDto

businessNamestring · minLength: 1
firstNamestring
lastNamestring
addressstring
citystring
zipCodestring
statestring
countrystring

UpdateOriginatorResponseDto

messagestring · required
Success message
Example: Originator updated successfully
dataobject · required
Originator data

WalletDto

idstring · required
namestring · required
addressstring · required
typestring · required
entityIdstring · required
currencystring · required
networkstring · required
availableBalancestring · required
pendingBalancestring · required
createdAtstring · required
updatedAtstring · required

walletIdstring

WalletListResponseDto

messagestring · required
dataobject[] · required

PaymentStatsDto

currencystring · required
Currency code (e.g., USDC, USDT)
Example: USDC
transactionCountnumber · required
Total number of transactions in the period
Example: 15
averageAmountstring · required
Average transaction amount (in smallest unit)
Example: 1500000
totalVolumestring · required
Total transaction volume (in smallest unit)
Example: 22500000
periodHoursnumber · required
Time period in hours for the statistics
Example: 24

PaymentStatsResponseDto

messagestring · required
Success message
Example: Payment statistics retrieved successfully
dataobject[] · required
Payment statistics by currency

EntityData

idstring · required
namestring · required
typestring | null · required
teamIdstring · required
isCounterpartyboolean · required
webhookUrlstring | null · required
createdAtstring · required
updatedAtstring · required

EntityListResponseDto

dataobject[] · required

CreateEntityRequestDto

namestring · minLength: 1 · maxLength: 255 · required

isCounterpartyboolean
Default: true
webhookUrl

CreateEntityResponseDto

dataobject · required

CreateAccountRequestDto

namestring · minLength: 1 · maxLength: 255 · required
addressstring · minLength: 1 · required
typestring · minLength: 1 · required
currencystring · minLength: 1 · required
networkstring · minLength: 1 · required

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

AccountData

idstring · required
namestring · required
addressstring · required
typestring · required
walletIdstring | null · required
entityIdstring · required
currencystring · required
networkstring · required
availableBalancestring · required
pendingBalancestring · required
createdAtstring · required
updatedAtstring · required

CreateAccountResponseDto

accountsobject[] · required
entityIdstring · required

CreateFiatAccountRequestDto

providerstring · enum · required
Enum values:
ALFRED
countrystring · minLength: 2 · maxLength: 2 · required
accountTypestring · enum · required
Enum values:
PIX
SPEI
COELSA
accountNumberstring · minLength: 1 · required
accountDetailsobject · required

entityIdstring · uuid · pattern: ^([0-9a-fA-F]{8}-[0-…
isExternalboolean
Default: false

FiatAccountData

idstring · required
teamIdstring · required
entityIdstring | null · required
externalIdstring · required
providerstring · required
providerCustomerIdstring · required
providerFiatAccountIdstring · required
countrystring · required
accountTypestring · required
accountNumberstring · required
accountDetailsobject | null · required
bankNamestring | null · required
isExternalboolean · required
createdAtstring · required
updatedAtstring · required

CreateFiatAccountResponseDto

dataobject · required

OrgUserDto

idstring · required
emailstring · required
firstNamestring · required
lastNamestring · required
rolesstring[] · required
Enum values:
admin
developer
compliance_manager
payments_operator
statusstring · required
lastActiveAtstring · required
createdAtstring · required
updatedAtstring · required

ListOrgUsersResponseDto

dataobject[] · required
messagestring · required

CreateUserRequestDto

emailstring · email · pattern: ^(?!\.)(?!.*\.\.)([A… · required
firstNamestring · minLength: 1 · maxLength: 100 · required
lastNamestring · minLength: 1 · maxLength: 100 · required

rolesstring[] · minItems: 1
Enum values:
admin
developer
compliance_manager
payments_operator
Default: ["developer"]

CreateUserResponseDto

messagestring · required
dataobject · required

UpdateUserRequestDto

firstNamestring · minLength: 1 · maxLength: 100
lastNamestring · minLength: 1 · maxLength: 100
rolesstring[] · minItems: 1
Enum values:
admin
developer
compliance_manager
payments_operator
statusstring · enum
Enum values:
active
pending
inactive

UpdateUserResponseDto

messagestring · required
dataobject · required

Schemas

Payment

PaginationInfo

PaymentListResponse

SendPaymentIntentRequest

SendPaymentIntentResponse

SendPaymentRequest

SendPaymentResponse

ReviewPaymentRequest

ReviewPayment

ReviewPaymentResponse

SignupRequestDto

SignupResponseDto

UserProfileResponseDto

UpdateRiskProfileRequest

UpdateRiskProfileResponse

RiskProfileResponse

CreateAppDto

CreateAppResponseDto

CreateOriginatorRequestDto

OriginatorDto

CreateOriginatorResponseDto

OriginatorListResponseDto

UpdateOriginatorRequestDto

UpdateOriginatorResponseDto

WalletDto

WalletListResponseDto

PaymentStatsDto

PaymentStatsResponseDto

EntityData

EntityListResponseDto

CreateEntityRequestDto

CreateEntityResponseDto

CreateAccountRequestDto

AccountData

CreateAccountResponseDto

CreateFiatAccountRequestDto

FiatAccountData

CreateFiatAccountResponseDto

OrgUserDto

ListOrgUsersResponseDto

CreateUserRequestDto

CreateUserResponseDto

UpdateUserRequestDto

UpdateUserResponseDto

Schemas

Payment

PaginationInfo

PaymentListResponse

SendPaymentIntentRequest

SendPaymentIntentResponse

SendPaymentRequest

SendPaymentResponse

ReviewPaymentRequest

ReviewPayment

ReviewPaymentResponse

SignupRequestDto

SignupResponseDto

UserProfileResponseDto

UpdateRiskProfileRequest

UpdateRiskProfileResponse

RiskProfileResponse

CreateAppDto

CreateAppResponseDto

CreateOriginatorRequestDto

OriginatorDto

CreateOriginatorResponseDto

OriginatorListResponseDto

UpdateOriginatorRequestDto

UpdateOriginatorResponseDto

WalletDto

WalletListResponseDto

PaymentStatsDto

PaymentStatsResponseDto

EntityData

EntityListResponseDto

CreateEntityRequestDto

CreateEntityResponseDto

CreateAccountRequestDto

AccountData