Skip to main content
PropertyValue
Dataset codeD02
Section codeS1 — Customers & Accounts
Endpoint path/exports/S1/D02
Cursor fieldupdated_at
Page size1–1000 (default 500)
AvailabilityAvailable (v1.2)
PaginationDirect (constant page size)
Each row is one account a borrower holds with the lender — a loan, credit-card-like line, or BNPL line. It includes financial balances, status, due/submission dates, and the lender-provided reference IDs that let you join back to your warehouse.

​
Fields

FieldTypeDescriptionNotes
public_idstringStable per-row identifier (string-cast Mongo _id).Use as the warehouse primary key
account_reference_idstringLender-provided account reference.
customer_reference_idstringLender-provided customer reference.
reference_idstringGeneric reference ID.
total_amountnumberTotal contractual amount.Minor units (fils/cents)
balance_amountnumberTotal outstanding balance.Minor units
actual_balance_amountnumberRealised balance after adjustments.Minor units
paid_amountnumberAmount paid to date.Minor units
balance_principal_amountnumberPrincipal still owed.Minor units
balance_interestnumberInterest still owed.Minor units
balance_feenumberFees still owed.Minor units
minimum_due_amountnumberMinimum payable now.Minor units
currencystringISO 4217 currency code (SAR, AED, …).
submitted_datestringWhen the account was opened/onboarded.DD/MM/YYYY — stored as-is, not ISO-8601
due_datestringCurrent due date.DD/MM/YYYY — stored as-is, not ISO-8601
delinquent_days_on_submissionnumberDays past due at submission.
loan_typestringHuman-readable loan/account type (e.g. BNPL).Resolved from the loan_types constant; unmapped codes fall back to the raw integer. See legend
statusstringHuman-readable account status (e.g. IN_COLLECTION).Resolved from the borrower_account_status constant; unmapped codes fall back to the raw integer. See legend
merchant_namestringOriginating merchant, if any.
lender_display_namestringLender display name.
created_atstringRecord creation timestamp (ISO-8601).
updated_atstringLast-modified timestamp (ISO-8601).Cursor field

​
Sample row

{
  "public_id": "6981c84a1f30b27e90c5512d",
  "account_reference_id": "ACC-2026-44817",
  "customer_reference_id": "CUST-2026-00482",
  "reference_id": "REF-99213",
  "total_amount": 1500000,
  "balance_amount": 920000,
  "actual_balance_amount": 920000,
  "paid_amount": 580000,
  "balance_principal_amount": 800000,
  "balance_interest": 100000,
  "balance_fee": 20000,
  "minimum_due_amount": 75000,
  "currency": "SAR",
  "submitted_date": "22/02/2026",
  "due_date": "10/01/2026",
  "delinquent_days_on_submission": 0,
  "loan_type": "BNPL",
  "status": "IN_COLLECTION",
  "merchant_name": "Tamara Marketplace",
  "lender_display_name": "Tamara",
  "created_at": "2026-02-01T09:15:33.000Z",
  "updated_at": "2026-05-28T11:42:08.000Z"
}
Date formats differ by field. submitted_date and due_date are returned exactly as stored — DD/MM/YYYY strings (e.g. 22/02/2026), not ISO-8601. The system timestamps created_at / updated_at are ISO-8601. Parse them with separate format handling. See Date & time formats.

​
Field value reference

loan_type and status are returned as human-readable labels. The service resolves the underlying numeric code to its label; if a code has no mapping, the raw integer is returned instead.
Label
CREDIT_CARD
LEASE
PERSONAL_LOAN
BNPL
CAR_RENTAL
SUBSCRIPTION
Charge Back
SALARY_ADVANCE_LOAN
OverDraft

​
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

  • Balance and DPD (days-past-due) trail per account.
  • Portfolio summarisation and segmentation.
  • Due-date sync into collections workflows.

Need Help?

Our support team is available Monday-Friday, 9 AM - 6 PM GST. Reach out at support@cleargrid.co or visit our help center.