Financial services APIs

Read APIs for Hello Tractor’s pay-as-you-go (PAYG) financing on ST2 — sync contracts, weekly billing, collections, and ledger activity with your bank or program systems.

Overview

Collaborators integrate read APIs under /payg/lms/ to pull loan status, invoices, payment requests, and transactions. Payments run through Hello Tractor’s payment platform for automated repayments and wallet settlement.

What is PAYG?

PAYG is Hello Tractor’s usage-based tractor financing model. Borrowers repay from actual field work — serviced hectares or acres measured from tractor telemetry — rather than fixed installments.

Each financed tractor is tied to a contract with a repayment rate per unit of work. As the machine operates, billing reflects real usage, giving lenders and programs visibility into portfolio performance without manual reconciliation.

How billing works

Billing follows a weekly cycle (Friday through Thursday). The end-to-end flow:

Contract + account + tractor
        ↓
Tractor telemetry (work done)
        ↓
Weekly invoice
        ↓
Payment request
        ↓
Transaction (payment collected)
        ↓
Account balance updated

1. Setup — A contract is created with financial terms (repayment rate, currency, tractor, customer, funding source). The customer has a wallet account tied to their contract(s).
2. Field work — Serviced area is measured from tractor activity. Billing is based on actual work done, not covenant targets alone.
3. Weekly invoice — Each billing week, an invoice is generated: quantity (hectares, acres, days, or kilometres per contract) × rate, plus optional maintenance fees. Output includes total, maintenance component, paid flag, and PDF.
4. Payment request — A payment request is created for the contract and billing week. It links to the invoice, includes line items and wallet/arrears context, and moves through a status lifecycle from draft to payment complete.
5. Transaction — When payment is received (online adapter, offline, or wallet), a transaction records the settlement against the payment request and updates the account balance.

Tractor identifiers on contracts reference assets tracked in the broader ST2 platform. For tractor and telemetry APIs, see Marketplace and Telemetry push.

Core concepts

Base URL

https://api.hellotractor.com/payg/lms/

Authenticate with your API key provided during collaboration onboarding. See Authentication.

Integration patterns

These flows describe how funding institutions and programs work with Hello Tractor — not every step is a public HTTP endpoint today.

Weekly billing

Invoices are generated from work completed during each billing week. A payment request is created for that week and tracked from draft through payment complete.

Payment sync

When a funding partner confirms a payment (for example to a dedicated program account), their system can notify Hello Tractor. The payment platform updates the contract balance, payment request, and transaction history automatically.

Repayment tracking

Payment status, outstanding balances, and repayment history stay current as confirmed payments are applied.

Planned collaborator webhook (payment confirmation)

Partners may send structured payment reports to Hello Tractor (exact URL and authentication provided during onboarding):

Program reporting fields

For mechanization programs, contract responses include fields suitable for funding partner reporting:

Contract status values: CURRENT, DELINQUENT, CLOSED.

Access tiers

Checking access…

Available endpoints