SIsilverflow
Retrieve Charges

List Charges

This operation supports 2 distinct use cases:

  1. Get a paged list of all charges, optionally filtered by date or period (from, to).
  2. Get a paged list of the charges with the specified transactionReference.

Requires charges:List permission.

get/charges

Request

Query parameters

offsetTokenstring
Example:LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc

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

sortOrder'asc' | 'desc'

The sort order, __asc__ending or __desc__ending

limitinteger

The number of items to return

fromstring iso-8601-date-time

Include only items that have a created date greater than or equal to the specified date

tostring iso-8601-date-time

Include only items that have a created date less than the specified date

datestring date

Include only items that have a created date equal to the specified date

transactionReferencestring

Unique ID assigned by the merchant or payment service provider for the transaction. Used to identify the transaction.

Example:Dz3dIzE74EfH1HeTInyE

Include only items with the specified transactionReference

Response

A (paged) list of charges

moreItemsboolean
offsetTokenstring

Example response

{
  "offsetToken": "LUtyr0s918rNZ5WuWDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9YccUOtDSoyLtc4kAiOLkmjSW5zLa8OCnOXXBRja2rDYh5FNzqAli6HqKHpPDatcfdsaVlibrlO49BKcOdz9Yc",
  "charges": [
    {
      "key": "chg-1e1dAHhgstYTUhlphPzZ",
      "refundedChargeKey": "chg-1e1dAHhgstYTUhlphPzZ",
      "merchantAcceptorRef": {
        "key": "mac-1eOdAHhgstYTUhlphPFf",
        "version": 1
      },
      "tokenDetails": {
        "eci": "05"
      },
      "amount": {
        "value": 2599,
        "currency": "EUR"
      },
      "cardholderBillingAmount": {
        "value": 2599,
        "currency": "EUR"
      },
      "type": {
        "cardEntry": "e-commerce"
      },
      "status": {
        "authentication": "authenticated",
        "authorization": "approved",
        "clearing": "pending"
      },
      "authentication": {
        "sca": {
          "result": {
            "directoryServerTransId": "5340af8a-5505-4bf6-abcd-123412341234"
          }
        }
      },
      "transactionReference": "Dz3dIzE74EfH1HeTInyE",
      "authorizationIsoFields": {
        "responseCode": "00",
        "responseCodeDescription": "Approved",
        "authorizationCode": "4A4316",
        "systemTraceAuditNumber": "123456",
        "retrievalReferenceNumber": "131608123456",
        "networkSpecificFields": {
          "cvcResult": "Y",
          "avsResult": "Y"
        }
      },
      "billingAddress": {
        "countryCode": {
          "alpha3": "NLD",
          "alpha2": "NL",
          "numeric": "528"
        },
        "stateOrProvince": "NH",
        "city": "Amsterdam",
        "line1": "Langtown Road",
        "line2": "4200",
        "postalCode": "1234BC"
      },
      "shippingAddress": {
        "countryCode": {
          "alpha3": "NLD",
          "alpha2": "NL",
          "numeric": "528"
        },
        "stateOrProvince": "NH",
        "city": "Amsterdam",
        "line1": "Langtown Road",
        "line2": "4200",
        "postalCode": "1234BC"
      },
      "dynamicDescriptor": {
        "merchantName": "Acme Inc.",
        "merchantCity": "Amsterdam"
      },
      "foreignRetailer": {
        "amount": 1000
      },
      "subMerchant": {
        "id": "SUB123456",
        "address": {
          "countryCode": {
            "alpha3": "NLD",
            "alpha2": "NL",
            "numeric": "528"
          },
          "stateOrProvince": "NH",
          "city": "Amsterdam",
          "line1": "Langtown Road",
          "line2": "4200",
          "postalCode": "1234BC"
        }
      },
      "version": 1
    }
  ]
}

Changes

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