Skip to main content

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.

ParameterTypeDescription
AgreementNumberStringOnly settlements on this agreement.
SettlementNumberStringThe settlement's settlementNumber. Unique per merchant only.
ReferenceStringThe settlement's reference, as listed in a payment's settlements.
CurrencyStringSettlement currency, for example ISK.
CreateDateFromDateDate the settlement was created, from.
CreateDateToDateDate the settlement was created, to.
ScheduledDateFromDateScheduled payment date, from.
ScheduledDateToDateScheduled payment date, to.
PaidDateFromDateDate the settlement was paid, from.
PaidDateToDateDate the settlement was paid, to.
PaidDateTimeFromDateTimeMerchant API only. Exact paid time from, included. Format 2026-10-21T09:00:00, UTC.
PaidDateTimeToDateTimeMerchant API only. Exact paid time to, excluded.
GrossPurchaseFromNumbergrossSettlement from.
GrossPurchaseToNumbergrossSettlement to.
NetSettlementFromNumbernetSettlement from.
NetSettlementToNumbernetSettlement 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​

FieldTypeDescription
idStringStraumur's ID for the settlement.
settlementNumberIntegerThe settlement number. Counts up per merchant.
referenceStringThe settlement reference: merchant number and settlement number, for example 2001045-412.
agreementNumberStringThe agreement number.
merchantIDStringThe merchant number.
merchantNameStringThe merchant's legal name.
partnerIDStringID of the partner the agreement is linked to, or empty.
dbaNamesString[]Names of the agreement's active stores.
settlementTypeIntegerSee Settlement type.
payGrossString"True" if the agreement is paid gross: transactions are paid without fees, and the fees are settled separately once a month. Otherwise "False".
createdDateStringWhen the settlement was created.
scheduledDateStringThe date the settlement is due to be paid.
paidDateStringWhen the settlement was paid, or null.
batchesIntegerNumber of batches in the settlement.
transactionsIntegerNumber of transactions in the settlement.

Totals​

All amounts are in the settlement currency. Fees and other deductions are negative.

FieldTypeDescription
currencyStringSettlement currency.
grossPurchaseNumberGross amount of purchases.
netPurchaseNumberNet amount of purchases, after transaction fees.
refundAmountNumberGross amount of refunds.
grossSettlementNumberGross amount of the settlement.
feeAmountNumberAll fees and other deductions in the settlement.
deductionNumbergrossSettlement minus netSettlement, as a positive number.
netSettlementNumbergrossSettlement plus feeAmount: the amount paid out for this settlement.
payoutNumberSame as netSettlement.

Breakdown​

FieldTypeDescription
transactionFeeNumberTransaction fees, including interchange and scheme fees.
schemeFeesNumberThe card scheme fee part of transactionFee. Always 0 in the Partner API.
swiftFeesNumberBank transfer fees. Always 0 in the Partner API.
dccCommissionNumberDynamic currency conversion commission. Always 0 in the Partner API.
posFeeNumberTerminal rental fees, on card-present agreements.
ecomGatewayMonthlyFeeNumberGateway rental fees, on card-not-present agreements.
settlementFeeNumberStatement fees.
authorizationFeeNumberAuthorization fees.
joiningFeeNumberJoining fees.
chargebackNumberChargebacks.
chargebackFeesNumberChargeback fees.
representmentNumberChargebacks reversed in your favour.
preArbitrationNumberPre-arbitration amounts.
rejectedNumberTransactions rejected by the card scheme.
reversalsNumberGross 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.