Payments
A payment is one bank transfer from Straumur to the merchant's account. It can pay several settlements at once, listed in settlements. Start here to match deposits on your bank statement, then follow the settlement references to the details. See Reconcile a payout.
List payments
GET /api/Payments
Query parameters
All parameters are optional. Date parameters take a date (2026-10-21) and include the whole From and To days.
| Parameter | Type | Description |
|---|---|---|
| AgreementNumber | String | Only payments on this agreement. |
| SettlementNumber | String | Only the payment that includes the settlement with this settlementNumber. |
| ScheduledDateFrom | Date | Date the payment was created, from. |
| ScheduledDateTo | Date | Date the payment was created, to. |
| PaidDateFrom | Date | Date the payment was made, from. |
| PaidDateTo | Date | Date the payment was made, to. |
Example request
curl -u "$USERNAME:$API_KEY" \
"https://partner-api.staging.straumur.is/api/Payments?PaidDateFrom=2026-10-21&PaidDateTo=2026-10-21"
Example response
{
"payments": [
{
"paymentID": "P-1000123-58-A",
"agreementNumber": "1000123",
"merchantID": "2001045",
"merchantName": "Kaffihúsið ehf.",
"merchantRegistrationNumber": "5501692829",
"partnerID": "12",
"partnerName": "",
"dbaName": ["Kaffihúsið Laugavegi", "Kaffihúsið Hafnarfirði"],
"dbaNames": ["Kaffihúsið Laugavegi", "Kaffihúsið Hafnarfirði"],
"created": "2026-10-21T08:00:05Z",
"scheduledDate": "2026-10-21T08:00:05Z",
"paidDate": "2026-10-21T09:14:02Z",
"currency": "ISK",
"payoutAmount": 1184250.00,
"iban": "IS140159260076545510730339",
"settlementType": 0,
"settlements": ["2001045-412"]
}
],
"responseDateTime": "2026-10-22T08:30:11Z",
"responseIdentifier": "5e7a9c1b-3d5f-4a7c-9e1b-3d5f7a9c1e3b"
}
Get the payment for a settlement
GET /api/Payments/settlementNumber/{settlementReference}
Returns the payment that paid a given settlement, in payment, or null. Although the path says settlementNumber, this lookup takes the settlement's reference (for example 2001045-412), the value transactions show in settlementNumber. The SettlementNumber filter on the list takes the settlement number (412).
curl -u "$USERNAME:$API_KEY" \
"https://partner-api.staging.straumur.is/api/Payments/settlementNumber/2001045-412"
Payment fields
| Field | Type | Description |
|---|---|---|
| paymentID | String | The payment reference, for example P-1000123-58-A. A at the end means all card types; D means a domestic debit card payment. |
| agreementNumber | String | The agreement number. |
| merchantID | String | The merchant number. |
| merchantName | String | The merchant's legal name. |
| merchantRegistrationNumber | String | The merchant's registration number (kennitala). |
| partnerID | String | ID of the partner the agreement is linked to, or empty. |
| dbaNames | String[] | Names of the agreement's active stores. |
| dbaName | String[] | Same as dbaNames. |
| created | String | When the payment was created. |
| scheduledDate | String | Same as created. |
| paidDate | String | When the bank transfer was made, or null if it has not been made yet. |
| currency | String | Payment currency. |
| payoutAmount | Number | The amount transferred. Equals the sum of netSettlement of the settlements it pays. |
| iban | String | The IBAN the payment was sent to. Always empty in the Partner API. |
| swift | String | Partner API only. Not used; always empty. |
| settlementType | Integer | See Settlement type. |
| settlements | String[] | References of the settlements this payment pays. Look them up with /api/Settlements?Reference=…. |
| partnerName | String | Not used. Always empty. |