Settle a processor BATCH deposit (one bank line = Σ card charges − total fees)

The real daily Isracard deposit: ONE net bank line settling many card charges at once. Supply the charges (or a total gross) + the fee; posts ONE balanced entry Dr net · Dr card-fees total-fee · Dr input-VAT total-VAT / Cr total-gross, relieving the clearing pool by the total gross. Carries a processor label for attribution. Valve-gated (engine).

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 batch deposit inflow)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

charges?array<number>

The individual card-charge gross amounts this deposit settles. Summed to the total gross. Provide this OR totalGrossAmount.

totalGrossAmount?number

Total GROSS of the batch (Σ card charges) when the individual charges are not listed.

feePercent?number

Processor fee as a PERCENT of total gross (e.g. 0.9). Provide this OR feeAmount.

feeAmount?number

Explicit total ex-VAT fee amount for the batch. Overrides feePercent when both given.

feeVatRate?number

VAT rate (percent) on the fee. Defaults to the statutory rate for the settlement date.

chargeCount?number

Number of card charges in the batch (audit/attribution; defaults to charges.length).

processorLabel?string

Processor / terminal label (e.g. "Isracard").

clearingAccountCode?string

Clearing account to relieve (Cr). Defaults to 1099.

bankAccountCode?string

Bank account to debit with the net. Defaults to session bank, else 1101.

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-batch" \  -H "Content-Type: application/json" \  -d '{}'

{  "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  }}