Transaction Payload Structure


Transaction API Data Model

Transaction (Main Model)

FieldKeyData TypeRequiredMax LengthDescription
Transaction IDtransaction_idstringYes255Unique identifier in your system
TypetypeTransaction Types(ENUM)No-Transaction type (see Transaction Types below)
SubtypesubtypeTransaction Subtypes(ENUM)No-Transaction subtype (see Transaction Subtypes below)
Event Timeevent_timestringYes-ISO8601 datetime (YYYY-MM-DDTHH:MM:SS or YYYY-MM-DDTHH:MM:SSZ)
AmountamountstringYes-Transaction value as decimal string (e.g., "1234.56")
Amount Currencyamount_currencystring enum valueYes-Currency enum for amount (e.g., "USD" - see currency endpoints)
SendersenderTransactionSenderNo-Transaction sender details (see TransactionSender model)
ReceiverreceiverTransactionReceiverNo-Transaction receiver details (see TransactionReceiver model)
BalancebalancestringNo-Account balance after transaction as decimal string
BlockchainblockchainBlockchainDetailsNo-Blockchain transaction details (see BlockchainDetails model)

CurrencyAmount

FieldKeyData TypeRequiredMax LengthDescription
AmountamountstringYes-Amount value as decimal string (e.g., "123.456")
Currency IDcurrency_idintegerNo*-Currency identifier
Currency Typecurrency_typestring enum valueNo*-Type of currency: FIAT or CRYPTO

*Both currency_id and currency_type must be provided together or both omitted

TransactionSender

FieldKeyData TypeRequiredMax LengthDescription
Entity IDentity_idstringNo*-Unique entity identifier (must map to submitted entity)
NamenamestringNo*-Entity name (mutually exclusive with entity_id)
Blockchain Addressesblockchain_addressesarray[string]No-Associated blockchain addresses
Asset Outasset_outCurrencyAmountNo-Asset going out from sender (see CurrencyAmount model)
Balance Afterbalance_afterstringNo-Account balance after transaction in the respective currency (send)

*Either entity_id or name can be provided, but not both

TransactionReceiver

FieldKeyData TypeRequiredMax LengthDescription
Entity IDentity_idstringNo*-Unique entity identifier (must map to submitted entity)
NamenamestringNo*-Entity name (mutually exclusive with entity_id)
Blockchain Addressesblockchain_addressesarray[string]No-Associated blockchain addresses
Asset Inasset_inCurrencyAmountNo-Asset coming in to receiver (see CurrencyAmount model)
Balance Afterbalance_afterstringNo-Account balance after transaction in the respective currency (received)

*Either entity_id or name can be provided, but not both

BlockchainDetails

FieldKeyData TypeRequiredMax LengthDescription
Transaction Hashtransaction_hashstringNo-Transaction hash on the blockchain
Chain IDchain_idintegerNo-Blockchain network identifier (see chain endpoints)

Transaction Types

String Enum ValueDescription
DEPOSITAll funding operations
WITHDRAWALAll cash-out operations
PAYMENTAll payment operations
TRANSFERAll transfer operations
TRADEAll trading operations
FEEAll fee operations
CREDITAll credit operations
INTERESTAll interest/reward operations
LOANAll loan operations
REMITTANCEAll remittance operations
INTERNALAll internal operations
CHARGEBACKAll chargeback operations
OTHERAll other/unspecified operations
TRANSACTIONGeneric transaction type

Transaction Subtypes

String Enum ValueDescription
TRADEAll trading operations
MARGINMargin trading operations
PTL-SALEPrivate token launch sales
EARN_ALLOCATIONEarning program allocations
EARN_REWARDEarning program rewards
STAKINGAll staking operations
REWARDGeneric rewards and dividends
ROLLOVERInvestment rollovers
DEPOSIT_BANKTraditional bank deposits
DEPOSIT_CRYPTOAll cryptocurrency deposits
DEPOSIT_FIATFiat currency deposits
DEPOSIT_PROCESSORPayment processor deposits
ACCOUNT_DEPOSITAccount funding operations
VAULT_DEPOSITVault/savings deposits
WITHDRAWAL_BANKTraditional bank withdrawals
WITHDRAWAL_CRYPTOAll cryptocurrency withdrawals
WITHDRAWAL_FIATFiat currency withdrawals
WITHDRAWAL_PROCESSORPayment processor withdrawals
CASH_WITHDRAWALATM/cash withdrawals
VAULT_WITHDRAWALVault/savings withdrawals
E_TRANSFER_SENTElectronic transfer sent
E_TRANSFER_RECEIVEDElectronic transfer received
INTERNAL_TRANSFERInternal account transfers
BALANCE_TRANSFERBalance transfers between accounts
P2P_TRANSFERPerson-to-person transfers
WIRE_TRANSFERWire transfers
CARD_PURCHASECard-based purchases
BILL_PAYMENTBill payment transactions
LOAN_REPAYMENTLoan repayment transactions
CRYPTO_PAYMENTCryptocurrency payment transactions
CARD_SETTLEMENTCard settlement operations
SERVICE_FEEService fees
SUBSCRIPTION_FEESubscription fees
CASHBACKCashback rewards
CREDIT_TRANSACTIONCredit transactions
PROMOTIONAL_CREDITPromotional credits
INTEREST_EARNEDInterest earned
INTEREST_CHARGEDInterest charged
TRAVEL_EXPENSETravel-related expenses
SETTLEDSettlement operations
LOAD_PREPAID_CARDPrepaid Card Load
ACH_TRANSFERACH batch-based transfers (a subtype of wire transfer)
RTP_TRANSFERReal-Time Payments transfer (a subtype of wire transfer)
CHECK_TRANSFERPhysical check transfer

Amount Currency

Currency Code
USD
ALL
DZD
ARS
AMD
AUD
AZN
BHD
BDT
BYN
BMD
BOB
BAM
BRL
BGN
KHR
CAD
CLP
CNY
COP
CRC
HRK
CUP
CZK
DKK
DOP
EGP
EUR
GEL
GHS
GTQ
HNL
HKD
HUF
ISK
INR
IDR
IRR
IQD
ILS
JMD
JPY
JOD
KZT
KES
KWD
KGS
LBP
MKD
MYR
MUR
MXN
MDL
MNT
MAD
MMK
NAD
NPR
TWD
NZD
NIO
NGN
NOK
OMR
PKR
PAB
PEN
PHP
PLN
GBP
QAR
RON
RUB
SAR
RSD
SGD
ZAR
KRW
SSP
VES
LKR
SEK
CHF
THB
TTD
TND
TRY
UGX
UAH
AED
UYU
UZS
VND