Skip to main content
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: 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

acquiring_type

payout_channel

refund_type

flow_direction

source_type

Pay-in order status

Payout status

Refund status

Transaction status

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.

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.

OrderTransaction

Each row represents one transaction associated with order-mode pay-ins.

TopUpTransaction

Each row represents one top-up transaction.

PayinWeeklyStatement

Each row represents one weekly pay-in statement entry across order mode and top-up mode.

PayinDailyStatement

Each row represents one daily pay-in statement entry across order mode and top-up mode.

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: Sheet payout crypto with bridge additional columns (in addition to all columns above):

OffRamp

Each row represents one fiat off-ramp payout record.

Refund

Each row represents one refund record.

PayoutWeeklyStatement

Each row represents one weekly payout statement entry across crypto payouts, off-ramp payouts, and refunds.

PayoutDailyStatement

Each row represents one daily payout statement entry across crypto payouts, off-ramp payouts, and refunds.

PayinCommissionFee

Each row represents one commission fee record related to pay-in activity.

PayoutCommissionFee

Each row represents one commission fee record related to payout activity.

BalanceChange

Each row represents one balance change record for a Payments account. Balance changes with the SettlementNetwork source_type come from Settlement Network activity. See the 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. After you confirm the fields you need, use the related API operations below to generate reports or list generated reports.