Skip to main content
GET
/
api
/
user
/
credit-cap-status
Credit-cap gauges and block state for the caller's current institution.
curl --request GET \
  --url https://pria.praxislxp.com/api/user/credit-cap-status \
  --header 'x-access-token: <api-key>'
{
  "success": true,
  "capsEnabled": true,
  "blocked": true,
  "perInstitution": {
    "used": 123,
    "cap": 123
  },
  "h24": {
    "used": 123,
    "cap": 123,
    "resetAt": "2023-11-07T05:31:56Z"
  },
  "accountWide": {
    "used": 123,
    "cap": 123
  }
}

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