PaydayAPI
API reference · Cash Payback

Get the rules

GEThttps://payday.direct/api/v1/payback

Whether Cash Payback is on, its split, when rounds run, how holding is weighted, and what a terminal needs to read and launch baskets without hardcoding them.

Needs an API key in Authorization: Bearer or X-API-Key. Authentication

Responses

200OK
401Missing or invalid key
429Over the limit. Retry-After says when to try again.

Response fields

enabledboolean
rulesobject
rules.modestring
account (fees to an account) or cash_payback (fees to holders)
rules.namestring
The coin's name
rules.splitobject
rules.dex_cost_usdcnumber
rules.return_daysnumber
A reimbursement not full by then goes to holders
rules.roundsobject
rules.weightingobject
How holding is weighted
basketsobject
baskets.openboolean
baskets.typesstring[]
baskets.min_assetsinteger
baskets.max_assetsinteger
baskets.suggested_assetsinteger | array
baskets.weightsstring
baskets.locked_at_launchboolean
baskets.fundobject
baskets.paybackobject
baskets.iconsobject
Basket marks by type