post https://api.sandbox.cleeng.com/3.1/passes
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 broadcaster 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 broadcaster will need to send the termination request to revoke access).
Beta
Please note that it is a Beta phase.
Response description
| Response | Type | Description |
|---|---|---|
passId | integer | Pass identifier in Cleeng. |
customerId | integer | The identifier of Cleeng customer. |
status | string | The current status of a pass. One of: active, terminated. |
offerId | string | The identifier of Cleeng offer, e.g. S123123123_US. |
expiresAt | integer | Expiration time (in UNIX timestamp format). |
externalId | string | The external identifier of a pass. |
paymentMethodId | integer | The identifier of the payment method, provided by Cleeng. |
externalProperties | object | External properties that can be used to store additional metadata from the external system, e.g. partnerID, externalProductId, partnerCode, etc. |
isExternallyManaged | boolean | Whether a pass is externally-managed or not. |
source | string | A system that initiates and manages pass lifecycle and/or payments. It can be an internal source - cleeng - for Cleeng-managed passes or an external source - e.g. samsung - for externally-managed passes. |