kepa
Reconciliation/getSettlement

Get a Settlement

Fetch a single settlement batch by ID.

GET/v1/settlements/{settlementId}
Retrieve the full details of a single settlement batch. Includes top-level totals, acquirer reference numbers, and the funding timeline (when funds are expected to land in the merchant's bank account).
Path parameters
settlementIdstringRequired

The settlement identifier returned by /v1/settlements.

Example "stl_01JQDAY00042"

Response

application/json

idstringRequired

Settlement batch identifier.

Example "stl_01JQDAY00042"
closedAtstring · ISO 8601Required

Timestamp when the batch was closed (day-end).

Example "2026-04-08T23:00:00Z"
statusenumRequired

Settlement batch status.

PENDINGSETTLEDFAILEDPARTIAL
currencystringRequired

ISO 4217 currency code.

Example "NZD"
netAmountintegerRequired

Net settled amount in minor units (sales − refunds − voids).

Example 322550
acquirerBatchRefstring

Acquirer-side batch reference for downstream reconciliation.

Example "BATCH-20260408-0042"
fundingDatestring · ISO 8601

Expected date funds will be credited to the merchant's bank account.

Example "2026-04-10T00:00:00Z"
merchantIdstringRequired

Merchant identifier (MID).

Example "MID123456789"
terminalIdstringRequired

Terminal identifier (TID).

Example "TID-00012345"

getSettlement

GETGo API
https://api.kepapay.co/v1/settlements/{settlementId}
Request
curl https://api.kepapay.co/v1/settlements/stl_01JQDAY00042 \
  -H "X-Api-Key: $KEPA_SECRET_KEY"
Response
{
  "id": "stl_01JQDAY00042",
  "closedAt": "2026-04-08T23:00:00Z",
  "status": "SETTLED",
  "currency": "NZD",
  "saleCount": 47,
  "saleAmount": 328750,
  "refundCount": 2,
  "refundAmount": 5000,
  "voidCount": 1,
  "voidAmount": 1200,
  "netAmount": 322550,
  "acquirerBatchRef": "BATCH-20260408-0042",
  "fundingDate": "2026-04-10T00:00:00Z",
  "merchantId": "MID123456789",
  "terminalId": "TID-00012345"
}