Skip to main content
PropertyValue
Dataset codeD08
Section codeS2 — Payments & Settlements
Endpoint path/exports/S2/D08
Cursor fieldupdated_at
Page size11000 (default 500)
AvailabilityPhase 1 — generally available
PaginationDirect (constant page size)
Installment payment plans agreed with the customer. Each row is one plan header; the individual installments are exposed separately in D09.

Fields

FieldTypeDescriptionNotes
public_idstringStable public identifier for the plan.
total_amountintegerTotal plan amount in minor units (fils/cents).
total_installmentsintegerNumber of installments in the plan.
statusstringPlan status.
payment_gatewaystringGateway used to collect the plan.
start_datestring | nullPlan start date (ISO-8601).
end_datestring | nullPlan end date (ISO-8601).
is_activebooleanWhether the plan is currently active.
created_atstringRow creation timestamp (ISO-8601).
updated_atstringLast-modified timestamp (ISO-8601).Cursor field

Sample row

{
  "public_id": "a7c3e9d2-1b48-4f60-9a21-5e8c0d3b6f10",
  "total_amount": 360000,
  "total_installments": 3,
  "status": "ACTIVE",
  "payment_gateway": "HYPERPAY",
  "start_date": "2026-04-01T00:00:00.000Z",
  "end_date": "2026-06-30T00:00:00.000Z",
  "is_active": true,
  "created_at": "2026-03-28T10:14:02.881Z",
  "updated_at": "2026-05-12T09:01:55.402Z"
}

Pagination characteristics

This dataset is direct — filtered to your tenant by lender_id on the collection itself, so each page returns a constant number of rows until the last page.

Use cases

  • Active vs. completed plan counts.
  • Average installments per plan.
  • Plan-status transition timing (join to D09 and D07).
Empty in current tenant rollouts — the endpoint works but returns no rows until plan data is created. The field set above is not yet verified against live data and may be refined.