Skip to main content
PropertyValue
Dataset codeD07
Section codeS2 — Payments & Settlements
Endpoint path/exports/S2/D07
Cursor fieldupdated_at
Page size1–1000 (default 500)
AvailabilityPhase 1 — generally available
PaginationDirect (constant page size)
Each row is one payment event we processed against a customer’s account. It includes the amount, the payment type, the status, and whether we have settled it with you yet.

​
Fields

FieldTypeDescriptionNotes
public_idstringStable public identifier for the payment.
amountintegerPayment amount in minor units (fils/cents).75000 = SAR 750.00
settled_amountintegerAmount settled to the lender, in minor units.0 until settled
payment_typestringType of payment (e.g. PAID_TO_LENDER).
payment_statusstringProcessing status (e.g. SUCCESS, PENDING, FAILED).
is_settledbooleanWhether the payment has been settled to the lender.
paid_before_submissionbooleanWhether the payment was made before the account was submitted to ClearGrid.
paid_datestring | nullWhen the payment was made (ISO-8601).
failure_reasonstring | nullReason for failure when payment_status is FAILED.null otherwise
created_atstringRow creation timestamp (ISO-8601).
updated_atstringLast-modified timestamp (ISO-8601).Cursor field

​
Sample row

{
  "public_id": "b1f4c2e0-9a73-4d21-8c54-7e2a1d9b0f31",
  "amount": 75000,
  "settled_amount": 75000,
  "payment_type": "PAID_TO_LENDER",
  "payment_status": "SUCCESS",
  "is_settled": true,
  "paid_before_submission": false,
  "paid_date": "2026-05-18T08:12:44.000Z",
  "failure_reason": null,
  "created_at": "2026-05-18T08:12:45.221Z",
  "updated_at": "2026-05-18T08:30:02.108Z"
}

​
Pagination characteristics

This dataset is direct — it is filtered to your tenant by lender_id on the collection itself, so each page returns a constant number of rows until the last page. rows.length < limit reliably means you have reached the end.

​
Use cases

  • Daily reconciliation against payments settled to the lender.
  • First-payment-after-PTP attribution.
  • Failure-rate monitoring by payment_type and failure_reason.