Skip to main content

Agreements

An agreement is a contract with Straumur for one settlement currency. Every other record in the reporting APIs belongs to an agreement. Start here to find the agreement numbers you filter the other endpoints by.

List agreements​

GET /api/Agreements

Query parameters​

All parameters are optional.

ParameterTypeDescription
StatusCodeStringOPEN returns active agreements. Any other value (CLOSED, CLOSE2, NOTACT) returns the rest.
TypeCodeStringCARPRE returns card-present (terminal) agreements. Any other value (INTNET, RECURR) returns card-not-present (online) agreements.
MerchantRegistrationNumberStringThe merchant's registration number (kennitala).
MerchantNumberStringThe merchant number.
MerchantIdIntegerStraumur's internal merchant ID.

Example request​

curl -u "$USERNAME:$API_KEY" \
"https://partner-api.staging.straumur.is/api/Agreements?StatusCode=OPEN"

Example response​

{
"agreements": [
{
"id": 4211,
"merchantName": "Kaffihúsið ehf.",
"merchantRegistrationNumber": "5501692829",
"merchantNumber": "2001045",
"merchantID": "2001045",
"agreementNumber": "1000123",
"type": "CARPRE",
"status": "OPEN",
"currency": "ISK",
"currencyCode": "352",
"balance": 0.00,
"rrBalance": 0,
"totalBalance": 0.00,
"partnerID": "",
"rrPercentage": "",
"terminalCountByAgreement": 3
}
],
"responseDateTime": "2026-10-22T08:30:11Z",
"responseIdentifier": "a1c7e8f2-1d0b-4a51-9e0c-6f3c2b7d4e10"
}

Get an agreement​

GET /api/Agreements/agreementNumber/{agreementNumber}

Returns one agreement in agreement. If you have no agreement with that number, agreement is null.

curl -u "$USERNAME:$API_KEY" \
"https://partner-api.staging.straumur.is/api/Agreements/agreementNumber/1000123"

Agreement fields​

FieldTypeDescription
idIntegerStraumur's internal agreement ID.
agreementNumberStringThe agreement number. Use it to filter the other endpoints.
typeStringCARPRE for card-present (terminal) agreements, INTNET for card-not-present (online) agreements.
statusStringOPEN for active agreements, CLOSED for all others.
currencyStringSettlement currency, ISO 4217 alphabetic code.
currencyCodeStringSettlement currency, ISO 4217 numeric code.
merchantNameStringThe merchant's legal name.
merchantRegistrationNumberStringThe merchant's registration number (kennitala).
merchantNumberStringThe merchant number.
merchantIDStringThe merchant number (same value as merchantNumber).
balanceNumberThe agreement's latest net balance. Merchant API only; always 0 in the Partner API.
totalBalanceNumberbalance plus rrBalance.
terminalCountByAgreementIntegerNumber of terminals on the agreement's active stores.
rrBalanceNumberNot used. Always 0.
rrPercentageStringNot used. Always empty.
partnerIDStringNot used. Always empty.