post

/sessions

Overview

This endpoint can be used to create a parking session. A successful response indictaes that the associated user/vehicle is authorized to park for the duration specified.


Details

The receipt_email parameter is required if Passport is configured to send emails for a Partner.

The payment object is required to complete the transaction but the data fields provided may vary depending on your payment integration with Passport. Either the token field or a network_token object and the required fields within that object must be provided.

Request Parameters

2 Headers

Request Body

1 Example
Schema
object
location
object

Standard model to provide location information to an API

payment
object

Represents the payment data used to pay for a parking session.

Depending on the Payment integration with Passport, either you need to send a Passport Payment token in the “token” field or a network_token object with DPAN, Cryptogram, expiration month-year, and ECI (optional).

When a network_token is provided, the provider field is also conditionally required.

quote_id
string

The quote to reference when creating the session.

1 validation + required
receipt_email
string

An email address to which the payment receipt will be sent. This is required if Passport is providing receipt emails for a Partner.

1 validation

Responses

Successful response

2 Headers
1 Example
Schema
object

Represents a parking session; a distinct instance of a user parking for a period of time.

account_id
string

An ID that represents the individual user who the parking session was created for.

duration
number

The duration of the parking session, in minutes.

end_time
string

A timestamp that represents when the session ends. Will be in UTC time formatted as an RFC 3339 timestamp.

id
string

A machine-readable unique identifier for this session.

receipt_email
string

An email address to which the payment receipt will be sent.

reference_id
string

A human-readable identifier for the session used for identifying the session to involved parties.

space_number
string

If the zone is space based, this is the space number used by the parking session.

start_time
string

A timestamp that represents when the session was started. Will be in UTC time formatted as an RFC 3339 timestamp.

status
string

Represents the status of the parking session at the time of the request.

1 validation
total_fees
object

The total cost of the session, is the sum of all transaction related fees.

transactions
array[object]

The set of transactions that have been applied during the life of this session. Session creation will always be present as the initial transaction.

vehicle
object

Represents the key values that identify a vehicle.

zone
object

Represents a location that an operator desires to apply policies and rates to.

Send a Test Request

Send requests directly from the browser (CORS must be enabled)
$$.env
1 variable not set
host