VUZDevelopers

Card installment settlement schedule (walked-forward expected processor deposits)

GET
/card-clearing/installments

One row per installment of a card charge, with its own expected deposit date and amount. Defaults to the EXPECTED (unsettled) pipeline; pass status=SETTLED to see what has landed.

Authorization

X-Api-Key<token>

Business API key, e.g. vuz_ab12cdef... Created via Settings → Integrations → API Keys. Unlike partner keys, a public API key's STRING does not encode its environment — isolation instead comes from a completely separate sandbox database: a key minted on the Sandbox server (above) only ever reads/writes sandbox data and can never see or affect production, regardless of what the key looks like.

In: header

Query Parameters

clearingAccountCode?string

Narrow to one processor till

clientId?string
documentPaymentId?string
dueOnOrBefore?string

Only installments expected by this date

status?string

Value in

  • "EXPECTED"
  • "SETTLED"
  • "CANCELLED"

Response Body

application/json

curl -X GET "https://example.com/card-clearing/installments"
[  {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "installmentNumber": 2,    "totalInstallments": 3,    "amount": 1180,    "expectedDate": "2026-08-25",    "status": "EXPECTED",    "clearingAccountCode": "1004",    "processorLabel": "Isracard",    "daysOverdue": 12,    "settledBankMatchId": {},    "documentId": {},    "clientId": {}  }]