Skip to main content
GET
Credit-cap gauges and block state for the caller's current institution.

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Response

200 - application/json

Cap status for the caller.

success
boolean
capsEnabled
boolean
blocked
boolean
capType
enum<string> | null
Available options:
h24,
institution,
account,
null
source
enum<string>

Which tier currently owns the caps for this user's institution.

Available options:
account,
institution,
none
perInstitution
object
h24
object
accountWide
object