private/get-fee-credit-balances

POST 
/private/get-fee-credit-balances

Get fee credit balance details for the authenticated account. Fee credits are grouped by expiry date and sorted in ascending order. Values are not real-time and are updated daily at 00:00 UTC.

Request

Body

required

id int64required

Request id (echoed in response)

method stringrequired

Must be "private/get-fee-credit-balances"

api_key stringrequired

Your API key (only required for private REST)

sig stringrequired

HMAC-SHA256 signature in hex (only required for private REST)

nonce int64required

Current timestamp in milliseconds, e.g. "1771761038000".

params objectrequired

page integer

Page number (0-based).

page_size integer

Possible values: >= 1 and <= 200

Number of entries per page. Default: 200, Max: 200.

Success.

Schema

id int64

Echoed request id

method string

Method invoked

code int32

0 = success; non-zero indicates error (reason code).

result object
Present when code === 0.
fee_credits object[]required
List of fee credit entries grouped by expiry date, sorted in ascending order.
Array [
expiry_date int64required
Expiry date in epoch milliseconds (end of day 23:59 UTC)
type string
Comma-separated campaign names. Master accounts only.
distributed_amount decimal
Total distributed amount (8 decimal places). Master accounts only.
available_balance decimalrequired
Estimated available balance (8 decimal places)
details object[]
Per-campaign breakdown. Master accounts only.
Array [
type stringrequired
Campaign name
distribution_date int64required
Distribution date in epoch milliseconds (end of day 23:59 UTC)
distributed_amount decimalrequired
Amount distributed for this campaign (8 decimal places)
]
]
message string

Present when code !== 0.

original string

Present when code !== 0.