Skip to main content

Reporting APIs

The reporting APIs give you the same settlement data you see in the Merchant Portal or Partner Portal, in a form your systems can read. Use them to bring Straumur's payouts, settlements, fees and card transactions into your accounting or ERP system and reconcile them against your bank account and your own sales records.

Both APIs are read-only. They do not create payments or move money.

Which API do you need?​

Merchant APIPartner API
Who it is forA merchant reconciling its own salesA partner (for example a POS or software provider, or an accounting firm) working on behalf of several merchants
Data you seeEvery agreement of your own companyEvery agreement of every merchant linked to your partner contracts
CredentialsAn API user on your merchantAn API user on your partner

Both APIs share the same endpoints and response shapes, with a few differences noted on each endpoint page.

Environments​

TestLive
Merchant APIhttps://partner-api.staging.straumur.ishttps://partner-api.straumur.is
Partner APIhttps://partner-external-api.staging.straumur.ishttps://partner2-api.straumur.is

Every endpoint page shows the path. Add it to the host for the API and environment you use. Test and live are separate systems with separate credentials.

In test, you can explore each API and try requests in an interactive UI (Merchant API, Partner API). The interactive UI is not available on the live hosts. Use these pages as the reference for live.

How the data fits together​

Agreement ──< Terminal
│
└──< Settlement ──< Batch
│ └──< Transaction
│
└──> Payment (one bank transfer, may cover several settlements)
  • An agreement is your contract with Straumur for one settlement currency and set of card types. Each agreement has its own agreement number. Settlements and payments return it as agreementNumber; transactions and batches return it as agreementID. Terminal responses do not include the agreement number; use the AgreementNumber filter to list terminals for a particular agreement.
  • A terminal is a physical terminal or an online store on an agreement. Transactions carry its terminalID.
  • A transaction is one card purchase or refund, with its gross amount, the fees Straumur deducted, and the net amount.
  • A batch groups the transactions a terminal sent in together. It belongs to one settlement.
  • A settlement is everything Straumur settles for one agreement in one run: the transactions, minus fees, chargebacks and other deductions. It has a settlementNumber and a reference.
  • A payment is the bank transfer to your account. Its paymentID is the reference you see on your bank statement, and settlements lists the settlement references it pays.

Reconcile a payout walks through the calls that connect a deposit on your bank statement to the transactions behind it.

When data appears​

  • Transactions appear once they are settled, not when the card is authorized. Settlements are created once a day, early in the morning (UTC). A sale from yesterday is normally available after that day's settlement run.
  • Authorizations appear as soon as Straumur receives them from the terminal, before they are settled. Use them for a same-day view of sales. See Authorizations.
  • Payments are created after the settlements they pay. paidDate is filled in when the bank transfer has been made. Until then it is null.
  • paidDate on settlements, batches and transactions comes from the payment that paid them.

Query once a day, after the morning run, for the previous day's settlements and payments.

Conventions​

  • Amounts are decimal numbers in major units, for example 15990.00 ISK or 12.50 EUR. This differs from the Checkout API, which uses minor units.
  • Fees are negative. A settlement's netSettlement is its grossSettlement plus its feeAmount. deduction shows the same difference as a positive number.
  • Currencies are three-letter ISO 4217 codes.
  • Dates in responses are ISO 8601 and in UTC, except the transaction purchaseDate and the authorization transactionTime, which are the local time at the terminal.
  • Date-only filters take a date (2026-10-01) and include both the From and To days. Purchase-date filters and the authorization date filters match whole calendar days in the terminal's local time; other date-only filters use UTC. PurchaseDateFrom=2026-10-01&PurchaseDateTo=2026-10-01 returns every transaction made on 1 October in the terminal's local time.
  • Amount filters include the From value and exclude the To value.
  • Filters are optional, and list endpoints are not paged. A list call without filters returns everything you have access to. Always filter by date range, and by agreement where you can.
  • Numeric codes such as settlementType and the terminal status are returned as integers. See Field values.
  • Every response includes responseDateTime (UTC) and responseIdentifier (a unique ID for the response). Quote responseIdentifier when you contact us about a response.

Errors​

StatusWhen
200The request succeeded. A list with no matches returns an empty array. A lookup by ID that finds nothing returns the object as null, except for transactions and authorizations (see below).
400A filter could not be read, for example a date in the wrong format. The body is {"errorMessage": "Invalid request"}. In the Partner API, also a transaction or authorization lookup that found nothing, with the body {"Message": "..."}.
401The Authorization header is missing or the credentials are wrong. There is no body.
500In the Merchant API, a transaction or authorization lookup that found nothing. In both APIs, an unexpected error. See Transactions and Authorizations.

Card data​

cardNumber on a transaction is always masked. The reporting APIs never return a full card number. How much of the number is shown depends on the card scheme. For Kortalán transactions, the field holds the customer reference.