• Payment-Terminal Payment API

Payment

get

retrieve a list of payments

This endpoint retrieves a list of all payments available to the authenticated user.

paramsobject (PaymentQuery)
skipstring

Number of documents to skip when fetching the result.

limitstring

The maximun number of availiable documents in the response.

networkIdstring

The network associated with the payment object.

providerstring

The provider of the payment object.

Enum
  • PAYTER
  • MAGTEK
assetIdstring

The assetId of the charging device associated with this payment object.

connectorIdstring

The connector Id of the charging device associated with this payment object.

startIsoTimestampstring

The starting datetime applied to this query.

Format
date-time
endIsoTimestampstring

The ending datetime applied to this query.

Format
date-time

Responses

Response examples

A list of payment objects as the result of the query

{
  "data": {
    "hasMore": true,
    "items": [
      {
        "provider": "PAYTER",
        "providerRefId": "string",
        "committedAmountInCent": 123.0,
        "currency": "USD",
        "sessionId": "string",
        "networkId": "string",
        "assetId": "string",
        "connectorId": 123.0,
        "createdAt": "2023-06-07T17:32:28Z",
        "updatedAt": "2023-06-07T17:32:28Z"
      }
    ]
  }
}

Was this page helpful?