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>'import requests
url = "https://pria.praxislxp.com/api/user/credit-cap-status"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://pria.praxislxp.com/api/user/credit-cap-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/user/credit-cap-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/user/credit-cap-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pria.praxislxp.com/api/user/credit-cap-status")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/credit-cap-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
}
}User
Credit-cap gauges and block state for the caller's current institution.
Returns the caller’s usage against any configured credit caps for their
current institution (and its parent account). capsEnabled is false when
caps are off or the user has no capped account; in that case the gauges
carry null caps. Reuses the same evaluator as server-side enforcement, so
the UI and the hard block agree exactly.
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>'import requests
url = "https://pria.praxislxp.com/api/user/credit-cap-status"
headers = {"x-access-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};
fetch('https://pria.praxislxp.com/api/user/credit-cap-status', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://pria.praxislxp.com/api/user/credit-cap-status",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-access-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://pria.praxislxp.com/api/user/credit-cap-status"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-access-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://pria.praxislxp.com/api/user/credit-cap-status")
.header("x-access-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/user/credit-cap-status")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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
JWT token passed in x-access-token header
Response
200 - application/json
Cap status for the caller.
Available options:
h24, institution, account, null Which tier currently owns the caps for this user's institution.
Available options:
account, institution, none Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I