Entitlements
The per-product set a partner is enabled for, and how it's enforced fail-closed before any product is contacted.
An entitlement is permission to reach one published product. Your entitlement set is the products you're enabled for, held against your partner identity and enforced at the gateway.
The product is the unit
Entitlement is per published product, not per underlying primitive. One primitive
may publish several independently-entitled products — for example, Bankrail publishes
both bankrail-gateway and bankrail-fbo. A partner can be entitled to one without
the other.
Fail-closed, before contact
Entitlement is enforced before any product is contacted. A call to a product you are not entitled to is denied at the gateway, and the product is never touched. An absent or unrecognised entitlement denies.
Reading your entitlements
GET /entitlements— your current entitlement set.GET /entitlements/history— the administrative history of changes: who granted or removed an entitlement, when, and why. The current state is at/entitlements; the history of changes is here.
Self-serve vs approval-required
Some products enable on request (self-serve). Others — the payment rails — are recorded as a pending request and become live only after an operator approves them. See Onboarding for where this happens in the journey.
Next
- Passthrough — reaching an entitled product.
- Errors — including
entitlement_denied.