Skip to main content

Settlement Transactions

Retrieve transactions included in a settlement


GET /reports/settlements/{{settlementId}}/transactions?page=1&perPage=1 HTTP/1.1
Host: // (Please note! Different hostname in production)
Authorization: Bearer bXlVc2VybmFtZTpmN2E1ODA4MGQzZTk0M2VmNWYyMTZlMDE...
Error codes​
Http status codeDescription
401Unathorized, token verification needed. See: Authentication for more information
403Permissions needed e.g. trying to fetch content for a store you don't have permission to
404Transactions not found
422Query with incorrect format

Data Model​


Request headers​
AuthorizationYesInstructions on how to generate the Bearer token value can be found here
AcceptNoDefault response format is json, to return transactions in csv format set Accept header to text/csv
Please Note

When using the Accept text/csv the format will follow the same format as the example files on the Settlements page

Request querystrings​
pageNoPage of items that should be returned in request
perPageNoNumber of items to be returned in each request. Largest allowed value is 25000

Response​ object is an array of the following structure:

"customerNumber": "",
"firstName": "Test",
"lastName": "Test",
"amount": 1000.0,
"purchaseDate": "2022-01-01",
"transactionDate": "2020-01-01",
"invoiceNumber": "11111111",
"orderNumber": "TEST_230116_011045",
"type": "Purchase",
"totalVatAmountPerRate": [
"vatRate": 25.0,
"amount": 180
"vatRate": 6.0,
"amount": 5.66
"currency": "SEK",
"settlementDate": null,
"payoutReference": null,
"actionReference": null
customerNumberCustom value that can be provided at purchase
firstNameB2C customers first name, B2B company name
lastNameB2C customers last name, B2B empty
amountTransaction amount
purchaseDateThe date when the purchase was captured
transactionDateCustom date value provided at purchaseIn SOAP OrderDate
invoiceNumberThe purchase invoice number
orderNumberCustom value that can be provided at purchaseIn checkout reference
typeSettlement types
totalVatAmountPerRateThe amount of VAT paid for each VAT rate
currencyThe purchase currency
settlementDateThe date the settlement is created,Only available when extended csv is configured
payoutReferenceThe reference used for the bank payoutOnly available when extended csv is configured
actionReferenceCustom value that can be provided when purchase is captured or refundedOnly available when extended csv is configured