Get settlements

Example Request

curl -X GET \
  -H 'authorization: Bearer v4.public.eyJpc3MiOiJs...' \
  https://api.sandbox.ledyer.com/v1/settlements \

Query parameters

createdFrom

stringOptional

A date in ISO 8601 format, ex: 2011-10-05T14:48:00.000Z.

createdTo

stringOptional

A date in ISO 8601 format, ex: 2011-10-05T14:48:00.000Z.

currency

array of stringsOptional

A list of one or more currency, each separated by a comma.

fromId

stringOptional

An id used to get the next set of settlements, where the set size is based on the size parameter. It is usually assigned the value from lastId which was retrieved in the response from the last GET /settlements request.

id

array of stringsOptional

A list of one or more id, each separated by a comma.

reference

array of stringsOptional

A list of one or more reference, each separated by a comma.

size

numberOptional

The number of settlements to fetch. Defaults to 100.

storeId

array of stringsOptional

A list of one or more storeId, each separated by a comma.

Example Response

{
  "lastId": "sl_2J0NyDkjZIIJBWlcC3mdE9vH3gA",
  "settlements": [
    {
      "captureDateMax": "2024-01-16T00:00:00Z",
      "captureDateMin": "2023-12-18T00:00:00Z",
      "creditAmount": {
        "amount": "-1198.00",
        "currency": "SEK",
        "formatted": "-1,198.00",
        "formattedWithCurrency": "-SEK 1,198.00",
        "minorUnits": -119800
      },
      "creditVatAmount": {
        "amount": "-239.60",
        "currency": "SEK",
        "formatted": "-239.60",
        "formattedWithCurrency": "-SEK 239.60",
        "minorUnits": -23960
      },
      "currency": "SEK",
      "feeVatAmount": {
        "amount": "7.46",
        "currency": "SEK",
        "formatted": "7.46",
        "formattedWithCurrency": "SEK 7.46",
        "minorUnits": 746
      },
      "id": "sl_2b2GlS47knY4x66fCRXuAf2zCbm",
      "invoiceServicePayoutAmount": {
        "amount": "4871.25",
        "currency": "SEK",
        "formatted": "4,871.25",
        "formattedWithCurrency": "SEK 4,871.25",
        "minorUnits": 487125
      },
      "merchantId": "ac_1xWqkkS5aIbxCJsoseRhSd0OJyD",
      "netAmount": {
        "amount": "6031.94",
        "currency": "SEK",
        "formatted": "6,031.94",
        "formattedWithCurrency": "SEK 6,031.94",
        "minorUnits": 603194
      },
      "noOfCredits": 1,
      "noOfInvoiceServicePayouts": 3,
      "noOfPurchaseFixedFee": 3,
      "noOfPurchaseVariableFee": 0,
      "noOfReversals": 0,
      "noOfSales": 5,
      "payoutAmount": {
        "amount": "6031.94",
        "currency": "SEK",
        "formatted": "6,031.94",
        "formattedWithCurrency": "SEK 6,031.94",
        "minorUnits": 603194
      },
      "payoutDate": "2024-01-16T00:00:00Z",
      "purchaseFixedFeeAmount": {
        "amount": "29.85",
        "currency": "SEK",
        "formatted": "29.85",
        "formattedWithCurrency": "SEK 29.85",
        "minorUnits": 2985
      },
      "purchaseVariableFeeAmount": {
        "amount": "0.00",
        "currency": "SEK",
        "formatted": "0.00",
        "formattedWithCurrency": "SEK 0.00",
        "minorUnits": 0
      },
      "reference": "370751",
      "reversalAmount": {
        "amount": "0.00",
        "currency": "SEK",
        "formatted": "0.00",
        "formattedWithCurrency": "SEK 0.00",
        "minorUnits": 0
      },
      "reversalVatAmount": {
        "amount": "0.00",
        "currency": "SEK",
        "formatted": "0.00",
        "formattedWithCurrency": "SEK 0.00",
        "minorUnits": 0
      },
      "saleAmount": {
        "amount": "7267.25",
        "currency": "SEK",
        "formatted": "7,267.25",
        "formattedWithCurrency": "SEK 7,267.25",
        "minorUnits": 726725
      },
      "saleVatAmount": {
        "amount": "1453.45",
        "currency": "SEK",
        "formatted": "1,453.45",
        "formattedWithCurrency": "SEK 1,453.45",
        "minorUnits": 145345
      },
      "storeId": "681575494",
      "subtotalAmount": {
        "amount": "6069.25",
        "currency": "SEK",
        "formatted": "6,069.25",
        "formattedWithCurrency": "SEK 6,069.25",
        "minorUnits": 606925
      },
      "subtotalVatAmount": {
        "amount": "1213.85",
        "currency": "SEK",
        "formatted": "1,213.85",
        "formattedWithCurrency": "SEK 1,213.85",
        "minorUnits": 121385
      },
      "totalCostsAmount": {
        "amount": "37.31",
        "currency": "SEK",
        "formatted": "37.31",
        "formattedWithCurrency": "SEK 37.31",
        "minorUnits": 3731
      },
      "totalOtherChargeAmount": {
        "amount": "0.00",
        "currency": "SEK",
        "formatted": "0.00",
        "formattedWithCurrency": "SEK 0.00",
        "minorUnits": 0
      },
      "urls": {
        "pdf": "https://report.sandbox.ledyer.com/settlement...",
        "csv": "https://report.sandbox.ledyer.com/settlement..."
      }
    }
  ]
}

lastId

string

An order id that can be used in another GET /orders request to get the subsequent orders by querying with fromId.

settlements

array of settlement

An array of settlements, with the last item indicated by lastId.