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.
| Parameter | Type | Description |
|---|---|---|
| AgreementNumber | String | Only batches on this agreement. |
| SettlementId | Integer | Only batches in the settlement with this id. |
| SettlementNumber | String | Only batches in the settlement with this settlementNumber. |
| BatchNumber | String | Only batches with this batch number. Batch numbers repeat over time. |
| CreatedDateFrom | Date | Date the batch was created, from. |
| CreatedDateTo | Date | Date the batch was created, to. |
| SettledDateFrom | Date | Date the batch's settlement was created, from. |
| SettledDateTo | Date | Date the batch's settlement was created, to. |
| PaidDateFrom | Date | Date the batch's settlement was paid, from. |
| PaidDateTo | Date | Date the batch's settlement was paid, to. |
| GrossFrom | Number | Gross amount from. |
| GrossTo | Number | Gross amount to. |
| NetFrom | Number | Net amount from. |
| NetTo | Number | Net 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
| Field | Type | Description |
|---|---|---|
| id | String | Straumur's ID for the batch. |
| batchNumber | String | The batch number from the terminal. Not unique over time. |
| terminalID | String | The terminal the batch came from. |
| dbaName | String | The store name shown to cardholders. |
| agreementID | String | The agreement number. |
| merchantID | String | The merchant number. |
| merchantName | String | The merchant's legal name. |
| partnerID | String | ID of the partner the agreement is linked to. Always empty in the Partner API. |
| processorID | String | Straumur's ID for the card processor that handled the batch. |
| settlementID | String | The settlement's id. |
| settlementNumber | String | The settlement's settlementNumber. |
| settlementType | Integer | See Settlement type. |
| created | String | When the batch was created. |
| settled | String | When the batch's settlement was created. |
| paidDate | String | When the settlement was paid, or null. |
| transactions | Integer | Number of transactions in the batch. |
| currency | String | Settlement currency. |
| grossAmount | Number | Total gross amount of the batch. |
| merchantServiceCharges | Number | Fees deducted for the batch. |
| refund | Number | Gross amount of refunds in the batch. |
| chargeback | Number | Chargebacks in the batch's settlement. |
| netAmount | Number | Net amount of the batch. |
| batchTotal | Number | Same as grossAmount. |