List card-clearing settlements

Payouts from the card acquirer of a clearing integration (Isracard Business, Pro plan and above), one per merchant, payment date and currency, deleted ones left out.

  • status expected is a future credit the acquirer lists; settled is one already paid. The same payout keeps its id and moves from expected to settled. Never add expected and settled amounts into one figure: report them apart (what is coming, what was paid).
  • amounts.netMinor is what reaches the bank account: grossMinor minus the deductions (commission, VAT, discount, charging fee, advance repayment fee), each a positive amount. Amounts are integers in minor units (agorot for ILS).
  • branch is the merchant (supplier) number; payoutAccount is the last 4 digits of the receiving bank account, or null when the merchant has several.
  • Items are in key order, not sorted by paymentDate: sort them yourself.

An integration whose connector does not sync this stream answers an empty page with freshness.dataAsOf null, not an error.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^intg_[0-9A-HJKMNP-TV-Z]{26}$

The integration's id (intg_ and 26 characters), from GET /integrations/.

Query Params
string
enum

Only expected or only settled payouts.

Allowed:
date

Payment date on or after. YYYY-MM-DD.

date

Payment date on or before. YYYY-MM-DD.

integer
1 to 200
Defaults to 50

Items per page, 1–200. Default 50.

string
length between 1 and 2048

nextCursor from the previous page. It is valid only for the same integration and listing; anything else answers 400 CURSOR_INVALID.

Responses

401

Missing or invalid access token (answered by the API gateway, without the error envelope).

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json