| dataType |
DataTypeEnum |
The data type of the event. - `Transaction`: The transaction event data. - `TSSRequest`: The TSS request event data. - `Addresses`: The addresses event data. - `WalletInfo`: The wallet information event data. - `MPCVault`: The MPC vault event data. - `Chains`: The enabled chain event data. - `Tokens`: The enabled token event data. - `TokenListing`: The token listing event data. - `PaymentOrder`: The payment order event data. - `PaymentRefund`: The payment refund event data. - `PaymentSettlement`: The payment settlement event data. - `PaymentTransaction`: The payment transaction event data. - `PaymentAddressUpdate`: The top-up address update event data. - `PaymentPayout`: The payment payout event data. - `PaymentBulkSend`: The payment bulk send event data. - `BalanceUpdateInfo`: The balance update event data. - `SuspendedToken`: The token suspension event data. - `ComplianceDisposition`: The compliance disposition event data. - `ComplianceKytScreenings`: The compliance KYT screenings event data. - `ComplianceKyaScreenings`: The compliance KYA screenings event data. |
|
| transactionId |
UUID |
The transaction ID. |
|
| coboId |
String |
The Cobo ID, which can be used to track a transaction. |
[optional] |
| requestId |
String |
The request ID. |
|
| walletId |
String |
For deposit transactions, this property represents the wallet ID of the transaction destination. For transactions of other types, this property represents the wallet ID of the transaction source. |
|
| type |
TransactionType |
|
[optional] |
| status |
KyaScreeningStatus |
|
|
| subStatus |
TransactionSubStatus |
|
[optional] |
| failedReason |
String |
(This property is applicable to approval failures and signature failures only) The reason why the transaction failed. |
[optional] |
| chainId |
String |
The chain identifier. |
|
| tokenId |
String |
The token ID, which is the unique identifier of a token. You can retrieve the IDs of all the tokens you can use by calling List enabled tokens. |
|
| assetId |
String |
(This concept applies to Exchange Wallets only) The asset ID. An asset ID is the unique identifier of the asset held within your linked exchange account. |
[optional] |
| source |
TransactionSource |
|
|
| destination |
TransactionDestination |
|
|
| result |
TransactionResult |
|
[optional] |
| fee |
TransactionFee |
|
[optional] |
| initiator |
String |
The initiator of this payout, usually the user's API key. |
[optional] |
| initiatorType |
TransactionInitiatorType |
|
|
| confirmedNum |
Integer |
The number of confirmations this transaction has received. |
[optional] |
| confirmingThreshold |
Integer |
The minimum number of confirmations required to deem a transaction secure. The common threshold is 6 for a Bitcoin transaction. |
[optional] |
| transactionHash |
String |
The transaction hash. |
[optional] |
| blockInfo |
TransactionBlockInfo |
|
[optional] |
| rawTxInfo |
TransactionRawTxInfo |
|
[optional] |
| replacement |
TransactionReplacement |
|
[optional] |
| category |
List<String> |
A custom transaction category for you to identify your transfers more easily. |
[optional] |
| description |
String |
The description for the entire bulk send batch. |
[optional] |
| isLoop |
Boolean |
Whether the transaction was executed as a Cobo Loop transfer. - `true`: The transaction was executed as a Cobo Loop transfer. - `false`: The transaction was not executed as a Cobo Loop transfer. |
[optional] |
| coboCategory |
List<String> |
The transaction category defined by Cobo. For more details, refer to Cobo-defined categories. |
[optional] |
| extra |
List<String> |
A list of JSON-encoded strings containing structured, business-specific extra information for the transaction. Each item corresponds to a specific data type, indicated by the `extra_type` field in the JSON object (for example, "BabylonBusinessInfo", "BtcAddressInfo"). |
[optional] |
| fuelingInfo |
TransactionFuelingInfo |
|
[optional] |
| createdTimestamp |
Long |
The time when the screening request was created, in Unix timestamp format, measured in milliseconds. |
|
| updatedTimestamp |
Long |
The time when the screening status was updated, in Unix timestamp format, measured in milliseconds. |
|
| tssRequestId |
String |
The TSS request ID. |
[optional] |
| sourceKeyShareHolderGroup |
SourceGroup |
|
[optional] |
| targetKeyShareHolderGroupId |
String |
The target key share holder group ID. |
[optional] |
| addresses |
List<AddressesEventDataAllOfAddresses> |
A list of addresses. |
[optional] |
| wallet |
WalletInfo |
|
[optional] |
| vaultId |
String |
The vault ID. |
[optional] |
| projectId |
String |
The project ID. |
[optional] |
| name |
String |
The vault name. |
[optional] |
| rootPubkeys |
List<RootPubkey> |
|
[optional] |
| chains |
List<ChainInfo> |
The enabled chains. |
|
| walletType |
WalletType |
|
|
| walletSubtypes |
List<WalletSubtype> |
|
[optional] |
| tokens |
List<TokenInfo> |
The enabled tokens. |
|
| contractAddress |
String |
The token's contract address on the specified blockchain. |
|
| walletSubtype |
WalletSubtype |
|
|
| token |
TokenInfo |
|
[optional] |
| feedback |
String |
The feedback provided by Cobo when a token listing request is rejected. |
[optional] |
| address |
String |
The screened blockchain address. |
|
| walletUuid |
UUID |
The wallet ID. |
|
| balance |
Balance |
|
|
| tokenIds |
String |
A list of token IDs, separated by comma. |
|
| operationType |
SuspendedTokenOperationType |
|
|
| orderId |
String |
The pay-in order ID. |
|
| merchantId |
String |
The merchant ID. |
[optional] |
| merchantOrderCode |
String |
A unique reference code assigned by the merchant to identify this order in their system. |
[optional] |
| pspOrderCode |
String |
A unique reference code assigned by the developer to identify this order in their system. |
|
| pricingCurrency |
String |
The pricing currency of the order. |
[optional] |
| pricingAmount |
String |
The base amount of the order, excluding the developer fee (specified in `fee_amount`). |
[optional] |
| feeAmount |
String |
The developer fee for the order. It is added to the base amount to determine the final charge. |
|
| payableCurrency |
String |
The ID of the cryptocurrency used for payment. |
[optional] |
| payableAmount |
String |
The cryptocurrency amount to be paid for this order. |
|
| exchangeRate |
String |
The exchange rate between `payable_currency` and `pricing_currency`, calculated as (`pricing_amount` + `fee_amount`) / `payable_amount`. <Note>This field is only returned when `payable_amount` was not provided in the order creation request. </Note> |
|
| amountTolerance |
String |
The allowed amount deviation, with precision up to 1 decimal place. For example, if `payable_amount` is `100.00` and `amount_tolerance` is `0.50`: - Payer pays 99.55 → Success (difference of 0.45 ≤ 0.5) - Payer pays 99.40 → Underpaid (difference of 0.60 > 0.5) |
[optional] |
| receiveAddress |
String |
The recipient wallet address to be used for the payment transaction. |
|
| receivedTokenAmount |
String |
The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
| expiredAt |
Integer |
The expiration time of the pay-in order, represented as a UNIX timestamp in seconds. |
[optional] |
| transactions |
List<PaymentTransaction> |
An array of payout transactions. |
[optional] |
| currency |
String |
The fiat currency for the off-ramp. |
[optional] |
| orderAmount |
String |
This field has been deprecated. Please use `pricing_amount` instead. |
[optional] |
| settlementStatus |
SettleStatus |
|
[optional] |
| refundId |
String |
The refund order ID. |
|
| amount |
String |
The amount in cryptocurrency to be returned for this refund order. |
|
| toAddress |
String |
The recipient's wallet address where the refund will be sent. |
|
| refundType |
RefundType |
|
[optional] |
| chargeMerchantFee |
Boolean |
Whether to charge developer fee to the merchant for the refund. - `true`: The fee amount (specified in `merchant_fee_amount`) will be deducted from the merchant's balance and added to the developer's balance - `false`: The merchant is not charged any developer fee. |
[optional] |
| merchantFeeAmount |
String |
The developer fee amount to charge the merchant, denominated in the cryptocurrency specified by `merchant_fee_token_id`. This is only applicable if `charge_merchant_fee` is set to `true`. |
[optional] |
| merchantFeeTokenId |
String |
The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. |
[optional] |
| commissionFee |
CommissionFee |
|
[optional] |
| settlementRequestId |
String |
The settlement request ID generated by Cobo. |
|
| settlements |
List<SettlementDetail> |
|
|
| acquiringType |
AcquiringType |
|
|
| payoutChannel |
PayoutChannel |
|
|
| settlementType |
SettlementType |
|
[optional] |
| receivedAmountFiat |
String |
The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees. |
[optional] |
| bankAccount |
BankAccount |
|
[optional] |
| payerId |
String |
A unique identifier assigned by Cobo to track and identify individual payers. |
|
| customPayerId |
String |
A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
| chain |
String |
The chain ID. |
|
| previousAddress |
String |
The previous top-up address that was assigned to the payer. |
|
| updatedAddress |
String |
The new top-up address that has been assigned to the payer. |
|
| payoutId |
String |
The payout ID generated by Cobo. |
|
| sourceAccount |
String |
The source account from which the bulk send will be made. - If the source account is a merchant account, provide the merchant's ID (e.g., "M1001"). - If the source account is the developer account, use the string `"developer"`. |
|
| payoutItems |
List<PaymentPayoutItem> |
required |
[optional] |
| recipientInfo |
PaymentPayoutRecipientInfo |
|
[optional] |
| actualPayoutAmount |
String |
- For `Crypto` payouts: The amount of cryptocurrency sent to the recipient's address, denominated in the token specified in `recipient_info.token_id`. - For `OffRamp` payouts: The amount of fiat currency sent to the recipient's bank account, denominated in the currency specified in `recipient_info.currency`. (Note: The actual amount received may be lower due to additional bank transfer fees.) |
[optional] |
| commissionFees |
List<CommissionFee> |
The commission fees of the payout. |
[optional] |
| remark |
String |
A note or comment about the payout. |
[optional] |
| bulkSendId |
String |
The bulk send ID. |
|
| executionMode |
PaymentBulkSendExecutionMode |
|
|
| dispositionType |
DispositionType |
|
|
| dispositionStatus |
DispositionStatus |
|
|
| destinationAddress |
String |
The blockchain address to receive the refunded/isolated funds. |
[optional] |
| dispositionAmount |
String |
The amount to be refunded/isolated from the original transaction, specified as a numeric string. This value cannot exceed the total amount of the original transaction. |
[optional] |
| transactionType |
KytScreeningsTransactionType |
|
|
| reviewStatus |
ReviewStatusType |
|
|
| fundsStatus |
FundsStatusType |
|
|
| screeningId |
UUID |
The unique system-generated identifier for this screening request (UUID format, fixed 36 characters). |
|