Get settlement transactions

Example Request

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

Path parameters

settlementId

The settlement ID

Query parameters

fromId

stringOptional

An ID used to get the next set of results, 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 previous request.

size

numberOptional

Maximum length of results. Defaults to 100.

Example Response

{
  "lastId": "sl_1G0NyDkjZAAJBWlcC3mdE9vFxyZ",
  "settlementId": "sl_2J0NyDkjZIIJBWlcC3mdE9vH3gA",
  "tx": [
    {
      "accountId": "ac_1xWqkkS5aIbxCJsoseRhSd0OJyD",
      "amount": {
        "amount": "10.00",
        "currency": "SEK",
        "formatted": "10.00",
        "formattedWithCurrency": "SEK 10.00",
        "minorUnits": 1000
      },
      "capturedAt": "2023-02-24T00:00:00Z",
      "feeVatAmount": {
        "amount": "1.00",
        "currency": "SEK",
        "formatted": "1.00",
        "formattedWithCurrency": "SEK 1.00",
        "minorUnits": 100
      },
      "fixedFeeAmount": {
        "amount": "4.00",
        "currency": "SEK",
        "formatted": "4.00",
        "formattedWithCurrency": "SEK 4.00",
        "minorUnits": 400
      },
      "invoiceCreatedAt": "2023-02-24T00:00:00Z",
      "invoiceNumber": "343096764838006849",
      "merchantReference": "abc123",
      "payoutAmount": {
        "amount": "5.00",
        "currency": "SEK",
        "formatted": "5.00",
        "formattedWithCurrency": "SEK 5.00",
        "minorUnits": 500
      },
      "storeId": "343096764",
      "txType": "sale",
      "variableFeeAmount": {
        "amount": "0.00",
        "currency": "SEK",
        "formatted": "0.00",
        "formattedWithCurrency": "SEK 0.00",
        "minorUnits": 0
      },
      "vatAmount": {
        "amount": "2.00",
        "currency": "SEK",
        "formatted": "2.00",
        "formattedWithCurrency": "SEK 2.00",
        "minorUnits": 200
      },
      "vatBreakdown": [
        {
          "vat": 2500,
          "amount": {
            "amount": "2.00",
            "currency": "SEK",
            "formatted": "2.00",
            "formattedWithCurrency": "SEK 2.00",
            "minorUnits": 200
          }
        }
      ]
    }, ...
  ]
}

lastId

string

A settlement id that can be used in another GET /tx request to get the subsequent settlement tx by querying with fromId.

settlementId

string

The id of the settlement.

tx

array of settlement tx

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