Create a pass

Use this endpoint to create externally-managed passes.

The life cycle of externally-managed passes is managed outside of Cleeng so it is up to a publisher to notify Cleeng about pass status changes, e.g. the change of pass expiration date or pass termination if auto-termination is not enabled (if auto-termination is not enabled for the payment method, Cleeng platform will not terminate the pass when expiry date is reached, and the publisher will need to send the termination request to revoke access).

You can create multiple passes for the same offer and customer with this endpoint. But the endpoint prevents duplicate passes with the same external ID and source. It only allows new passes if there isn't already an active pass from the same source and with the same external ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

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

string
required

The identifier of Cleeng offer.

int32
required

The identifier of the payment method configured for externally-managed passes; provided by Cleeng.

string
required

The external identifier of a pass. The identifier must be unique for a given payment method (i.e. you can't have two identical identifiers for the same payment method).

int32

Expiration time in UNIX timestamp format. For non-expiring (permanent) passes it must be set to null. If the parameter is not provided, expiresAt will be calculated based on an offer.

externalProperties
object

Any external properties of a pass. Payload is limited to 4000 characters.

int32

The identifier of Cleeng payment. (Payment must be created with the same paymentMethodId as specified here).

Headers
string
Defaults to application/json
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json