Skip to main content
GET
/
v1
/
monitoring
/
authorizers
/
{id}
/
history
Get authorizer balance history
curl --request GET \
  --url https://api.rightfoot.com/v1/monitoring/authorizers/{id}/history \
  --header 'Authorization: Bearer <token>'
{
  "authorizer_unique_id": "1a2b3c4d",
  "total_count": 250,
  "history": [
    {
      "run_at": "2024-12-12T02:30:00Z",
      "batch_id": "BATCH-98765",
      "balance_amount": 1523.47,
      "status": "success",
      "error_message": null
    },
    {
      "run_at": "2024-12-05T02:30:00Z",
      "batch_id": "BATCH-98764",
      "balance_amount": 892.31,
      "status": "success",
      "error_message": null
    },
    {
      "run_at": "2024-11-28T02:30:00Z",
      "batch_id": "BATCH-98763",
      "balance_amount": null,
      "status": "failed",
      "error_message": "Institution not supported"
    }
  ],
  "next_page_token": "eyJjdXJzb3IiOiA1MDAsICJ0b3RhbF9yb3dzX3JldHVybmVkIjogMjB9",
  "has_more": true
}

​
Retrieve Authorizer Balance History

Retrieve the balance check history for a specific authorizer. Returns a list of recent balance results in reverse chronological order (most recent first).

​
Use Cases

  • Review historical balance data for an authorizer
  • Debug failed balance checks
  • Analyze balance trends over time

​
Response Fields

FieldDescription
authorizer_unique_idThe authorizer identifier
total_countTotal number of history records for this authorizer
historyArray of history entries (see below)
next_page_tokenToken for fetching the next page (null if no more results)
has_moreWhether more results are available
Each history entry contains:
FieldDescription
run_atWhen the balance check was performed
batch_idThe associated batch request ID
balance_amountThe balance retrieved (null if failed)
statussuccess or failed
error_messageError details if the check failed

​
Pagination

Use the limit query parameter to control how many results are returned:
  • Default: 10 entries
  • Maximum: 100 entries
To fetch additional pages, pass the next_page_token from a previous response as the next_page_token query parameter. Continue fetching until has_more is false or next_page_token is null.

Authorizations

​
Authorization
string
header
required

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.

Path Parameters

​
id
string
required

The authorizer_unique_id to retrieve history for.

Query Parameters

​
limit
integer
default:10

The maximum number of history entries to return. Default is 10, maximum is 100.

Required range: 1 <= x <= 100
​
next_page_token
string

A cursor token for pagination. Pass the next_page_token from a previous response to fetch the next page of results.

Response

Authorizer history retrieved successfully

​
authorizer_unique_id
string
required

The unique identifier for the authorizer.

​
total_count
integer
required

Total number of history records for this authorizer.

​
history
object[]
required

List of balance check history entries in reverse chronological order.

​
has_more
boolean
required

Indicates whether more results are available beyond this page.

​
next_page_token
string | null

Token for fetching the next page of results. Null if no more results.