Fetch Credit Stats
1 min
GET
https://api.nue.io/customers/{customerId}/credit-stats
Path Parameters
- customerIdstringrequiredDescription
Query Parameters
- accountPoolIdsstringrequiredDescription
Responses
200
- objectExample
{ "status": "SUCCESS", "data": { "accountCreditPoolStats": { "474935a8-16cc-46a6-927d-74c962cf460f": { "accountBalance": 240000, "activeCredits": 240000, "canceledCredits": 0, "committed": true, "consumedCredits": 0, "creditBackCredits": 0, "creditPool": [ "Default Committed Credit Pool" ], "creditType": "Cash", "creditTypeLabel": "Cash", "currencyIsoCode": "USD", "expiredCredits": 0, "isCash": true, "pendingCredits": 0, "totalBalance": 240000, "totalGrantCredits": 240000 } }, "summary": { "accountBalance": 240000, "creditPool": [ "Default Committed Credit Pool" ], "totalGrantCredits": 240000, "expiredCredits": 0, "consumedCredits": 0, "canceledCredits": 0, "creditBackCredits": 0, "activeCredits": 240000, "pendingCredits": 0, "totalBalance": 240000 } }, "warnings": [] }- statusstring<SUCCESS>AllowedSUCCESS
- dataobject
- accountCreditPoolStatsmap<string, object>Description
- summaryobjectDescription
- accountBalancenumber
- creditPoolstring[]
- totalGrantCreditsnumber
- expiredCreditsnumber
- consumedCreditsnumber
- canceledCreditsnumber
- creditBackCreditsnumber
- activeCreditsnumber
- pendingCreditsnumber
- totalBalancenumber
- warningsobject[]
- codestringDescription
- messagestringDescription
207
- object
- statusstring<PARTIAL_SUCCESS>AllowedPARTIAL_SUCCESS
- datamap<string, string>Description
- accountBalancenumber
- creditPoolstring[]
- totalGrantCreditsnumber
- expiredCreditsnumber
- consumedCreditsnumber
- canceledCreditsnumber
- creditBackCreditsnumber
- activeCreditsnumber
- pendingCreditsnumber
- isCashboolean
- creditTypestring
- creditTypeLabelstring
- currencyIsoCodestring
- committedboolean
- warningsobject[]
- codestring
- messagestring
400
- ErrorResponse
- statusstring<FAILURE>requiredDescriptionAllowedFAILURE
- errorTypestring<NOT_FOUND | INVALID_PARAMETER | MISSING_PARAMETER | INVALID_ARGUMENT | AUTHENTICATION_ERROR>DescriptionAllowedNOT_FOUNDINVALID_PARAMETERMISSING_PARAMETERINVALID_ARGUMENTAUTHENTICATION_ERROR
- errorCodestring<MISSING_DETAILS_FETCH_PARAMETER | MISSING_FETCH_PARAMETER | INVALID_CUSTOMER_IDS_FORMAT | INVALID_PARAMETER_COMBINATION | ORDER_UNKNOWN_FIELD | CUSTOMER_NOT_FOUND | MISSING_AUTH_METHOD | INSUFFICIENT_PERMISSIONS | INVALID_JSON>DescriptionAllowedMISSING_DETAILS_FETCH_PARAMETERMISSING_FETCH_PARAMETERINVALID_CUSTOMER_IDS_FORMATINVALID_PARAMETER_COMBINATIONORDER_UNKNOWN_FIELDCUSTOMER_NOT_FOUNDMISSING_AUTH_METHODINSUFFICIENT_PERMISSIONSINVALID_JSON
- messagestringrequiredDescription
401
- UnauthorizedErrorDescription
- statusDescription
- errorstringDescription
- errorCodestringDescription
- errorTypestringDescription
- messagestringDescription
404
- NotFoundErrorDescription
- statusintegerDescription
- errorstringDescription
- messagestringDescription
curl
curl --request GET \
--url 'https://api.nue.io/customers/{customerId}/credit-stats?accountPoolIds=string' \
--header 'accept: application/json'javascript
var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.nue.io/customers/{customerId}/credit-stats?accountPoolIds=string", requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.nue.io/customers/{customerId}/credit-stats?accountPoolIds=string")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
response = https.request(request)
puts response.read_body
python
import requests
import json
url = "https://api.nue.io/customers/{customerId}/credit-stats?accountPoolIds=string"
payload = {}
headers = {
'accept': 'application/json',
'content-type': 'application/json'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
200
// Successfully retrieved credit statistics
{
"status": "",
"data": {
"accountCreditPoolStats": "",
"summary": {
"accountBalance": 0,
"creditPool": [
""
],
"totalGrantCredits": 0,
"expiredCredits": 0,
"consumedCredits": 0,
"canceledCredits": 0,
"creditBackCredits": 0,
"activeCredits": 0,
"pendingCredits": 0,
"totalBalance": 0
}
},
"warnings": [
{
"code": "",
"message": ""
}
]
}207
// Partial Success - Some pools were retrieved, some failed
{
"status": "",
"data": "",
"warnings": [
{
"code": "",
"message": ""
}
]
}400
// Bad Request - Missing or invalid accountPoolIds parameter
{
"status": "",
"errorType": "",
"errorCode": "",
"message": ""
}401
// Unauthorized - Authentication information is missing or invalid
{
"status": "",
"error": "",
"errorCode": "",
"errorType": "",
"message": ""
}404
// Not Found - Customer or all pools not found
{
"status": 0,
"error": "",
"message": ""
}