Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.rightfoot.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Rightfoot API

The Rightfoot API provides balance intelligence for payment and collections workflows. It allows you to check account balances on demand, set up recurring monitoring, and receive event-driven signals when balance check runs complete. Rightfoot helps you determine when to attempt payments and/or how to take action, while integrating cleanly with your existing systems.

​
API Overview

The Rightfoot API enables you to:
  • Run on-demand balance checks for individual or batched authorizers
  • Retrieve balance check results
  • Create recurring monitoring schedules to systematically observe account balances over time
  • Define balance thresholds and receive alerts when accounts have sufficient funds
  • Access historical balance requests at the authorizer level to support monitoring and analysis
  • Receive webhooks when balance check runs complete or threshold conditions are met
The API supports both one-time execution and recurring monitoring.

​
Execution Models

Rightfoot supports two primary execution models:

​
On-Demand Balance Checks

Use on-demand endpoints to submit balance checks immediately and retrieve results once processing completes. This is ideal for ad-hoc checks, batch uploads, or manual workflows.

​
Monitoring & Threshold Alerts

Use monitoring endpoints to create schedules that run balance checks automatically on a recurring cadence. Thresholds can be applied to monitoring so your systems are notified when an account’s balance meets or exceeds a defined amount. This enables proactive, event-driven decisioning without requiring constant polling.

​
Events & Webhooks

Rightfoot emits webhooks when:
  • A balance check run completes
  • A threshold condition is triggered for a monitored account
These events allow downstream systems to fetch results and take action immediately.

​
Base URL

All API requests should be made to: 
https://api.rightfoot.com

​
Authentication

The Rightfoot API uses Bearer token authentication. Include your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY

​
Rate Limits

To ensure fair usage and system stability:
  • Maximum batch size: 1,000 authorizers per request
  • Requests are cached for 24 hours based on request body hash

​
Support

For questions or assistance:

​
Getting Started

Authentication

Set up your API key and make your first request

Quickstart Guide

Submit your first balance check batch