Settle a net card-processor bank deposit against a card-clearing (1099) expectation

The bank inflow is the NET the processor (Isracard/Visa/…) deposited. Supply the GROSS card charge it settles + the fee (percent or explicit). Posts ONE balanced entry Dr net · Dr card-fees · Dr input-VAT / Cr gross, relieving the clearing pool by the gross. Valve-gated (engine); the fee-split is verified to reconcile the deposit before posting.

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

Path Parameters

id*string

Bank transaction ID (the net deposit inflow)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

grossAmount*number

GROSS card charge amount this deposit settles (the clearing amount to relieve).

feePercent?number

Processor fee as a PERCENT of gross (e.g. 0.9 = 0.9%). Provide this OR feeAmount. Per-settlement input for now; DB-configurable per processor/terminal later (CPA-flag).

feeAmount?number

Explicit ex-VAT processor fee amount. Overrides feePercent when both are supplied.

feeVatRate?number

VAT rate (percent) applied to the fee. Defaults to the current statutory rate resolved from the VAT-rate service for the settlement date (never hardcoded).

clearingAccountCode?string

Clearing account to relieve (Cr). Defaults to 1099 (generic card till).

bankAccountCode?string

Bank account to debit with the net deposit. Defaults to the session bank account, else 1101 (primary bank).

cardInstallmentIds?array<>

T2.3 (GAP-CARD-INSTALLMENT-PLAN) — the EXPECTED card installments this deposit pays out. When supplied, the engine walks the schedule forward: it verifies their Σ equals grossAmount, derives the clearing account from them (so an Isracard deposit relieves the Isracard till, not the generic pool), marks them SETTLED against this match, and refuses any tranche that was already deposited. Unmatching puts them back to EXPECTED.

notes?string

Optional note stored on the match link.

Response Body

`application/json`

curl -X POST "https://example.com/bank-reconciliation/transactions/string/settle-card-clearing" \  -H "Content-Type: application/json" \  -d '{    "grossAmount": 1000  }'

{  "match": {    "id": "string",    "businessId": "string",    "transactionId": "string",    "documentId": {},    "receiptDocumentId": {},    "expenseId": {},    "amount": 500,    "matchType": "receipt_created",    "notes": {},    "createdAt": "2019-08-24T14:15:22Z"  },  "transactionId": "string",  "transactionStatus": "partially_matched",  "matchedAmount": 300,  "remainder": 200,  "message": "string",  "cardSettlement": {    "gross": 1000,    "net": 989.38,    "fee": 9,    "vatOnFee": 1.62,    "vatRate": 18,    "bankAccountCode": "1101",    "feeExpenseAccountCode": "5980",    "settledInstallmentCount": 1,    "inputVatAccountCode": "1200",    "clearingAccountCode": "1099",    "chargeCount": 40,    "processorLabel": "Isracard"  },  "fx": {    "currency": "USD",    "foreignAmount": 392.68,    "bookedRate": 3.005,    "settlementRate": 3.062,    "settlementRateSource": "boi",    "ilsMoved": 1202.39,    "settledIls": 1180,    "fxDifference": 22.39,    "direction": "gain",    "fxAccountCode": "5990",    "bankAccountCode": "1101",    "posted": true  }}