Settlements
A settlement is everything Straumur settles for one agreement in one run: the transactions, minus fees, chargebacks and other deductions. Settlements are what you post to your ledger. Each one is paid out in a payment.
List settlements
GET /api/Settlements
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 settlements on this agreement. |
| SettlementNumber | String | The settlement's settlementNumber. Unique per merchant only. |
| Reference | String | The settlement's reference, as listed in a payment's settlements. |
| Currency | String | Settlement currency, for example ISK. |
| CreateDateFrom | Date | Date the settlement was created, from. |
| CreateDateTo | Date | Date the settlement was created, to. |
| ScheduledDateFrom | Date | Scheduled payment date, from. |
| ScheduledDateTo | Date | Scheduled payment date, to. |
| PaidDateFrom | Date | Date the settlement was paid, from. |
| PaidDateTo | Date | Date the settlement was paid, to. |
| PaidDateTimeFrom | DateTime | Merchant API only. Exact paid time from, included. Format 2026-10-21T09:00:00, UTC. |
| PaidDateTimeTo | DateTime | Merchant API only. Exact paid time to, excluded. |
| GrossPurchaseFrom | Number | grossSettlement from. |
| GrossPurchaseTo | Number | grossSettlement to. |
| NetSettlementFrom | Number | netSettlement from. |
| NetSettlementTo | Number | netSettlement to. |
Example request
curl -u "$USERNAME:$API_KEY" \
"https://partner-api.staging.straumur.is/api/Settlements?AgreementNumber=1000123&CreateDateFrom=2026-10-21&CreateDateTo=2026-10-21"
Example response
{
"settlements": [
{
"id": "551203",
"settlementNumber": 412,
"reference": "2001045-412",
"agreementNumber": "1000123",
"merchantID": "2001045",
"merchantName": "Kaffihúsið ehf.",
"partnerID": "12",
"dbaNames": ["Kaffihúsið Laugavegi", "Kaffihúsið Hafnarfirði"],
"settlementType": 0,
"payGross": "False",
"createdDate": "2026-10-21T07:00:12Z",
"scheduledDate": "2026-10-21T00:00:00Z",
"paidDate": "2026-10-21T09:14:02Z",
"currency": "ISK",
"batches": 3,
"transactions": 318,
"grossPurchase": 1202500.00,
"netPurchase": 1185670.00,
"refundAmount": 0.00,
"grossSettlement": 1202500.00,
"feeAmount": -18250.00,
"deduction": 18250.00,
"netSettlement": 1184250.00,
"payout": 1184250.00,
"transactionFee": -16830.00,
"schemeFees": -1120.00,
"posFee": -1420.00,
"chargeback": 0.00,
"chargebackFees": 0.00,
"representment": 0.00,
"preArbitration": 0.00,
"rejected": 0.00,
"reversals": 0.00,
"swiftFees": 0.00,
"dccCommission": 0.00,
"settlementFee": 0.00,
"authorizationFee": 0.00,
"joiningFee": 0.00,
"ecomGatewayMonthlyFee": 0.00
// ...plus the unused fee fields listed below, all 0
}
],
"responseDateTime": "2026-10-22T08:30:11Z",
"responseIdentifier": "9a7c5e3b-1f2d-4b6a-8e0c-2d4f6a8c0e1b"
}
Get a settlement
GET /api/Settlements/id/{id}
id is the settlement's id, also given on transactions as settlementID. Returns one settlement in settlement, or null.
Settlement fields
Identifiers and dates
| Field | Type | Description |
|---|---|---|
| id | String | Straumur's ID for the settlement. |
| settlementNumber | Integer | The settlement number. Counts up per merchant. |
| reference | String | The settlement reference: merchant number and settlement number, for example 2001045-412. |
| agreementNumber | 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, or empty. |
| dbaNames | String[] | Names of the agreement's active stores. |
| settlementType | Integer | See Settlement type. |
| payGross | String | "True" if the agreement is paid gross: transactions are paid without fees, and the fees are settled separately once a month. Otherwise "False". |
| createdDate | String | When the settlement was created. |
| scheduledDate | String | The date the settlement is due to be paid. |
| paidDate | String | When the settlement was paid, or null. |
| batches | Integer | Number of batches in the settlement. |
| transactions | Integer | Number of transactions in the settlement. |
Totals
All amounts are in the settlement currency. Fees and other deductions are negative.
| Field | Type | Description |
|---|---|---|
| currency | String | Settlement currency. |
| grossPurchase | Number | Gross amount of purchases. |
| netPurchase | Number | Net amount of purchases, after transaction fees. |
| refundAmount | Number | Gross amount of refunds. |
| grossSettlement | Number | Gross amount of the settlement. |
| feeAmount | Number | All fees and other deductions in the settlement. |
| deduction | Number | grossSettlement minus netSettlement, as a positive number. |
| netSettlement | Number | grossSettlement plus feeAmount: the amount paid out for this settlement. |
| payout | Number | Same as netSettlement. |
Breakdown
| Field | Type | Description |
|---|---|---|
| transactionFee | Number | Transaction fees, including interchange and scheme fees. |
| schemeFees | Number | The card scheme fee part of transactionFee. Always 0 in the Partner API. |
| swiftFees | Number | Bank transfer fees. Always 0 in the Partner API. |
| dccCommission | Number | Dynamic currency conversion commission. Always 0 in the Partner API. |
| posFee | Number | Terminal rental fees, on card-present agreements. |
| ecomGatewayMonthlyFee | Number | Gateway rental fees, on card-not-present agreements. |
| settlementFee | Number | Statement fees. |
| authorizationFee | Number | Authorization fees. |
| joiningFee | Number | Joining fees. |
| chargeback | Number | Chargebacks. |
| chargebackFees | Number | Chargeback fees. |
| representment | Number | Chargebacks reversed in your favour. |
| preArbitration | Number | Pre-arbitration amounts. |
| rejected | Number | Transactions rejected by the card scheme. |
| reversals | Number | Gross amount of reversed transactions. |
Not used
These fields are kept for compatibility and are always 0: rollingReserve, rollingRelease, addedSum, deductedSum, setFee, aukakronurFee, otherFees, gomobileFee, gomobileInitialFee, preAuthorizationFee, monthlyFee, minimumMonthlyServiceFee, cardNotPresentFee, pciFee, mobileAirTimeFee, ecomGatewayTransactionFee.