Skip to main content
GET
/
payments
/
reports
import cobo_waas2
from cobo_waas2.models.get_reports200_response import GetReports200Response
from cobo_waas2.models.report_status import ReportStatus
from cobo_waas2.models.report_type import ReportType
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)
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    report_type = "Order"
    report_status = "Completed"

    try:
        # List all reports
        api_response = api_instance.get_reports(
            limit=limit,
            before=before,
            after=after,
            report_type=report_type,
            report_status=report_status,
        )
        print("The response of PaymentApi->get_reports:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_reports: %s\n" % e)


{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "before": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1",
    "after": "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk",
    "total_count": 10000
  }
}
import cobo_waas2
from cobo_waas2.models.get_reports200_response import GetReports200Response
from cobo_waas2.models.report_status import ReportStatus
from cobo_waas2.models.report_type import ReportType
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)
    limit = 10
    before = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGmk1"
    after = "RqeEoTkgKG5rpzqYzg2Hd3szmPoj2cE7w5jWwShz3C1vyGSAk"
    report_type = "Order"
    report_status = "Completed"

    try:
        # List all reports
        api_response = api_instance.get_reports(
            limit=limit,
            before=before,
            after=after,
            report_type=report_type,
            report_status=report_status,
        )
        print("The response of PaymentApi->get_reports:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PaymentApi->get_reports: %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.

Query Parameters

​
limit
integer<int32>
default:10

The maximum number of objects to return. For most operations, the value range is [1, 50].

​
before
string

A cursor indicating the position before the current page. This value is generated by Cobo and returned in the response. If you are paginating forward from the beginning, you do not need to provide it on the first request. When paginating backward (to the previous page), you should pass the before value returned from the last response.

​
after
string

A cursor indicating the position after the current page. This value is generated by Cobo and returned in the response. You do not need to provide it on the first request. When paginating forward (to the next page), you should pass the after value returned from the last response.

​
report_type
enum<string>

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
Example:

"OrderIn"

​
report_status
enum<string>

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"

Response

List of reports.

​
data
object[]
​
pagination
object

The pagination information of the returned data.