Skip to main content

Batches

A batch groups the transactions one terminal sent in together, within one settlement. Batches are useful when you close terminals daily and want to match each terminal's end-of-day total.

List batches​

GET /api/Batches

Query parameters​

All parameters are optional. Date parameters take a date (2026-10-21) and include the whole From and To days. Amount parameters include From and exclude To.

ParameterTypeDescription
AgreementNumberStringOnly batches on this agreement.
SettlementIdIntegerOnly batches in the settlement with this id.
SettlementNumberStringOnly batches in the settlement with this settlementNumber.
BatchNumberStringOnly batches with this batch number. Batch numbers repeat over time.
CreatedDateFromDateDate the batch was created, from.
CreatedDateToDateDate the batch was created, to.
SettledDateFromDateDate the batch's settlement was created, from.
SettledDateToDateDate the batch's settlement was created, to.
PaidDateFromDateDate the batch's settlement was paid, from.
PaidDateToDateDate the batch's settlement was paid, to.
GrossFromNumberGross amount from.
GrossToNumberGross amount to.
NetFromNumberNet amount from.
NetToNumberNet amount to.

Example request​

curl -u "$USERNAME:$API_KEY" \
"https://partner-api.staging.straumur.is/api/Batches?AgreementNumber=1000123&SettlementNumber=412"

Example response​

{
"batches": [
{
"id": "730144",
"batchNumber": "1020",
"terminalID": "S1F2L001",
"dbaName": "Kaffihúsið Laugavegi",
"merchantName": "Kaffihúsið ehf.",
"merchantID": "2001045",
"agreementID": "1000123",
"partnerID": "12",
"processorID": "1",
"settlementID": "551203",
"settlementNumber": "412",
"settlementType": 0,
"created": "2026-10-21T02:10:44Z",
"settled": "2026-10-21T07:00:12Z",
"paidDate": "2026-10-21T09:14:02Z",
"transactions": 96,
"currency": "ISK",
"grossAmount": 402150.00,
"merchantServiceCharges": -5630.10,
"refund": 0.00,
"chargeback": 0.00,
"netAmount": 396519.90,
"batchTotal": 402150.00
}
],
"responseDateTime": "2026-10-22T08:30:11Z",
"responseIdentifier": "c2e4a6b8-0d1f-4e3a-9c5b-7d9f1e3a5c7b"
}

Get a batch​

GET /api/Batches/id/{batchNumber}

Despite the id in the path, this endpoint looks the batch up by its batch number, and returns the first batch with that number in batch, or null. Because batch numbers repeat over time, prefer the list with BatchNumber and SettlementNumber or AgreementNumber.

Batch fields​

FieldTypeDescription
idStringStraumur's ID for the batch.
batchNumberStringThe batch number from the terminal. Not unique over time.
terminalIDStringThe terminal the batch came from.
dbaNameStringThe store name shown to cardholders.
agreementIDStringThe agreement number.
merchantIDStringThe merchant number.
merchantNameStringThe merchant's legal name.
partnerIDStringID of the partner the agreement is linked to. Always empty in the Partner API.
processorIDStringStraumur's ID for the card processor that handled the batch.
settlementIDStringThe settlement's id.
settlementNumberStringThe settlement's settlementNumber.
settlementTypeIntegerSee Settlement type.
createdStringWhen the batch was created.
settledStringWhen the batch's settlement was created.
paidDateStringWhen the settlement was paid, or null.
transactionsIntegerNumber of transactions in the batch.
currencyStringSettlement currency.
grossAmountNumberTotal gross amount of the batch.
merchantServiceChargesNumberFees deducted for the batch.
refundNumberGross amount of refunds in the batch.
chargebackNumberChargebacks in the batch's settlement.
netAmountNumberNet amount of the batch.
batchTotalNumberSame as grossAmount.