Skip to main content

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.

ParameterTypeDescription
AgreementNumberStringOnly payments on this agreement.
SettlementNumberStringOnly the payment that includes the settlement with this settlementNumber.
ScheduledDateFromDateDate the payment was created, from.
ScheduledDateToDateDate the payment was created, to.
PaidDateFromDateDate the payment was made, from.
PaidDateToDateDate 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​

FieldTypeDescription
paymentIDStringThe payment reference, for example P-1000123-58-A. A at the end means all card types; D means a domestic debit card payment.
agreementNumberStringThe agreement number.
merchantIDStringThe merchant number.
merchantNameStringThe merchant's legal name.
merchantRegistrationNumberStringThe merchant's registration number (kennitala).
partnerIDStringID of the partner the agreement is linked to, or empty.
dbaNamesString[]Names of the agreement's active stores.
dbaNameString[]Same as dbaNames.
createdStringWhen the payment was created.
scheduledDateStringSame as created.
paidDateStringWhen the bank transfer was made, or null if it has not been made yet.
currencyStringPayment currency.
payoutAmountNumberThe amount transferred. Equals the sum of netSettlement of the settlements it pays.
ibanStringThe IBAN the payment was sent to. Always empty in the Partner API.
swiftStringPartner API only. Not used; always empty.
settlementTypeIntegerSee Settlement type.
settlementsString[]References of the settlements this payment pays. Look them up with /api/Settlements?Reference=….
partnerNameStringNot used. Always empty.