Payment requests

In the billing flow: After a weekly invoice is generated, a payment request records the amount due for that billing week. When payment is collected, a transaction settles against the request. Detail responses include wallet balance, arrears, and invoice references.

What it does: Issues amounts due for each billing week and tracks collection from draft through payment complete.

Why it matters: Gives financiers clear visibility into what was billed, what is outstanding, and collection status without manual follow-up.

Technical reference — Read-only payment request endpoints (/payg/lms/payment-requests).

The payment request model

Name
id
Type
integer
Description
Payment request identifier.
Name
loanName
Type
string
Description
Associated loan / contract name.
Name
start_date
Type
string
Description
Billing week start.
Name
end_date
Type
string
Description
Billing week end.
Name
status
Type
object
Description
Status code and label.
Name
currency
Type
string
Description
Billing currency.
Name
totalAmountIncMaintenanceFee
Type
string
Description
Total amount including maintenance fees.

Status values

Status	Meaning
`DRAFT`	Created, not yet sent
`SENT_TO_PAYMENT_SERVICE`	Dispatched for collection
`PAYMENT_COMPLETE`	Paid in full
`PAYMENT_FAILED`	Collection failed
`PENDING`	Awaiting confirmation

GET/payg/lms/payment-requests

List payment requests

Paginated list of payment requests. Use date filters for weekly reporting windows.

Query parameters

Name
page
Type
integer
Description
Page number.
Name
limit
Type
integer
Description
Page size.
Name
search
Type
string
Description
Search term.
Name
currency
Type
string
Description
Filter by loan currency.
Name
status
Type
string
Description
Status name (see table above).
Name
funding_source
Type
string
Description
Funding program filter.
Name
start_date_gte
Type
string
Description
Billing week start on or after (ISO date).
Name
start_date_lte
Type
string
Description
Billing week start on or before.
Name
end_date_gte
Type
string
Description
Billing week end on or after.
Name
end_date_lte
Type
string
Description
Billing week end on or before.
Name
ordering
Type
string
Description
Sort field (default -created_at).

Request

GET

/payg/lms/payment-requests

curl -G https://api.hellotractor.com/payg/lms/payment-requests \
  -H "Authorization: Bearer {your_api_key}" \
  -d start_date_gte=2025-05-19 \
  -d end_date_lte=2025-05-25 \
  -d status=PAYMENT_COMPLETE

Response (redacted)

{
  "count": 10,
  "results": [
    {
      "id": 5001,
      "loanName": "Contract ***",
      "start_date": "2025-05-19",
      "end_date": "2025-05-25",
      "status": { "label": "PAYMENT_COMPLETE" },
      "currency": "NGN",
      "totalAmountIncMaintenanceFee": "125000.00"
    }
  ]
}

Checking access…

GET/payg/lms/payment-requests/:id

Retrieve a payment request

cURL

curl https://api.hellotractor.com/payg/lms/payment-requests/5001 \
  -H "Authorization: Bearer {your_api_key}"

Get started

Tell us what you are building and we will align on API access and telemetry integration.