Miracle Docs
Financial statements

List financial statements

Returns a paginated list of financial statements visible to the caller. Filters: merchantId, terminalId, currency, status, periodFrom, periodTo. Cursor-based pagination — default page size 20, maximum 100.

GET
/v1/financial-statements
AuthorizationBearer <token>

In: header

Query Parameters

merchantId?string

Filter by merchant ID (UUID v7).

Formatuuid
terminalId?string

Filter by terminal ID for per-terminal statements (UUID v7).

Formatuuid
currency?string

Filter by ISO 4217 currency code.

settlementId?string

Filter by the settlement the statement is linked to (UUID v7).

Formatuuid
status?string

Filter by lifecycle status (unpaid, paid).

Value in"unpaid" | "paid"
periodFrom?string

Lower bound on the statement period start (ISO 8601).

periodTo?string

Upper bound on the statement period end (ISO 8601).

cursor?string

Pagination cursor from a previous list response.

Formatuuid
limit?integer

Page size. Default 20, maximum 100.

Default20
Range0 < value <= 100
livemode?string

Accepted for compatibility. Statements always belong to the caller mode.

Value in"true" | "false"
sortOrder?string

Sort by createdAt. Defaults to descending (newest first).

Value in"asc" | "desc"

Response Body

application/json

curl -X GET "https://<api-host>/v1/financial-statements"
{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
      "livemode": true,
      "merchantId": "c3073b9d-edd0-49f2-a28d-b7ded8ff9a8b",
      "terminalId": "57e69e1b-2c00-4a26-b5e3-44617c6cc659",
      "currency": "string",
      "period": {
        "from": "string",
        "to": "string"
      },
      "volumes": {
        "payinCount": 0,
        "payinVolume": {
          "currency": "string",
          "valueMinor": 9007199254740991
        },
        "refundCount": 0,
        "refundVolume": {
          "currency": "string",
          "valueMinor": 9007199254740991
        },
        "chargebackCount": 0,
        "chargebackVolume": {
          "currency": "string",
          "valueMinor": 9007199254740991
        },
        "withdrawalCount": 0,
        "withdrawalVolume": {
          "currency": "string",
          "valueMinor": 9007199254740991
        },
        "payoutCount": 0,
        "payoutVolume": {
          "currency": "string",
          "valueMinor": 9007199254740991
        }
      },
      "fees": {
        "merchantFee": {
          "currency": "string",
          "valueMinor": 9007199254740991
        },
        "feeBreakdown": {
          "providerFee": {
            "currency": "string",
            "valueMinor": 9007199254740991
          },
          "platformFee": {
            "currency": "string",
            "valueMinor": 9007199254740991
          },
          "tenantFee": {
            "currency": "string",
            "valueMinor": -9007199254740991
          },
          "partnerCommission": {
            "currency": "string",
            "valueMinor": 9007199254740991
          }
        }
      },
      "rollingReserve": {
        "held": {
          "currency": "string",
          "valueMinor": 9007199254740991
        },
        "released": {
          "currency": "string",
          "valueMinor": 9007199254740991
        },
        "netReserve": {
          "currency": "string",
          "valueMinor": 9007199254740991
        }
      },
      "recurrentFees": {
        "currency": "string",
        "valueMinor": 9007199254740991
      },
      "netToMerchant": {
        "currency": "string",
        "valueMinor": -9007199254740991
      },
      "netToProvider": {
        "currency": "string",
        "valueMinor": 9007199254740991
      },
      "status": "unpaid",
      "settlementId": "b4887549-5aec-4adc-bf32-5fb69ede72ea",
      "createdAt": "string",
      "generatedAt": "string",
      "updatedAt": "string",
      "paidAt": "string",
      "deletedAt": "string"
    }
  ],
  "pagination": {
    "nextCursor": "string",
    "prevCursor": "string",
    "hasMore": true,
    "totalCount": 0
  }
}
Empty

On this page