SIsilverflow
Retrieve POS Charges

List Charges [EXPERIMENTAL]

Notice: This endpoint has different server URLs and authorization method than the rest of the API.

Retrieve charge history for a merchant, optionally filtered by terminal.

get/pos/charges

Request

Query parameters

merchantKeystring required

Uniquely identifies a merchant.

Example:mct-1234abcdef123

The merchant identifier to filter charges by.

terminalIdstring

The terminal identifier to filter charges by. When provided, only charges for this specific terminal are returned.

limitinteger

The number of items to return

offsetTokenstring
Example:LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc

The offset token. This token is returned in the response of previous request.

Response

A list of POS charges

itemCountinteger required
moreItemsboolean required
offsetTokenstring

Example response

{
  "offsetToken": "LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc",
  "charges": [
    {
      "chargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
      "merchantKey": "mct-1234abcdef123",
      "terminalId": "AAFF",
      "amount": {
        "value": 2599,
        "currency": "EUR",
        "breakdown": {
          "baseAmount": 2599,
          "cashback": 2599,
          "gratuity": 2599
        }
      },
      "status": "approved",
      "cardMaskedNumber": "47613499****1234",
      "type": {
        "cardEntry": "terminal"
      },
      "transactionReference": "Dz3dIzE74EfH1HeTInyE"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.