| data_type |
str |
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. |
|
| transaction_id |
str |
The transaction ID. |
|
| cobo_id |
str |
The Cobo ID, which can be used to track a transaction. |
[optional] |
| request_id |
str |
The request ID provided by you when creating the payout. |
|
| wallet_id |
str |
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 |
|
|
| sub_status |
TransactionSubStatus |
|
[optional] |
| failed_reason |
str |
(This property is applicable to approval failures and signature failures only) The reason why the transaction failed. |
[optional] |
| chain_id |
str |
The chain identifier. |
|
| token_id |
str |
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. |
|
| asset_id |
str |
(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 |
str |
The initiator of this payout, usually the user's API key. |
[optional] |
| initiator_type |
TransactionInitiatorType |
|
|
| confirmed_num |
int |
The number of confirmations this transaction has received. |
[optional] |
| confirming_threshold |
int |
The minimum number of confirmations required to deem a transaction secure. The common threshold is 6 for a Bitcoin transaction. |
[optional] |
| transaction_hash |
str |
The transaction hash. |
[optional] |
| block_info |
TransactionBlockInfo |
|
[optional] |
| raw_tx_info |
TransactionRawTxInfo |
|
[optional] |
| replacement |
TransactionReplacement |
|
[optional] |
| category |
List[str] |
A custom transaction category for you to identify your transfers more easily. |
[optional] |
| description |
str |
The description for the entire bulk send batch. |
[optional] |
| is_loop |
bool |
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] |
| cobo_category |
List[str] |
The transaction category defined by Cobo. For more details, refer to Cobo-defined categories. |
[optional] |
| extra |
List[str] |
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] |
| fueling_info |
TransactionFuelingInfo |
|
[optional] |
| created_timestamp |
int |
The time when the screening request was created, in Unix timestamp format, measured in milliseconds. |
|
| updated_timestamp |
int |
The time when the screening status was updated, in Unix timestamp format, measured in milliseconds. |
|
| tss_request_id |
str |
The TSS request ID. |
[optional] |
| source_key_share_holder_group |
SourceGroup |
|
[optional] |
| target_key_share_holder_group_id |
str |
The target key share holder group ID. |
[optional] |
| addresses |
List[AddressesEventDataAllOfAddresses] |
A list of addresses. |
[optional] |
| wallet |
WalletInfo |
|
[optional] |
| vault_id |
str |
The vault ID. |
[optional] |
| project_id |
str |
The project ID. |
[optional] |
| name |
str |
The vault name. |
[optional] |
| root_pubkeys |
List[RootPubkey] |
|
[optional] |
| chains |
List[ChainInfo] |
The enabled chains. |
|
| wallet_type |
WalletType |
|
|
| wallet_subtypes |
List[WalletSubtype] |
|
[optional] |
| tokens |
List[TokenInfo] |
The enabled tokens. |
|
| contract_address |
str |
The token's contract address on the specified blockchain. |
|
| wallet_subtype |
WalletSubtype |
|
|
| token |
TokenInfo |
|
[optional] |
| feedback |
str |
The feedback provided by Cobo when a token listing request is rejected. |
[optional] |
| address |
str |
The screened blockchain address. |
|
| wallet_uuid |
str |
The wallet ID. |
|
| balance |
Balance |
|
|
| token_ids |
str |
A list of token IDs, separated by comma. |
|
| operation_type |
SuspendedTokenOperationType |
|
|
| order_id |
str |
The pay-in order ID. |
|
| merchant_id |
str |
The merchant ID. |
[optional] |
| merchant_order_code |
str |
A unique reference code assigned by the merchant to identify this order in their system. |
[optional] |
| psp_order_code |
str |
A unique reference code assigned by the developer to identify this order in their system. |
|
| pricing_currency |
str |
The pricing currency of the order. |
[optional] |
| pricing_amount |
str |
The base amount of the order, excluding the developer fee (specified in `fee_amount`). |
[optional] |
| fee_amount |
str |
The developer fee for the order. It is added to the base amount to determine the final charge. |
|
| payable_currency |
str |
The ID of the cryptocurrency used for payment. |
[optional] |
| payable_amount |
str |
The cryptocurrency amount to be paid for this order. |
|
| exchange_rate |
str |
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> |
|
| amount_tolerance |
str |
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] |
| receive_address |
str |
The recipient wallet address to be used for the payment transaction. |
|
| received_token_amount |
str |
The total cryptocurrency amount received for this order. Updates until the expiration time. Precision matches the token standard (e.g., 6 decimals for USDT). |
|
| expired_at |
int |
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 |
str |
The fiat currency for the off-ramp. |
[optional] |
| order_amount |
str |
This field has been deprecated. Please use `pricing_amount` instead. |
[optional] |
| settlement_status |
SettleStatus |
|
[optional] |
| refund_id |
str |
The refund order ID. |
|
| amount |
str |
The amount in cryptocurrency to be returned for this refund order. |
|
| to_address |
str |
The recipient's wallet address where the refund will be sent. |
|
| refund_type |
RefundType |
|
[optional] |
| charge_merchant_fee |
bool |
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] |
| merchant_fee_amount |
str |
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] |
| merchant_fee_token_id |
str |
The ID of the cryptocurrency used for the developer fee. This is only applicable if `charge_merchant_fee` is set to true. |
[optional] |
| commission_fee |
CommissionFee |
|
[optional] |
| settlement_request_id |
str |
The settlement request ID generated by Cobo. |
|
| settlements |
List[SettlementDetail] |
|
|
| acquiring_type |
AcquiringType |
|
|
| payout_channel |
PayoutChannel |
|
|
| settlement_type |
SettlementType |
|
[optional] |
| received_amount_fiat |
str |
The estimated amount of the fiat currency to receive after off-ramping. This amount is subject to change due to bank transfer fees. |
[optional] |
| bank_account |
BankAccount |
|
[optional] |
| payer_id |
str |
A unique identifier assigned by Cobo to track and identify individual payers. |
|
| custom_payer_id |
str |
A unique identifier assigned by the developer to track and identify individual payers in their system. |
|
| chain |
str |
The chain ID. |
|
| previous_address |
str |
The previous top-up address that was assigned to the payer. |
|
| updated_address |
str |
The new top-up address that has been assigned to the payer. |
|
| payout_id |
str |
The payout ID generated by Cobo. |
|
| source_account |
str |
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"`. |
|
| payout_items |
List[PaymentPayoutItem] |
required |
[optional] |
| recipient_info |
PaymentPayoutRecipientInfo |
|
[optional] |
| actual_payout_amount |
str |
- 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] |
| commission_fees |
List[CommissionFee] |
The commission fees of the payout. |
[optional] |
| remark |
str |
A note or comment about the payout. |
[optional] |
| bulk_send_id |
str |
The bulk send ID. |
|
| execution_mode |
PaymentBulkSendExecutionMode |
|
|
| disposition_type |
DispositionType |
|
|
| disposition_status |
DispositionStatus |
|
|
| destination_address |
str |
The blockchain address to receive the refunded/isolated funds. |
[optional] |
| disposition_amount |
str |
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] |
| transaction_type |
KytScreeningsTransactionType |
|
|
| review_status |
ReviewStatusType |
|
|
| funds_status |
FundsStatusType |
|
|
| screening_id |
str |
The unique system-generated identifier for this screening request (UUID format, fixed 36 characters). |
|