Skip to navigation

Top-up chargeback report

The share of top-up payments that a payment provider later charged back, and the credits still at risk. The rate is top-up payments with a provider chargeback over all top-up payments in the range. Credits at risk are the unspent part of the grants those top-ups created. Runledger doesn’t claw credits back by itself: this is a number to watch, and a notification rule with event topup_chargeback.threshold_exceeded tells people when the rate passes a threshold you set. No threshold applies until you set one.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Query parameters

fromdatetimeRequired
Start of the range, inclusive.
todatetimeRequired
End of the range, exclusive.
group_byenumOptionalDefaults to account

Split by payment provider, or one row for the whole account. Default account.

Allowed values:
payment_providerstringOptional

Only top-ups taken at this provider.

Response

The report.
object"topup_chargeback_report"
fromdatetime
todatetime
group_byenum
Allowed values:
datalist of objects
generated_atdatetime
livemodeboolean

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error