Skip to main content

PostParkingLotTransactionRequest

messageIdstring<uuid>required

Unique identifier for the transaction

enforcementData objectrequired

Set of attributes for the transaction related to parking enforcement

transactionNumberstring<uuid>required

Business identifier for the transaction or parking session

ticketNumberstring<uuid>

Identifier from the ticket (or similar) supplied to the customer for their purchase. May be the same as transactionNumber.

transactionTypestring

Possible values: [NEW, EXTEND, UPDATE, CANCEL, TEST]

transactionDateTimestring<date-time>

Date & time that the transaction occurred (e.g. purchase date), required for all transactions where a payment is processed.

zonestring

Description of the zone. This is free form text.

vendorLotIdstringrequired

Location identifier from the vendor.

licensePlatestring
licensePlateStatestring

State/Province issuing the license plate.

stallNumberstring
mobilePhoneNumberstring

Mobile phone number of the parker.

barcodestring

Barcode used to gain entry to the lot.

parkerIdstring

Additional parker identifier if required.

fromDateTimestring<date-time>required

Start date plus time for transaction.

toDateTimestring<date-time>required

End date plus time for transaction.

fromTimeMonstring<date-time>

Start time for parking sessions on Mondays (for MPS).

toTimeMonstring<date-time>

End time for parking sessions on Mondays (for MPS).

fromTimeTuestring<date-time>

Start time for parking sessions on Tuesdays (for MPS).

toTimeTuestring<date-time>

End time for parking sessions on Tuesdays (for MPS).

fromTimeWedstring<date-time>

Start time for parking sessions on Wednesdays (for MPS).

toTimeWedstring<date-time>

End time for parking sessions on Wednesdays (for MPS).

fromTimeThustring<date-time>

Start time for parking sessions on Thursdays (for MPS).

toTimeThustring<date-time>

End time for parking sessions on Thursdays (for MPS).

fromTimeFristring<date-time>

Start time for parking sessions on Fridays (for MPS).

toTimeFristring<date-time>

End time for parking sessions on Fridays (for MPS).

fromTimeSatstring<date-time>

Start time for parking sessions on Saturdays (for MPS).

toTimeSatstring<date-time>

End time for parking sessions on Saturdays (for MPS).

fromTimeSunstring<date-time>

Start time for parking sessions on Sundays (for MPS).

toTimeSunstring<date-time>

End time for parking sessions on Sundays (for MPS).

stallTypestring

Type of stall the parker is eligible to occupy (for MPS)

Possible values: [RND, RNS, RES]

arriveByDateTimestring<date-time>

Parker must enter lot prior to this time.

equipmentIdstring

Machine ID from meter or similar value.

vipPassStatusboolean

White List only.

paymentData object

Set of attributes for the transaction related to payment.

totalCollectionAmountnumber

The total amount collected for the transaction.

excessPaymentAmountnumber

The excess amount paid for this transaction (e.g. where change is not available at a meter).

taxFederalAmountnumber

Federal Tax (e.g. GST) in dollars.

taxStateAmountnumber

State/Provincial Tax in dollars.

taxMunicipalAmount number

Municipal Tax in dollars.

paymentType string

Possible values: [CASH, CREDIT, DEBIT, SMART, PASS, CASH_CC, CASH_SC, CASH_PASS, UNKNOWN]

rateId string

Identifier for the rate used.

cardType string

Credit card type (if applicable).

Possible values: [VISA, MC, AMEX, DISC, DC, OTHER]

maskedCreditCardNumber string

Partial masked credit card number (e.g. last 4 digits) for the card used in the transaction.

authCode string

Credit card authorization code from processor.

customerData object

Set of attributes for the parker or customer for this transaction.

parkerNamestring

First Name + Last Name or Business Name of the parker.

emailstring

Parker contact email

addressLine1string

Street from parker contact/billing address.

addressLine2string

Street from parker contact/billing address.

citystring

City from parker contact/billing address.

statestring

State/province from parker contact/billing address.

countrystring

Country from parker contact/billing address.

postalCodestring

Postal Code/Zip Code from parker contact/billing address

additionalData object

Additional vendor data in key-value pairs.

property name*string
PostParkingLotTransactionRequest
{
  "messageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "enforcementData": {
    "transactionNumber": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ticketNumber": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "transactionType": "NEW",
    "transactionDateTime": "2024-07-29T15:51:28.071Z",
    "zone": "string",
    "vendorLotId": "string",
    "licensePlate": "string",
    "licensePlateState": "string",
    "stallNumber": "string",
    "mobilePhoneNumber": "string",
    "barcode": "string",
    "parkerId": "string",
    "fromDateTime": "2024-07-29T15:51:28.071Z",
    "toDateTime": "2024-07-29T15:51:28.071Z",
    "fromTimeMon": "2024-07-29T15:51:28.071Z",
    "toTimeMon": "2024-07-29T15:51:28.071Z",
    "fromTimeTue": "2024-07-29T15:51:28.071Z",
    "toTimeTue": "2024-07-29T15:51:28.071Z",
    "fromTimeWed": "2024-07-29T15:51:28.071Z",
    "toTimeWed": "2024-07-29T15:51:28.071Z",
    "fromTimeThu": "2024-07-29T15:51:28.071Z",
    "toTimeThu": "2024-07-29T15:51:28.071Z",
    "fromTimeFri": "2024-07-29T15:51:28.071Z",
    "toTimeFri": "2024-07-29T15:51:28.071Z",
    "fromTimeSat": "2024-07-29T15:51:28.071Z",
    "toTimeSat": "2024-07-29T15:51:28.071Z",
    "fromTimeSun": "2024-07-29T15:51:28.071Z",
    "toTimeSun": "2024-07-29T15:51:28.071Z",
    "stallType": "RND",
    "arriveByDateTime": "2024-07-29T15:51:28.071Z",
    "equipmentId": "string",
    "vipPassStatus": true
  },
  "paymentData": {
    "totalCollectionAmount": 0,
    "excessPaymentAmount": 0,
    "taxFederalAmount": 0,
    "taxStateAmount": 0,
    "taxMunicipalAmount ": 0,
    "paymentType ": "CASH",
    "rateId ": "string",
    "cardType ": "VISA",
    "maskedCreditCardNumber ": "string",
    "authCode ": "string"
  },
  "customerData": {
    "parkerName": "string",
    "email": "string",
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "state": "string",
    "country": "string",
    "postalCode": "string"
  },
  "additionalData": {}
}