Settlement Search

Find settlement reports created for all your stores. There will be one settlement for every time we settle for each of your stores according to your agreement.

Example

Request

GET /reports/settlements?page=1&perPage=1 HTTP/1.1
Host: api.uat.walleydev.com // (Please note! Different hostname in production)
Authorization: Bearer bXlVc2VybmFtZTpmN2E1ODA4MGQzZTk0M2VmNWYyMTZlMDE...

Response

{
  "data": [
    {
      "id": "1",
      "startDate": "2022-12-30T00:00:00",
      "endDate": "2022-12-30T00:00:00"
      "storeId": 1,
      "ingoingBalance": 0.0,
      "totalAmount": 100000.0,
      "currency": "SEK",
      "netSales": 100000.0,
      "paidOutAt": "2023-01-02T11:00:10.000000+01:00",
      "generatedAt": "2023-01-02T11:00:10.000000+01:00",
      "captured": 103000.0,
      "refunded": -3000.0,
      "links": {
        "pdf": {
          "method": "GET",
          "href": "/reports/settlements/1/file/pdf",
          "query": ""
        },
        "transactions": {
          "method": "GET",
          "href": "/reports/settlements/1/transactions",
          "query": ""
        }
      }
    }
  ],
  "links": {
    "self": {
      "method": "GET",
      "href": "/settlements?page=1&perPage=1",
      "query": "page=1&perPage=1"
    },
    "next": {
      "method": "GET",
      "href": "/settlements?page=2&perPage=1",
      "query": "page=2&perPage=1"
    }
  },
  "metaData": {
    "totalNumberOfRecords": 100,
    "numberOfPages": 100,
    "currentPage": 1,
    "range": {
      "from": 1,
      "to": 1
    }
  }
}

Http status code	Description
401	Unauthorized, token verification needed. See: Authentication for more information
422	Query with incorrect format

Data Model

Request

Request headers

Header	Required	Explanation
Authorization	Yes	Instructions on how to generate the Bearer token value can be found here

Request querystrings

Header	Required	Explanation
page	No	Page of items that should be returned in request. Default is 1
perPage	No	Number of items to be returned in each request. Largest allowed value is 1000, default is 10
query	No	Used for free text search or specific property value search. Examples can be found here

Request examples

The query property can be used in the request to filter out settlement reports depending on the properties.

Please Note

%20 are the encoded characters for a space.

By date and periods

Reports that have startDate after the date 2022-12-17. This is equal to the search startDate: > 2022-12-17.

/reports/settlements?query=startDate:>2022-12-17&page=1&perPage=30

Reports that have startDate before the date 2022-12-17. This is equal to the search startDate: < 2022-12-17.

/reports/settlements?query=startDate:<2022-12-17&page=1&perPage=30

Reports with the startDate 2022-12-30 and endDate 2022-12-30. This is equal to the search startDate:2022-12-30 AND endDate:2022-12-30.

/reports/settlements?query=startDate:2022-12-30%20AND%20endDate:2022-12-30&page=1&perPage=30

Reports between startDate 2022-12-01 and endDate 2022-12-08. This is equal to the search startDate: >= 2022-12-01 AND endDate: <= 2022-12-08.

/reports/settlements?query=startDate:>=2022-12-01%20AND%20endDate:<=2022-12-08&page=1&perPage=30

By currency

Reports between with the currency SEK.

/reports/settlements?query=currency:SEK&page=1&perPage=30

By store

Reports from the storeId 4567.

/reports/settlements?query=storeId:4567&page=1&perPage=30

Combined properties

Reports between the time period startDate 2022-12-01 and endDate 2022-12-08 with currency SEK. Equal to startDate: >= 2022-12-01 AND endDate: <= 2022-12-08 AND currency: SEK.

/reports/settlements?query=startDate:>=2022-12-01%20AND%20endDate:<=2022-12-08%20AND%20currency:SEK&page=1&perPage=30

Reports from the storeId with currency SEK. Equal to startDate: >= 2022-12-01 AND endDate: <= 2022-12-08 AND currency: SEK.

/reports/settlements?query=storeId:1158%20AND%20currency:SEK&page=1&perPage=30

Response

response.data object is an array of the following structure:

{
  "id": "1",
  "startDate": "2022-12-30T00:00:00",
  "endDate": "2022-12-30T00:00:00"
  "storeId": 1,
  "ingoingBalance": 0.0,
  "totalAmount": 100000.0,
  "currency": "SEK",
  "netSales": 100000.0,
  "paidOutAt": "2023-01-02T11:00:10.000000+01:00",
  "generatedAt": "2023-01-02T11:00:10.000000+01:00",
  "captured": 103000.0,
  "refunded": -3000.0,
  "links": {
    "pdf": {
      "method": "GET",
      "href": "/reports/settlements/1/file/pdf",
      "query": ""
    },
    "transactions": {
      "method": "GET",
      "href": "/reports/settlements/1/transactions",
      "query": ""
    }
  }
}

Properties

Property	Explanation
id	The id of the settlement
startDate	The start date of captures and refunds thats included in the settlements
endDate	The end date of captures and refunds thats included in the settlements
storeId	The id of the store that has been settled
ingoingBalance	If previous settlement had negative balance, it will be moved onto the following settlement
totalAmount	The amount that will be payed out for the period
currency	The currency on the purchases that has been settled
netSales	The net sales during the settled period
paidOutAt	The date of the payout
generatedAt	The date and time the settlement was generated
captured	The captured amount during the settlement period
**refunded **	The returned amount during the settlement period
links.transactions	The url that can be used to retrieve all the transactions that has been settled
links.pdf	The url that can be used to retrieve the PDF file for the settlement. Depending on setup this might not be available.