Skip to main content
POST
/
payments
/
reports
import cobo_waas2
from cobo_waas2.models.create_report_request import CreateReportRequest
from cobo_waas2.models.report import Report
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.PaymentApi(api_client)
    create_report_request = cobo_waas2.CreateReportRequest(
        start_time=1764237462,
        end_time=1764237462,
        report_export_format="CSV",
        report_types=["Order"],
    )

    try:
        # Generate reports
        api_response = api_instance.create_report(
            create_report_request=create_report_request
        )
        print("The response of PaymentApi->create_report:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_report: %s\n" % e)

{
  "report_id": "123e4567-e89b-12d3-a456-426614174004",
  "report_types": [
    "OrderIn"
  ],
  "start_time": 1764237462,
  "end_time": 1764237462,
  "created_timestamp": 1744689600,
  "report_export_format": "CSV",
  "report_status": "Completed",
  "initiator": "b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b85b81dcc15f920e9d",
  "report_url": "https://cobo.com/reports/123e4567-e89b-12d3-a456-426614174004"
}
import cobo_waas2
from cobo_waas2.models.create_report_request import CreateReportRequest
from cobo_waas2.models.report import Report
from cobo_waas2.rest import ApiException
from pprint import pprint

# See configuration.py for a list of all supported configurations.
configuration = cobo_waas2.Configuration(
    # Replace `<YOUR_PRIVATE_KEY>` with your private key
    api_private_key="<YOUR_PRIVATE_KEY>",
    # Select the development environment. To use the production environment, change the URL to https://api.cobo.com/v2.
    host="https://api.dev.cobo.com/v2",
)
# Enter a context with an instance of the API client
with cobo_waas2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cobo_waas2.PaymentApi(api_client)
    create_report_request = cobo_waas2.CreateReportRequest(
        start_time=1764237462,
        end_time=1764237462,
        report_export_format="CSV",
        report_types=["Order"],
    )

    try:
        # Generate reports
        api_response = api_instance.create_report(
            create_report_request=create_report_request
        )
        print("The response of PaymentApi->create_report:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->create_report: %s\n" % e)

Authorizations

BIZ-API-KEY
string
header
required

The API key. For more details, refer to API key.

In the API playground, enter your API secret, and your API key will be accordingly calculated.

Body

application/json

The request body to create payment reports.

start_time
integer
required

The start time of the report. Unix timestamp measured in seconds.

Example:

1764237462

end_time
integer
required

The end time of the report. Unix timestamp measured in seconds.

Example:

1764237462

report_export_format
enum<string>
required

The format of the report.

  • CSV: The report will be exported as a CSV file.
  • XLSX: The report will be exported as an XLSX file.
  • ZIP: The report will be exported as a ZIP file which contains multiple files.
Available options:
CSV,
XLSX,
ZIP
Example:

"CSV"

report_types
enum<string>[]
required

The type of the report.

  • Order: Summary of all pay-in orders.
  • OrderTransaction: Summary of all pay-in order transactions.
  • TopUpTransaction: Summary of all top-up transactions.
  • PayinWeeklyStatement: Weekly report of all pay-ins (including order mode and top-up mode).
  • PayinDailyStatement: Daily report of all pay-ins (including order mode and top-up mode).
  • CryptoPayout: Summary of all crypto payout transactions.
  • OffRamp: Summary of all fiat off-ramp transactions.
  • Refund: Summary of all refund transactions.
  • PayoutWeeklyStatement: Weekly report of all payouts (including crypto payouts, fiat off-ramps, and refunds).
  • PayoutDailyStatement: Daily report of all payouts (including crypto payouts, fiat off-ramps, and refunds).
  • PayinCommissionFee: Summary of all commission fees for pay-ins.
  • PayoutCommissionFee: Summary of all commission fees for payouts.
  • BalanceChange: Summary of balance changes for all accounts.
  • Summary: Summary of all pay-ins, payouts, and commission fees.
Available options:
Order,
OrderTransaction,
TopUpTransaction,
PayinWeeklyStatement,
PayinDailyStatement,
CryptoPayout,
OffRamp,
Refund,
PayoutWeeklyStatement,
PayoutDailyStatement,
PayinCommissionFee,
PayoutCommissionFee,
BalanceChange,
Summary
token_ids
string[]

Optional filter to include only items related to specified token IDs in the report.

Example:
["ETH_USDT", "ETH_USDC"]

Response

Payment report created successfully.

report_id
string
required

The report ID generated by Cobo.

Example:

"123e4567-e89b-12d3-a456-426614174004"

report_types
enum<string>[]
required

The types of the report.

The type of the report.

  • Order: Summary of all pay-in orders.
  • OrderTransaction: Summary of all pay-in order transactions.
  • TopUpTransaction: Summary of all top-up transactions.
  • PayinWeeklyStatement: Weekly report of all pay-ins (including order mode and top-up mode).
  • PayinDailyStatement: Daily report of all pay-ins (including order mode and top-up mode).
  • CryptoPayout: Summary of all crypto payout transactions.
  • OffRamp: Summary of all fiat off-ramp transactions.
  • Refund: Summary of all refund transactions.
  • PayoutWeeklyStatement: Weekly report of all payouts (including crypto payouts, fiat off-ramps, and refunds).
  • PayoutDailyStatement: Daily report of all payouts (including crypto payouts, fiat off-ramps, and refunds).
  • PayinCommissionFee: Summary of all commission fees for pay-ins.
  • PayoutCommissionFee: Summary of all commission fees for payouts.
  • BalanceChange: Summary of balance changes for all accounts.
  • Summary: Summary of all pay-ins, payouts, and commission fees.
Available options:
Order,
OrderTransaction,
TopUpTransaction,
PayinWeeklyStatement,
PayinDailyStatement,
CryptoPayout,
OffRamp,
Refund,
PayoutWeeklyStatement,
PayoutDailyStatement,
PayinCommissionFee,
PayoutCommissionFee,
BalanceChange,
Summary
start_time
integer
required

The start time of the report. Unix timestamp measured in seconds.

Example:

1764237462

end_time
integer
required

The end time of the report. Unix timestamp measured in seconds.

Example:

1764237462

created_timestamp
integer
required

The created time of the report. Unix timestamp measured in seconds.

Example:

1744689600

report_export_format
enum<string>
required

The format of the report.

  • CSV: The report will be exported as a CSV file.
  • XLSX: The report will be exported as an XLSX file.
  • ZIP: The report will be exported as a ZIP file which contains multiple files.
Available options:
CSV,
XLSX,
ZIP
Example:

"CSV"

report_status
enum<string>
required

The status of the report.

  • Completed: The report has been generated successfully.
  • Failed: The report could not be generated.
Available options:
Completed,
Failed
Example:

"Completed"

initiator
string
required

The initiator of this report. Usually the API key used to generate the report.

Example:

"b2ae1b5aaade686c968ef2bbd31cc75ba94e5a85fd9cb0b85b81dcc15f920e9d"

report_url
string

The URL of the report.

Example:

"https://cobo.com/reports/123e4567-e89b-12d3-a456-426614174004"