> ## Documentation Index > Fetch the complete documentation index at: https://cobo.com/payments/llms.txt > Use this file to discover all available pages before exploring further. # Reports This page explains Payments report types, the shared inputs used to define report scope, and where to generate or manage reports. ## Generate report scope When you generate a report, you define the report scope with these shared inputs: * `start_time`: Start of the reporting time range * `end_time`: End of the reporting time range * `report_export_format`: Export format for the generated file * `report_types`: One or more report types to generate * `token_ids`: Optional token filter for narrowing the report content Use these inputs to define the time range, output format, and report scope. For detailed request and response mechanics, see the related API operations below. ## Report types and when to use them The current Payments documentation confirms the following report types: | `report_type` | Purpose | Common use case | | ----------------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------- | | `Order` | Export summary data for pay-in orders. | Reconcile order collections and review order-level pay-in activity. | | `OrderTransaction` | Export transaction data related to pay-in orders. | Review the transaction records associated with order-mode payments. | | `TopUpTransaction` | Export transaction data for top-up activity. | Reconcile top-up receipts and review top-up transaction records. | | `PayinWeeklyStatement` | Export a weekly pay-in statement covering order mode and top-up mode. | Review weekly pay-in activity across your pay-in channels. | | `PayinDailyStatement` | Export a daily pay-in statement covering order mode and top-up mode. | Review daily pay-in activity across your pay-in channels. | | `CryptoPayout` | Export transaction data for crypto payouts. | Reconcile crypto payout execution and review payout records. | | `OffRamp` | Export transaction data for fiat off-ramp payouts. | Reconcile fiat payout execution and review off-ramp records. | | `Refund` | Export transaction data for refunds. | Reconcile refund activity and review refund records. | | `PayoutWeeklyStatement` | Export a weekly payout statement covering crypto payouts, fiat off-ramps, and refunds. | Review weekly payout activity across payout channels. | | `PayoutDailyStatement` | Export a daily payout statement covering crypto payouts, fiat off-ramps, and refunds. | Review daily payout activity across payout channels. | | `PayinCommissionFee` | Export pay-in commission fee data. | Reconcile fees charged for pay-in activity. | | `PayoutCommissionFee` | Export payout commission fee data. | Reconcile fees charged for payout activity. | | `BalanceChange` | Export account balance change data. | Review balance movements for reconciliation and account analysis. | | `Summary` | Export summary data that combines pay-ins, payouts, and commission fees. | Review an aggregated reconciliation view across core payment activity. | | `BulkSend` | Export transaction data for Bulk Send activity. | Reconcile batch payout execution and review Bulk Send records. | Different report types cover different business scopes, so the exported columns can differ by `report_type`. ## Common enum value reference The following enum values come from the Payments OpenAPI definitions and help explain status-like and type-like fields in exported report rows. ### `report_status` | Value | Meaning | | ----------- | --------------------------------------------------------------------------------- | | `Completed` | The report was generated successfully and is available for download or retrieval. | | `Failed` | The report could not be generated. | ### `acquiring_type` | Value | Meaning | | ------- | ---------------------------------------------------------------------------------------------------------------------------- | | `Order` | Order mode. Payers complete payment against a fixed-amount order. Best for one-off purchases and fixed-amount payment flows. | | `TopUp` | Top-up mode. Payers deposit funds to dedicated top-up addresses. Best for flexible funding or usage-based payment flows. | ### `payout_channel` | Value | Meaning | | --------- | --------------------------------------------------------------------------------------- | | `Crypto` | The payout is processed as an on-chain crypto transfer. | | `OffRamp` | The payout is processed through the fiat off-ramp channel to a registered bank account. | ### `refund_type` | Value | Meaning | | ---------- | --------------------------------------------------------- | | `Merchant` | The refund amount is deducted from the merchant balance. | | `Psp` | The refund amount is deducted from the developer balance. | ### `flow_direction` | Value | Meaning | | ----- | --------------------------------------- | | `in` | Funds flow into the `source_account`. | | `out` | Funds flow out of the `source_account`. | ### `source_type` | Value | Meaning | | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | `Init` | Balance change caused by initialization. | | `OrderIn` | Balance change caused by an order-mode pay-in. | | `LatePayment` | Balance change caused by a late payment. | | `TopUp` | Balance change caused by a top-up pay-in. | | `UnexceptedIn` | Balance change caused by an unexpected incoming payment. | | `RefundOut` | Balance change caused by a refund payout. | | `Payout` | Balance change caused by a payout. | | `UnexceptedOut` | Balance change caused by an unexpected outgoing payment. | | `Allocation` | Balance change caused by an allocation. | | `SettlementNetwork` | Balance change caused by Settlement Network activity, such as when a Settlement Network transaction settles funds in your Payment account. | | `BulkSend` | Balance change caused by a Bulk Send batch. | ### Pay-in order `status` | Value | Meaning | | ------------ | ------------------------------------------------------------------------------------------- | | `Pending` | The order has been created, but no incoming payment transaction has been detected yet. | | `Processing` | An incoming payment transaction has been detected and the order is being processed. | | `Completed` | The order is complete and the required payment amount has been fully received. | | `Expired` | The order expired, or was explicitly cancelled through the update API. | | `Underpaid` | The order expired after receiving payment, but the received amount was lower than required. | ### Payout `status` | Value | Meaning | | -------------------- | ------------------------------------------------------------------------------- | | `Pending` | The payout has been created and is waiting to be processed. | | `Preparing` | The payout is being prepared. | | `Transferring` | The payout is actively being transferred to the recipient destination. | | `Completed` | The payout completed successfully. | | `PartiallyCompleted` | Some transfers completed successfully and others failed. | | `Failed` | The payout failed and none of the transfers completed successfully. | | `RejectedByBank` | The payout was rejected by the recipient bank. Only applies to OffRamp payouts. | ### Refund `status` | Value | Meaning | | --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | `AddressPending` | The user opened the refund link but has not yet submitted a refund address. | | `AddressSubmitted` | The refund address has been submitted. | | `Pending` | The refund order has been created, but no refund transaction has been initiated yet. | | `Processing` | The refund is in progress and at least one refund transaction is being processed. | | `Completed` | All refund transactions completed successfully. | | `PartiallyCompleted` | Some refund transactions completed successfully and others failed. | | `Failed` | All refund transactions failed. | | `PendingConfirmation` | The refund order has been created but `to_address` has not been specified yet. Once the address is provided, the status changes to `Pending`. | ### Transaction `status` | Value | Meaning | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `Submitted` | The transaction request has been submitted and is waiting to enter downstream processing. | | `PendingScreening` | The transaction is waiting for screening. | | `PendingAuthorization` | The transaction is waiting for authorization checks. This can include human approval as well as internal risk-control, KYT, or compliance checks. | | `PendingSignature` | The transaction passed pre-checks and is waiting for signing or signing-related processing. | | `Broadcasting` | The transaction is being broadcast to the blockchain network. | | `Confirming` | The transaction is already on-chain and is waiting for the required number of confirmations. | | `Completed` | The transaction completed successfully. | | `Failed` | The transaction failed during processing. | | `Rejected` | The transaction was rejected and did not proceed to successful execution. | | `Pending` | The transaction is pending general processing and has not yet entered a more specific execution phase. | ### High-signal transaction `sub_status` values `sub_status` explains the exact stage or failure point of a transaction. The full list is long, so the table below focuses on the values most useful for Payments report analysis and troubleshooting. | Value | Meaning | | ------------------------------- | ------------------------------------------------------------------------------------------------------------------ | | `PendingCoboKYTCheck` | Waiting for Cobo KYT review. | | `RejectedKYT` | Rejected because KYT checks did not pass. | | `PendingRiskControlCheck` | Waiting for risk-control checks. | | `PendingApproverCheck` | Waiting for approver action. | | `RejectedByCobo` | Rejected because Cobo compliance requirements were not satisfied. | | `PendingWaitSigner` | Waiting for a signer to take over. | | `PendingSignerApproval` | Waiting for signer approval. | | `PendingSignerProcessing` | The signing service is processing the transaction. | | `InsufficientBalance` | Available balance is insufficient. | | `InsufficientBalanceFundLocked` | Total balance may exist, but spendable balance is locked and cannot currently fund the transaction. | | `FailedBroadcasting` | Broadcasting to the blockchain network failed. | | `PendingBlockConfirmations` | The transaction has been broadcast and is waiting for enough block confirmations. | | `FailedOnChain` | The transaction reached the blockchain but failed during on-chain execution. | | `ReplacedByNewTransaction` | The original transaction was replaced by a newer transaction, for example in a speed-up or nonce-replacement flow. | | `RejectedByCoboKYT` | Rejected because Cobo KYT checks did not pass. | ## Exported fields and field differences Each report type exports a fixed, ordered set of columns. In the exported file, each column header is a human-readable display label generated from the internal column key shown below; for example, timestamp column headers carry a UTC+8 suffix such as `Created Time(UTC+8)`, `Updated Time(UTC+8)`, and `Expiration Time(UTC+8)`. The `CryptoPayout` and `Summary` report types export multiple sheets in a single XLSX file, as described in their sections below. ### `Order` Each row represents one pay-in order. | Column | Description | | ---------------------- | -------------------------------------------------------------------------------------------------- | | `created_time` | When the order was created; exported under the `Created Time(UTC+8)` column header. | | `order_id` | Unique ID of the pay-in order. | | `payment_type` | Business payment type recorded for the order, such as the pay-in collection mode that produced it. | | `order_status` | Current status of the pay-in order; see "Pay-in order `status`" above. | | `order_tag` | Merchant-defined tag attached to the order for grouping or labeling. | | `merchant_name` | Display name of the merchant associated with the order. | | `merchant_id` | ID of the merchant associated with the order. | | `token` | Token used to pay the order. | | `network` | Blockchain network on which the payment is received. | | `paid_amount` | Token amount actually received for the order. | | `payable_amount` | Token amount the payer was expected to send. | | `product_order_amount` | Base order amount before the developer fee. | | `developer_fee` | Developer fee charged on the order. | | `currency_pair` | Pricing-to-settlement currency pair used for conversion. | | `exchange_rate` | Exchange rate used to convert the priced amount into the payable token amount. | | `wallet_name` | Name of the wallet that receives the order funds. | | `wallet_type` | Type of the receiving wallet. | | `updated_time` | When the order was last updated; exported under the `Updated Time(UTC+8)` column header. | | `expiration_time` | When the order expires; exported under the `Expiration Time(UTC+8)` column header. | ### `OrderTransaction` Each row represents one transaction associated with order-mode pay-ins. | Column | Description | | -------------------- | ----------------------------------------------------------------------------------------- | | `created_time` | When the transaction was created; exported under the `Created Time(UTC+8)` column header. | | `merchant_id` | Merchant associated with the related order. | | `order_id` | Pay-in order the transaction belongs to. | | `order_status` | Status of the related pay-in order; see "Pay-in order `status`" above. | | `transaction_id` | Unique ID of the transaction record. | | `transaction_status` | Processing status of the transaction; see "Transaction `status`" above. | | `transaction_amount` | Token amount moved by the transaction. | | `from_address` | On-chain sender address. | | `to_address` | On-chain receiving address. | | `txn_hash` | On-chain transaction hash. | | `token` | Token transferred. | | `network` | Blockchain network of the transaction. | | `developer_fee` | Developer fee attributed to the transaction. | ### `TopUpTransaction` Each row represents one top-up transaction. | Column | Description | | -------------------- | ---------------------------------------------------------------------------------------------- | | `created_time` | When the transaction was created; exported under the `Created Time(UTC+8)` column header. | | `payment_type` | Business payment type recorded for the top-up transaction. | | `transaction_status` | Processing status of the transaction; see "Transaction `status`" above. | | `payer_id` | Cobo-assigned payer identifier. | | `custom_payer_id` | Developer-defined payer identifier. | | `received_amount` | Token amount received in the top-up. | | `from_address` | On-chain sender address. | | `to_address` | Top-up receiving address. | | `transaction_id` | Unique ID of the transaction record. | | `txn_hash` | On-chain transaction hash. | | `merchant_name` | Display name of the merchant. | | `merchant_id` | ID of the merchant. | | `token` | Token received. | | `network` | Blockchain network of the transaction. | | `developer_fee` | Developer fee attributed to the transaction. | | `wallet_name` | Name of the receiving wallet. | | `wallet_type` | Type of the receiving wallet. | | `updated_time` | When the transaction was last updated; exported under the `Updated Time(UTC+8)` column header. | ### `PayinWeeklyStatement` Each row represents one weekly pay-in statement entry across order mode and top-up mode. | Column | Description | | ------------------------------- | --------------------------------------------------------------------- | | `period` | Statement period the row covers (a week for weekly, a day for daily). | | `token` | Token the amounts in the row are denominated in. | | `transaction_number` | Total number of pay-in transactions in the period. | | `total_payin_amount` | Total pay-in amount for the period. | | `order_transaction_number` | Number of order-mode pay-in transactions. | | `total_order_amount` | Total order-mode pay-in amount. | | `topup_transaction_number` | Number of top-up transactions. | | `total_topup_amount` | Total top-up amount. | | `unexpected_transaction_number` | Number of unexpected incoming transactions. | | `total_unexpected_amount` | Total unexpected incoming amount. | | `total_payin_commission_fee` | Total pay-in commission fee for the period. | ### `PayinDailyStatement` Each row represents one daily pay-in statement entry across order mode and top-up mode. | Column | Description | | ------------------------------- | --------------------------------------------------------------------- | | `period` | Statement period the row covers (a week for weekly, a day for daily). | | `token` | Token the amounts in the row are denominated in. | | `transaction_number` | Total number of pay-in transactions in the period. | | `total_payin_amount` | Total pay-in amount for the period. | | `order_transaction_number` | Number of order-mode pay-in transactions. | | `total_order_amount` | Total order-mode pay-in amount. | | `topup_transaction_number` | Number of top-up transactions. | | `total_topup_amount` | Total top-up amount. | | `unexpected_transaction_number` | Number of unexpected incoming transactions. | | `total_unexpected_amount` | Total unexpected incoming amount. | | `total_payin_commission_fee` | Total pay-in commission fee for the period. | ### `CryptoPayout` Each row represents one crypto payout record. This report is always exported as an XLSX file. The first sheet, `payout crypto`, covers standard crypto payouts. When a payout is routed through a cross-chain bridge, the export includes a second sheet, `payout crypto with bridge`, that repeats the first sheet's columns and adds the bridge columns listed after it. Sheet `payout crypto`: | Column | Description | | ---------------------- | ----------------------------------------------------------------------------------------- | | `created_time` | When the payout was created; exported under the `Created Time(UTC+8)` column header. | | `payout_id` | Unique ID of the payout. | | `payment_type` | Business payment type recorded for the payout. | | `initiator` | Actor or API key that initiated the payout. | | `payout_status` | Status of the payout; see "Payout `status`" above. | | `balance_source` | Account that funded the payout, such as a merchant balance or the developer balance. | | `network` | Blockchain network used for the payout. | | `token` | Token sent to the recipient. | | `to_address` | Recipient on-chain address. | | `total_payout_amount` | Total amount requested for the payout. | | `actual_payout_amount` | Amount actually delivered to the recipient. | | `merchant_names` | Names of the merchants whose balances funded the payout. | | `merchant_ids` | IDs of the merchants whose balances funded the payout. | | `amounts` | Per-merchant amount breakdown for the payout. | | `updated_time` | When the payout was last updated; exported under the `Updated Time(UTC+8)` column header. | Sheet `payout crypto with bridge` additional columns (in addition to all columns above): | Column | Description | | ------------------ | ---------------------------------------------------------- | | `original_network` | Source network before the cross-chain (bridge) conversion. | | `original_token` | Source token before the cross-chain conversion. | | `payout_network` | Destination network delivered after bridging. | | `payout_token` | Destination token delivered after bridging. | | `bridge_fee` | Cross-chain fee charged for the payout. | ### `OffRamp` Each row represents one fiat off-ramp payout record. | Column | Description | | ---------------------- | ----------------------------------------------------------------------------------------- | | `created_time` | When the payout was created; exported under the `Created Time(UTC+8)` column header. | | `payout_id` | Unique ID of the payout. | | `payment_type` | Business payment type recorded for the payout. | | `initiator` | Actor or API key that initiated the payout. | | `payout_status` | Status of the payout; see "Payout `status`" above. | | `balance_source` | Account that funded the payout. | | `bank_name` | Recipient bank name. | | `bank_account_number` | Recipient bank account number. | | `total_payout_amount` | Total fiat amount requested for the payout. | | `actual_payout_amount` | Fiat amount actually delivered to the recipient. | | `merchant_names` | Names of the merchants whose balances funded the payout. | | `merchant_ids` | IDs of the merchants whose balances funded the payout. | | `amounts` | Per-merchant amount breakdown for the payout. | | `updated_time` | When the payout was last updated; exported under the `Updated Time(UTC+8)` column header. | ### `Refund` Each row represents one refund record. | Column | Description | | -------------------- | ----------------------------------------------------------------------------------------- | | `created_time` | When the refund was created; exported under the `Created Time(UTC+8)` column header. | | `refund_order_id` | Unique ID of the refund order. | | `payment_type` | Business payment type recorded for the refund. | | `initiator` | Actor or API key that initiated the refund. | | `transaction_status` | Status of the refund transaction; see "Transaction `status`" above. | | `merchant_name` | Display name of the merchant associated with the refund. | | `merchant_id` | ID of the merchant associated with the refund. | | `order_id` | Related pay-in order ID. | | `token` | Token used for the refund. | | `network` | Blockchain network on which the refund is sent. | | `refund_amount` | Amount refunded. | | `to_address` | Recipient address for the refund. | | `balance_source` | Account the refund was funded from. | | `wallet_name` | Name of the wallet used for the refund. | | `wallet_type` | Type of the wallet used for the refund. | | `updated_time` | When the refund was last updated; exported under the `Updated Time(UTC+8)` column header. | | `description` | Note describing the refund. | ### `PayoutWeeklyStatement` Each row represents one weekly payout statement entry across crypto payouts, off-ramp payouts, and refunds. | Column | Description | | ------------------------------------ | --------------------------------------------------------------------- | | `period` | Statement period the row covers (a week for weekly, a day for daily). | | `token` | Token the amounts in the row are denominated in. | | `transaction_number` | Total number of payout transactions in the period. | | `total_payout_amount` | Total payout amount for the period. | | `withdraw_crypto_transaction_number` | Number of crypto payout transactions. | | `total_withdraw_crypto_amount` | Total crypto payout amount. | | `off_ramp_transaction_number` | Number of off-ramp payout transactions. | | `total_off_ramp_amount` | Total off-ramp payout amount. | | `refund_transaction_number` | Number of refund transactions. | | `total_refund_amount` | Total refund amount. | | `unexpected_transaction_number` | Number of unexpected outgoing transactions. | | `total_unexpected_amount` | Total unexpected outgoing amount. | | `total_payout_commission_fee` | Total payout commission fee for the period. | ### `PayoutDailyStatement` Each row represents one daily payout statement entry across crypto payouts, off-ramp payouts, and refunds. | Column | Description | | ------------------------------------ | --------------------------------------------------------------------- | | `period` | Statement period the row covers (a week for weekly, a day for daily). | | `token` | Token the amounts in the row are denominated in. | | `transaction_number` | Total number of payout transactions in the period. | | `total_payout_amount` | Total payout amount for the period. | | `withdraw_crypto_transaction_number` | Number of crypto payout transactions. | | `total_withdraw_crypto_amount` | Total crypto payout amount. | | `off_ramp_transaction_number` | Number of off-ramp payout transactions. | | `total_off_ramp_amount` | Total off-ramp payout amount. | | `refund_transaction_number` | Number of refund transactions. | | `total_refund_amount` | Total refund amount. | | `unexpected_transaction_number` | Number of unexpected outgoing transactions. | | `total_unexpected_amount` | Total unexpected outgoing amount. | | `total_payout_commission_fee` | Total payout commission fee for the period. | ### `PayinCommissionFee` Each row represents one commission fee record related to pay-in activity. | Column | Description | | -------------------- | ------------------------------------------- | | `merchant_id` | Merchant the fee is attributed to. | | `transaction_type` | Type of transaction the fee applies to. | | `source` | Business source of the charged transaction. | | `billing_date` | Date the fee was billed. | | `transaction_amount` | Amount of the underlying transaction. | | `fee_rate` | Rate applied to compute the fee. | | `fee_amount` | Commission fee amount charged by Cobo. | | `fee_type` | Category of the commission fee. | ### `PayoutCommissionFee` Each row represents one commission fee record related to payout activity. | Column | Description | | -------------------- | ------------------------------------------- | | `merchant_id` | Merchant the fee is attributed to. | | `transaction_type` | Type of transaction the fee applies to. | | `source` | Business source of the charged transaction. | | `to_address` | Recipient address of the underlying payout. | | `billing_date` | Date the fee was billed. | | `transaction_amount` | Amount of the underlying transaction. | | `fee_rate` | Rate applied to compute the fee. | | `fee_amount` | Commission fee amount charged by Cobo. | | `fee_type` | Category of the commission fee. | ### `BalanceChange` Each row represents one balance change record for a Payments account. | Column | Description | | --------------------- | --------------------------------------------------- | | `balance_type` | Type of balance affected by the change. | | `merchant_name` | Display name of the merchant whose balance changed. | | `merchant_id` | ID of the merchant whose balance changed. | | `token` | Token of the balance that changed. | | `network` | Blockchain network associated with the balance. | | `amount_raw` | Balance change amount. | | `balance_change_type` | Business reason for the balance change. | | `source` | Source record that triggered the balance change. | | `amount_change` | Signed amount by which the balance changed. | | `updated_balance` | Resulting balance after the change. | | `business_date` | Business date of the balance change. | Balance changes with the `SettlementNetwork` `source_type` come from Settlement Network activity. See the [Settlement Network](/payments/en/guides/settlement-network) guide. ### `Summary` Each `Summary` report aggregates activity across pay-ins, payouts, and commission fees. The `Summary` report is always exported as an XLSX file containing four sheets: `pay-in`, `pay-out`, `commission-fee`, and `cobo-bill`. Each sheet aggregates the corresponding activity for the selected time range. ### `BulkSend` Each row represents one item within a Bulk Send batch. | Column | Description | | -------------------------- | --------------------------------------------------------------------------------------- | | `created_time` | When the item was created; exported under the `Created Time(UTC+8)` column header. | | `bulk_send_id` | Unique ID of the Bulk Send batch the item belongs to. | | `item_id` | ID of the individual item within the batch. | | `transaction_id` | Transaction ID generated for the item. | | `payment_type` | Business payment type recorded for the item. | | `bulk_send_execution_mode` | Execution mode applied to the Bulk Send batch. | | `bulk_send_item_status` | Status of the individual Bulk Send item. | | `balance_source` | Account funding the item. | | `network` | Blockchain network used for the item. | | `token` | Token sent for the item. | | `to_address` | Recipient address for the item. | | `total_payout_amount` | Amount requested for the item. | | `actual_payout_amount` | Amount actually delivered for the item. | | `merchant_names` | Names of the merchants whose balances funded the item. | | `merchant_ids` | IDs of the merchants whose balances funded the item. | | `updated_time` | When the item was last updated; exported under the `Updated Time(UTC+8)` column header. | After you confirm the fields you need, use the related API operations below to generate reports or list generated reports. ## Related API operations * [Generate reports](/payments/en/api-references/payment/generate-reports) * [List all reports](/payments/en/api-references/payment/list-all-reports)