API reference · Cash Payback
Get the rules
GET
https://payday.direct/api/v1/paybackWhether 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
enabledbooleanrulesobjectrules.modestringaccount (fees to an account) or cash_payback (fees to holders)rules.namestringThe coin's name
rules.splitobjectrules.dex_cost_usdcnumberrules.return_daysnumberA reimbursement not full by then goes to holders
rules.roundsobjectrules.weightingobjectHow holding is weighted
basketsobjectbaskets.openbooleanbaskets.typesstring[]baskets.min_assetsintegerbaskets.max_assetsintegerbaskets.suggested_assetsinteger | arraybaskets.weightsstringbaskets.locked_at_launchbooleanbaskets.fundobjectbaskets.paybackobjectbaskets.iconsobjectBasket marks by type