Financial services APIs
Technical reference for lending and repayment on ST2. Hello Tractor provides complete lending infrastructure for mechanization: automated underwriting, disbursement, and repayments; machine usage monitoring; and portfolio visibility for lenders.
Overview
Collaborators integrate read APIs to sync loan status, billing, and payments with bank and program systems. Payments run through Hello Tractor’s payment platform for automated repayments, rentals, operator fees, and unified wallets.
Base URL
https://api.hellotractor.com/payg/lms/
Authenticate with your API key from the partner dashboard. 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
Billing periods are generated from work completed during the week, linked to loan contracts, 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 loan balance, billing period, 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):
| Field | Description |
|---|---|
customer_name | Payer / borrower name |
amount_paid | Amount received |
transaction_code | Partner reference |
initiated_at | Initiation timestamp (ISO 8601) |
completed_at | Completion timestamp (ISO 8601) |
Program reporting fields
For mechanization programs, loan contract responses include fields suitable for funding partner reporting:
| Report field | API field |
|---|---|
| Customer Name | loaner |
| Funding Source | funding_source |
| Loan ID | loan_id |
| Tractor ID | tractor_id |
| Operator Name | name (contract name) |
| Contract Status | status |
| Equipment Cost | equipment_cost |
| Downpayment Amount | principal_amount |
| Total Repayment Amount | total_repayment_amount |
| Remaining Contract Value | remaining_contract_value |
| Currency | currency |
| Loan Start Date | loan_start_date |
| Loan End Date | loan_end_date |
| USD Snapshot | usd_snapshot |
| Repayment per Hectare | repayment_per_hectare |
Contract status values: CURRENT, DELINQUENT, CLOSED.
Access tiers
| Tier | Who | What you see |
|---|---|---|
| Public docs | Anyone | Endpoint summaries, field mapping, redacted examples |
| Signed in | Dashboard users | Full examples, filters, status detail |
Checking access…
Available endpoints
| Resource | Methods (collaborator) | Documentation |
|---|---|---|
| Loans & contracts | GET list, GET detail | Loans & contracts |
| Billing periods | GET list, GET detail | Billing periods |
| Invoices | GET list, GET detail | Invoices |
| Payments & ledger | GET list | Payments & ledger |
Get started
New collaborators request access first; approved teams sign in and register integrations.