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.
| Parameter | Type | Description |
|---|---|---|
| StatusCode | String | OPEN returns active agreements. Any other value (CLOSED, CLOSE2, NOTACT) returns the rest. |
| TypeCode | String | CARPRE returns card-present (terminal) agreements. Any other value (INTNET, RECURR) returns card-not-present (online) agreements. |
| MerchantRegistrationNumber | String | The merchant's registration number (kennitala). |
| MerchantNumber | String | The merchant number. |
| MerchantId | Integer | Straumur'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
| Field | Type | Description |
|---|---|---|
| id | Integer | Straumur's internal agreement ID. |
| agreementNumber | String | The agreement number. Use it to filter the other endpoints. |
| type | String | CARPRE for card-present (terminal) agreements, INTNET for card-not-present (online) agreements. |
| status | String | OPEN for active agreements, CLOSED for all others. |
| currency | String | Settlement currency, ISO 4217 alphabetic code. |
| currencyCode | String | Settlement currency, ISO 4217 numeric code. |
| merchantName | String | The merchant's legal name. |
| merchantRegistrationNumber | String | The merchant's registration number (kennitala). |
| merchantNumber | String | The merchant number. |
| merchantID | String | The merchant number (same value as merchantNumber). |
| balance | Number | The agreement's latest net balance. Merchant API only; always 0 in the Partner API. |
| totalBalance | Number | balance plus rrBalance. |
| terminalCountByAgreement | Integer | Number of terminals on the agreement's active stores. |
| rrBalance | Number | Not used. Always 0. |
| rrPercentage | String | Not used. Always empty. |
| partnerID | String | Not used. Always empty. |