v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

List passes [Beta]

This endpoint returns passes that match the specified criteria (transactionId, paymentMethodId, externalId, customerId or offerId and customerId together). Please bear in mind that if you don't provide any parameters, an empty list will be returned. <br><br> Note: Filtering by customerId and offerId might return multiple active passes instead of one if multiple passes have been created for the same offer.

get/passes

Query parameters

transactionIdstring

A unique identifier of a transaction (e.g. T123456789).

customerIdinteger

The identifier of Cleeng customer. Minimum: 100000000, maximum: 999999999.

offerIdstring

The identifier of Cleeng offer. If you want to use this parameter for search, you have to provide customerId, too.

paymentMethodIdinteger

The identifier of the payment method, provided by Cleeng.

externalIdstring

The external identifier of a pass.

offsetinteger

From which element you want to get results - defines the number of first results that are skipped.

Headers

Content-Typestring

Response

200

passIdinteger

customerIdinteger

statusstring

offerIdstring

{"stackTrail":"paths:/passes:get:responses:200:content:application/json:schema:items:properties:expiresAt","oasType":"schema","type":"unknown"}

paymentMethodIdinteger

externalIdstring

isExternallyManagedboolean

sourcestring

Example response

[
  {
    "passId": 123456789,
    "customerId": 123123123,
    "status": "active",
    "offerId": "P987654321_PL",
    "paymentMethodId": 111222333,
    "externalId": "externalId",
    "externalProperties": {
      "property1": "example1",
      "property2": "example2"
    },
    "isExternallyManaged": true,
    "source": "samsung"
  }
]