On Demand Balance Checks
Retrieve Balance Results
Retrieve processed balances for a batch
GET
Retrieve processed balances for a batch
Retrieve Balance Results
Retrieve processed balance results for a previously submitted batch. This endpoint supports pagination to handle large result sets efficiently.Balance Status Codes
Thebalance_status_code field indicates the outcome of the balance check:
A
null balance with a non-zero status code indicates that the balance check failed for the specified reason.Pagination
For batches with more results than the specified limit, use pagination:Best Practices
- Poll periodically - If processing is not complete, poll every 30-60 seconds
- Handle pagination - Always check
has_moreand usenext_page_tokenfor complete results - Process status codes - Check
balance_status_codeto understand failed balance checks - Implement retries - Add exponential backoff for transient errors (5xx status codes)
Authorizations
Authentication to the API is performed via Bearer Token Authentication. Provide your API key as the bearer token in the Authorization header.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Query Parameters
Response
Balances retrieved successfully
