™2 min read
What it does
This endpoint sits on the public /public/v1 ring — unauthenticated, anonymous and open to any caller. There is no API key and no OAuth token on this ring; the trust boundary is enforced by rate limiting, strict input validation and a server-fixed response shape rather than by a credential.
The endpoint exposes the canonical loyalty ladder so any surface — the marketing site, a partner comparison page, a mobile app — can render the tiers identically. It returns one figure per tier: the arrangement-fee discount percentage a customer earns at that tier, read verbatim from the hub’s loyalty config in percent units (a value of 0.5 means 0.5%).
Response shape
Tiers are returned in ladder order, Bronze first, Platinum last.
{
"tiers": [
{
"key": "bronze",
"name": "Bronze",
"is_top_tier": false,
"thresholds": {
"min_on_time_rate": 0.0,
"min_months_active": 0
},
"benefit": {
"arrangement_fee_discount_pct": 0.0
}
},
{
"key": "platinum",
"name": "Platinum",
"is_top_tier": true,
"thresholds": {
"min_on_time_rate": 0.98,
"min_months_active": 24
},
"benefit": {
"arrangement_fee_discount_pct": 0.5
}
}
],
"cooldown_days": 365,
"generated": "2026-07-04T12:00:00Z"
}arrangement_fee_discount_pct is in percent units. cooldown_days is the tier-expiry window. generated is the request-time UTC timestamp — treat it as the freshness marker for your cache.
Caching
The tier config changes rarely, so the endpoint is safe to cache for around five minutes. A short CDN or client cache removes almost all load without risking a stale ladder. There is no PII in the response, so caching it publicly is fine.
Frequently asked questions
What units is the discount in?
Percent units. A value of 0.5 means a 0.5% discount on the arrangement fee — render it with a percent sign, do not multiply by 100 again.
Does this return a specific customer’s tier?
No. It returns the tier vocabulary only — the definitions and thresholds — with no PII. A customer’s own current tier is served on an authenticated internal endpoint, not here.
How often does the ladder change?
Rarely. That is why a five-minute cache is recommended: it cuts load dramatically and the risk of showing a stale tier for a few minutes is negligible.
Funding for UK limited companies
Credicorp lends to your company, not to you personally — short-term working capital with no personal guarantee. See what your business could access.