--- title: Fetch Account Credit Pools slug: fetch-account-credit-pools docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "20mhyDuHLKVq9eF5wpIV9", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.nue.io/customers/{customerId}/account-credit-pools", "servers": [ { "url": "https://api.nue.io/customers/{customerId}/account-credit-pools", "description": "**Production Environment** - Live production server for all customer-facing operations. Use this for production integrations with real customer data and transactions." }, { "url": "https://api.sandbox.nue.io/customers/{customerId}/account-credit-pools", "description": "**Sandbox Environment** - Safe testing environment with sample data for development and integration testing. No rate limits apply. Data is reset weekly. Perfect for prototyping and QA testing." } ], "name": "Fetch Account Credit Pools", "description": "

Retrieves account credit pools for a specific customer. Account credit pools represent a customer's credit balances within specific credit pools, including balance information, status, and associated credit pool configuration.

", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "customerId", "type": "string", "description": "

The unique identifier of the customer (UUID or Salesforce ID)

" } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "accountPoolIds", "type": "string", "description": "

JSON-encoded array of specific account credit pool IDs to retrieve. Example: [\"pool-id-1\",\"pool-id-2\"]

" }, { "kind": "optional", "name": "page", "type": "integer", "description": "Page number for pagination", "default": 1, "minimum": 1 }, { "kind": "optional", "name": "limit", "type": "integer", "description": "Number of results per page", "default": 100, "minimum": 1, "maximum": 500 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "ApiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successfully retrieved account credit pools", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "example": "{\"status\":\"SUCCESS\",\"data\":[{\"balance\":240000,\"createdById\":\"ddd60c9f-e694-4760-b832-f720ebf22a53\",\"createdDate\":\"2026-01-10T19:12:10.465Z\",\"creditPool\":{\"committed\":true,\"createdById\":\"ddd60c9f-e694-4760-b832-f720ebf22a53\",\"createdDate\":\"2026-01-08T02:10:10.259Z\",\"creditTypeId\":\"6984e433-0151-4351-b9e2-b7f557672707\",\"id\":\"d3496002-9430-4f8d-9e67-6c6ac8793bd7\",\"isDefault\":false,\"lastModifiedById\":\"ddd60c9f-e694-4760-b832-f720ebf22a53\",\"lastModifiedDate\":\"2026-01-08T02:10:10.259Z\",\"name\":\"Default Committed Credit Pool\"},\"creditPoolId\":\"d3496002-9430-4f8d-9e67-6c6ac8793bd7\",\"creditTypeId\":\"6984e433-0151-4351-b9e2-b7f557672707\",\"customerId\":\"001RK00001jt2i1YAA\",\"id\":\"474935a8-16cc-46a6-927d-74c962cf460f\",\"lastModifiedById\":\"ddd60c9f-e694-4760-b832-f720ebf22a53\",\"lastModifiedDate\":\"2026-01-10T19:13:30.027Z\",\"name\":\"Default Committed Credit Pool\",\"status\":\"Active\"}],\"warnings\":[],\"pagination\":{\"page\":1,\"limit\":100,\"total\":1,\"totalPages\":1,\"hasNext\":false,\"hasPrevious\":false}}", "description": "", "schema": [ { "name": "status", "kind": "optional", "type": "string", "description": "", "enum": [ "SUCCESS" ] }, { "name": "data", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "Unique identifier for the account credit pool" }, { "name": "name", "kind": "optional", "type": "string", "description": "Display name of the account credit pool" }, { "name": "balance", "kind": "optional", "type": "number", "description": "Current credit balance in the pool" }, { "name": "status", "kind": "optional", "type": "string", "description": "

Status of the pool (e.g., Active)

" }, { "name": "customerId", "kind": "optional", "type": "string", "description": "ID of the customer who owns this pool" }, { "name": "creditPoolId", "kind": "optional", "type": "string", "description": "ID of the associated credit pool configuration" }, { "name": "creditTypeId", "kind": "optional", "type": "string", "description": "ID of the credit type" }, { "name": "creditPool", "kind": "optional", "type": "object", "description": "Nested credit pool configuration details", "example": "", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "" }, { "name": "name", "kind": "optional", "type": "string", "description": "" }, { "name": "committed", "kind": "optional", "type": "boolean", "description": "

Whether credits are committed/prepaid

" }, { "name": "isDefault", "kind": "optional", "type": "boolean", "description": "" }, { "name": "creditTypeId", "kind": "optional", "type": "string", "description": "" }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" } ] }, { "name": "createdDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "createdById", "kind": "optional", "type": "string", "description": "" }, { "name": "lastModifiedDate", "kind": "optional", "type": "string", "description": "", "format": "date-time" }, { "name": "lastModifiedById", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "warnings", "kind": "optional", "type": "array", "description": "", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "Warning code." }, { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable warning message.

" } ] }, { "name": "pagination", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [ { "name": "page", "kind": "optional", "type": "integer", "description": "" }, { "name": "limit", "kind": "optional", "type": "integer", "description": "" }, { "name": "total", "kind": "optional", "type": "integer", "description": "" }, { "name": "totalPages", "kind": "optional", "type": "integer", "description": "" }, { "name": "hasNext", "kind": "optional", "type": "boolean", "description": "" }, { "name": "hasPrevious", "kind": "optional", "type": "boolean", "description": "" } ] } ], "isExpanded": true } ] }, { "statusCode": "401", "description": "

Unauthorized - Authentication information is missing or invalid

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

Authentication failed — returned with HTTP 401. Two variants occur: a missing key is rejected by the gateway with {status: \"FAILURE\", errorCode, errorType, message}; an invalid key is rejected by the service with {status: 401, error, message}.

", "customType": "UnauthorizedError", "schema": [ { "name": "status", "kind": "optional", "type": "", "description": "

HTTP status code (e.g. 401) or the string \"FAILURE\" for gateway-level rejections.

" }, { "name": "error", "kind": "optional", "type": "string", "description": "

Error reason phrase (invalid-key variant).

" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "

Machine-readable error code, e.g. MISSING_AUTH_METHOD (missing-key variant).

" }, { "name": "errorType", "kind": "optional", "type": "string", "description": "

Error category, e.g. AUTHENTICATION_ERROR (missing-key variant).

" }, { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable error message.

" } ], "modelRef": "#/components/schemas/UnauthorizedError", "isExpanded": true } ] }, { "statusCode": "404", "description": "

Not Found - Customer was not found

", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

The requested resource was not found — returned with HTTP 404.

", "customType": "NotFoundError", "schema": [ { "name": "status", "kind": "optional", "type": "integer", "description": "HTTP status code." }, { "name": "error", "kind": "optional", "type": "string", "description": "Error reason phrase." }, { "name": "message", "kind": "optional", "type": "string", "description": "

Human-readable error message.

" } ], "modelRef": "#/components/schemas/NotFoundError", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "9xDJKfMrTyrgkX9Ug5LFB", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.nue.io/customers/{customerId}/account-credit-pools?page=1&limit=100' \\\n --header 'accept: application/json'" }, { "id": "qI25iXf9b5BJki9jSMYEL", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/customers/{customerId}/account-credit-pools?page=1&limit=100\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "AYQvrZaIcNK8XJmAXmj23", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/customers/{customerId}/account-credit-pools?page=1&limit=100\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "Nj0BxiBpcbd_jp_OMOq0o", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/customers/{customerId}/account-credit-pools?page=1&limit=100\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "9xDJKfMrTyrgkX9Ug5LFB" }, "results": { "languages": [ { "id": "U-AzgfLNcMTGfBQXwuDJd", "language": "200", "code": "// Successfully retrieved account credit pools\n{\n \"status\": \"\",\n \"data\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"balance\": 0,\n \"status\": \"\",\n \"customerId\": \"\",\n \"creditPoolId\": \"\",\n \"creditTypeId\": \"\",\n \"creditPool\": {\n \"id\": \"\",\n \"name\": \"\",\n \"committed\": false,\n \"isDefault\": false,\n \"creditTypeId\": \"\",\n \"createdDate\": \"\",\n \"lastModifiedDate\": \"\"\n },\n \"createdDate\": \"\",\n \"createdById\": \"\",\n \"lastModifiedDate\": \"\",\n \"lastModifiedById\": \"\"\n }\n ],\n \"warnings\": [\n {\n \"code\": \"\",\n \"message\": \"\"\n }\n ],\n \"pagination\": {\n \"page\": 0,\n \"limit\": 0,\n \"total\": 0,\n \"totalPages\": 0,\n \"hasNext\": false,\n \"hasPrevious\": false\n }\n}" }, { "id": "oi5wOFuUJq1DNSy58oV3A", "language": "401", "code": "// Unauthorized - Authentication information is missing or invalid\n{\n \"status\": \"\",\n \"error\": \"\",\n \"errorCode\": \"\",\n \"errorType\": \"\",\n \"message\": \"\"\n}" }, { "id": "mDDjCl1y3zD0GOehSyK2L", "language": "404", "code": "// Not Found - Customer was not found\n{\n \"status\": 0,\n \"error\": \"\",\n \"message\": \"\"\n}" } ], "selectedLanguageId": "U-AzgfLNcMTGfBQXwuDJd" } }, "children": [ { "text": "" } ] }