Skip to main content
GET
/
v1
/
fees
/
redemption
/
dailyReports
List burn fee calculations
curl --request GET \
  --url https://api-sandbox.circle.com/v1/fees/redemption/dailyReports \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
      "fee": {
        "amount": "3.14",
        "currency": "USD"
      },
      "cumulatedPayoutAmount": {
        "amount": "64.54",
        "currency": "USD"
      },
      "cumulatedPaymentAmount": {
        "amount": "34.54",
        "currency": "USD"
      },
      "cumulatedNetAmount": {
        "amount": "30.00",
        "currency": "USD"
      },
      "valueDate": "2023-05-23",
      "status": "paid",
      "thresholdResetTimestamp": "2023-05-23T16:00:00Z",
      "createDate": "2024-04-10T02:13:30.000Z",
      "updateDate": "2024-04-10T02:13:30.000Z",
      "feeType": "net",
      "redemptionMode": "standard",
      "aggregationLevel": "daily"
    },
    {
      "id": "c727dc42-299f-40b7-8599-c4af9d1e1c6b",
      "fee": {
        "amount": "3000.00",
        "currency": "USD"
      },
      "cumulatedPayoutAmount": {
        "amount": "98000000.00",
        "currency": "USD"
      },
      "cumulatedPaymentAmount": {
        "amount": "95000000.00",
        "currency": "USD"
      },
      "cumulatedNetAmount": {
        "amount": "3000000.00",
        "currency": "USD"
      },
      "valueDate": "2023-05-31",
      "status": "scheduled",
      "thresholdResetTimestamp": "2023-05-31T16:00:00Z",
      "createDate": "2023-06-01T02:13:30.000Z",
      "updateDate": "2023-06-01T02:13:30.000Z",
      "feeType": "surcharge",
      "redemptionMode": "institutional",
      "aggregationLevel": "monthly",
      "billingPeriodStart": "2023-05-01",
      "billingPeriodEnd": "2023-06-01"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
minimumFeeAmount
string

Burn fee calculations below this value are filtered.

Example:

"3.14"

​
feeType
enum<string>

Fee calculation type

Available options:
gross,
net,
surcharge
Example:

"net"

​
walletId
string

The wallet ID of an external entity to scope results to. If omitted, returns only the calculations for the main account. Get wallet IDs from the Core API for Institutions.

​
currency
enum<string>

Filters results to a single currency. If omitted, returns all supported currencies.

Available options:
USD,
EUR
​
from
string<date-time>

Queries items created since the specified date-time (inclusive).

Example:

"2020-04-10T02:13:30.000Z"

​
to
string<date-time>

Queries items created before the specified date-time (inclusive).

Example:

"2020-04-10T02:13:30.000Z"

​
pageBefore
string

A collection ID value used for pagination.

It marks the exclusive end of a page. When provided, the collection resource will return the next n items before the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjuction with pageAfter.

​
pageAfter
string

A collection ID value used for pagination.

It marks the exclusive begin of a page. When provided, the collection resource will return the next n items after the id, with n being specified by pageSize.

The items will be returned in the natural order of the collection.

The resource will return the first page if neither pageAfter nor pageBefore are specified.

SHOULD NOT be used in conjuction with pageBefore.

​
pageSize
integer

Limits the number of items to be returned.

Some collections have a strict upper bound that will disregard this value. In case the specified value is higher than the allowed limit, the collection limit will be used.

If avoided, the collection will determine the page size itself.

Required range: x >= 1
Example:

5

Response

Successfully retrieved a list of burn fee calculations.

​
data
object[]