Reporting and Registers

We understand financial reporting. Therefore, in our solution, you will find various registers and reports that will help you pass the most challenging audit and keep your finances fully under control.

Instructions for Creating and Retrieving a Report (API)

This API allows you to automatically generate reports on financial transactions in your system — payments, withdrawals, exchanges, etc. It can be integrated into internal analytics systems, accounting software, or CRM to receive up-to-date transaction information in a convenient format (CSV/Excel) on a daily basis or once a month.

✅ Supports filtering by statuses, transaction types, currencies, and other parameters.

📅 Maximum allowed time range: 3 months per request.

1. Creating a Report

Use the POST /api/v3/reports/create method.

{
  "params": {
    "type": "orders",
    "timezone": "UTC",
    "id": "",                      // Transaction ID (optional)
    "merchantOrderId": "",        // If `id` is used, `merchantOrderId` must be null
    "createdAtFrom": "2025-07-02T07:44:51+00:00",
    "createdAtTo": "2025-07-02T07:44:51+00:00",
    "types": [ "payin", "exchange_payin", "payout", "exchange_payout", "exchange" ],
    "statuses": [ "new", "processing", "completed", "rejected", "canceled", "partially_completed", "refunded", "overpaid", "underpaid" ],
    "clientId": "",
    "taxpayerNumber": "",
    "transactionCurrency": "",
    "transactionPaymentMethod": ""
  }
}

✅ Response (Successful Creation):

{
  "data": {
    "id": "cd97028f-70d2-4c95-a235-098e942e6315",
    "status": "processing"
  },
  "error": null
}

2. Checking Report Status

Use the POST /api/v3/reports/get-status method.

{
  "id": "cd97028f-70d2-4c95-a235-098e942e6315"
}

✅ Report Status Response:

{
  "data": {
    "id": "cd97028f-70d2-4c95-a235-098e942e6315",
    "status": "processing",
    "type": "orders",
    "progress": 19
  },
  "error": null
}

3. Retrieving the Report Link

Use the POST /api/v3/reports/get-link method.

{
  "id": "cd97028f-70d2-4c95-a235-098e942e6315"
}

✅ Report Link Response:

{
  "data": {
    "status": "success",
    "type": "orders",
    "downloadLink": "https://reports...1448"
  },
  "error": null
}

In the request for creating a report, you can pass either id or merchantOrderId, but not both simultaneously. If id is used, then merchantOrderId must be null, and vice versa.