Monitoring
Create Monitoring Schedule
Create a recurring scheduled balance request for authorizers
POST
Create a scheduled balance request
Create Monitoring Schedule
Create a recurring scheduled balance request for a set of authorizers. The schedule will automatically run balance checks at the specified interval and send results to your webhook.Scheduling Options
Useinterval_days together with time_of_day to run balance checks every N days at a specific time.
Key Information
Schedule Name (Required): Provide a
name to identify your schedule. Names must be unique (max 255 characters).Start: The first job runs at the
time_of_day on the starts_at date, after which jobs will run on the provided interval (format: YYYY-MM-DD).
If none is provided, the first job will run at the next time_of_day.Expiration: A final job runs at the scheduled
time_of_day on the expires_at date, after which no more jobs will run (format: YYYY-MM-DD, default 30 days from creation, max 365 days)Webhook: Results are delivered to your specified webhook URL after each run
Threshold Monitoring
Set balance thresholds to receive webhook notifications when an account’s balance meets or exceeds a specified amount.When any threshold is configured (request-level or authorizer-level), the
webhook field is required.Payment Information Types
You must provide either bank account information or debit card information for each authorizer:Bank Account Information
- Required:
account_number,routing_number, and eitherssnorein - Optional:
debit_card_last_four, the last 4 digits of the authorizer’s debit card. Required for some institutions, such as Chime; a request with a row for one of them that lacks it is rejected with400 Bad Request, naming that authorizer.
Debit Card Information
- Required:
debit_card_number, and eitherssnorein - Optional:
expiration_month,expiration_year,routing_number(if linked to a bank account)
Optional Fields
threshold_amount: Balance threshold in dollars for this authorizer (see Threshold Monitoring)
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.
Body
application/json
List of authorizers to include in the scheduled balance checks.
Payment details using a bank account. Requires account number, routing number, and either SSN or EIN.
- Bank Account Information
- Debit Card Information
Response
Schedule created successfully
