| 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. - `PaymentBulkSendItem`: The payment bulk send item event data. - `PaymentAccountBalanceUpdate`: The Payments account balance updated event data, including account information and balance change details. - `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. - `Organization`: The organization event data. - `FiatTransaction`: The fiat transaction event data. |
|
| transactionId |
String |
The transaction ID. |
|
| coboId |
String |
The Cobo ID, which can be used to track a transaction. |
[optional] |
| requestId |
String |
The request ID of the bulk send batch. |
|
| 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 |
StatusEnum |
The status of the fiat transaction. Possible values include: - `Created`: The transaction has been created. - `Succeeded`: The transaction has been completed successfully. |
|
| subStatus |
TransactionSubStatus |
|
[optional] |
| failedReason |
String |
The reason why the bulk send item failed. |
[optional] |
| chainId |
String |
The chain identifier. |
|
| tokenId |
String |
The token ID of the balance change. |
|
| 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 (on-chain transaction identifier, also referred to as `txid`). This property is populated only after the transaction is broadcast on-chain, so it may be `null` or absent before broadcast. In contrast, `transaction_id` (the Cobo internal transaction ID) is assigned at creation and is always present. |
[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 |
A note or comment about the bulk send item. |
[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 Cobo category of the transaction. |
[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 transaction 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 organization 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 |
The downstream merchant's order reference, exactly as you supplied it in `merchant_order_code` when creating the order, if you provided one. Present only when a `merchant_order_code` was included at order creation. |
[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 order-level developer charge credited to your developer balance when the order settles. A value of `0` means that no developer fee was charged and the merchant was credited with the full collected amount. When the collected payment exactly matches the payable amount, the merchant balance is credited with the payable amount minus `fee_amount`, and your developer balance is credited with `fee_amount`. For example, for a payable amount of `104.08` and a `fee_amount` of `2`, the merchant receives `102.08` and you receive `2`. For related fee settings and settlement details, see Merchant management and Accounts and fund allocation. |
|
| 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 transaction amount. |
|
| 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 |
The commission fee. Not returned when no fee has been incurred, the actual charged amount once incurred, or `0` if refunded. |
[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. |
|
| subscriptionId |
String |
A unique identifier assigned by Cobo to track and identify subscription. |
[optional] |
| actionId |
String |
A unique identifier assigned by Cobo to track and identify subscription action. |
[optional] |
| 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 of the balance change. This field uses the same semantics as `source_account` in List balance changes. - When the account is a merchant account, this is the merchant ID (merchant code), which you can retrieve by calling List all merchants. - When the account is the developer account, use `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. Not returned when no fee has been incurred, the actual charged amounts once incurred, or `0` if refunded. |
[optional] |
| remark |
String |
A note or comment about the payout. |
[optional] |
| bulkSendId |
String |
The bulk send ID that this item belongs to. |
|
| executionMode |
PaymentBulkSendExecutionMode |
|
|
| bulkSendItemId |
String |
The bulk send item ID. |
|
| receivingAddress |
String |
The receiving address. |
|
| txHash |
String |
The transaction hash of the bulk send item. |
[optional] |
| validationStatus |
PaymentBulkSendItemValidationStatus |
|
|
| sourceId |
String |
The source ID of the balance change. |
|
| sourceType |
PaymentBalanceChangeSourceType |
|
|
| amountRaw |
String |
The balance change amount in the token's decimal precision, represented as a numeric string. |
|
| balanceBefore |
String |
The account balance before the balance change, truncated to two decimal places and represented as a numeric string. |
|
| balanceBeforeRaw |
String |
The account balance before the balance change in the token's decimal precision, represented as a numeric string. |
|
| balanceAfter |
String |
The account balance after the balance change, truncated to two decimal places and represented as a numeric string. |
|
| balanceAfterRaw |
String |
The account balance after the balance change in the token's decimal precision, represented as a numeric string. |
|
| flowDirection |
PaymentBalanceFlowDirection |
|
|
| updateTime |
Long |
The time when the balance was updated, represented as a UNIX timestamp in seconds. |
|
| 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 |
FeeStationFiatTransactionType |
|
|
| reviewStatus |
ReviewStatusType |
|
|
| fundsStatus |
FundsStatusType |
|
|
| screeningId |
UUID |
The unique system-generated identifier for this screening request (UUID format, fixed 36 characters). |
|
| orgId |
UUID |
The organization ID. |
[optional] |
| mainTransactionId |
UUID |
The UUID of the parent (main) transaction that this record is associated with. Set only when the current record is a gas/fee transaction initiated by FeeStation; omit for main transactions. |
[optional] |
| fiatCurrency |
String |
The fiat currency of the transaction. Possible values include: - `USD`: US Dollar. |
|
| modifiedTimestamp |
Long |
The time when the transaction was last modified, in Unix timestamp format, measured in milliseconds. |
[optional] |