Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Payment Channel and Method to Curb Events #158

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion events/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,8 @@ A Curb Event is represented as a JSON object, whose fields are as follows:
| `vehicle_propulsion_types` | Array of [Propulsion Type](#propulsion-type) | Conditionally Required | List of propulsion types used by the vehicle that performed the event. Required for sources capable of determining vehicle propulsion type. |
| `vehicle_blocked_lane_types` | Array of [Lane Type](#lane-type) | Conditionally Required | Type(s) of lane blocked by the vehicle performing the event. If no lanes are blocked by the vehicle performing the event, the array should be empty. Required for sources capable of determining it for the following event_types: _park_start_ |
| `curb_occupants` | Array of [Curb Occupant](#curb-occupants) | Conditionally Required | Current occupants of the Curb Zone. If the sensor is capable of identifying the linear location of the vehicle, then elements are sorted in ascending order according to the start property of the linear reference. Otherwise, elements appear in no particular order. Required for sources capable of determining it for the following event_types: _park_start, park_end, scheduled_report_ |
| `actual_cost` | Integer | Optional | If available from the source, the actual cost, in the currency defined in currency, paid by the curb user for this event. The currency type is sent in with the [REST Endpoints](#rest-endpoints) JSON object. All costs should be given as integers in the currency's smallest unit. As an example, to represent $1 USD, specify an amount of 100 (for 100 cents). |
| `actual_cost` | Integer | Conditionally Required | If available from the source, the actual cost, in the currency defined in currency, paid by the curb user for this event. The currency type is sent in with the [REST Endpoints](#rest-endpoints) JSON object. All costs should be given as integers in the currency's smallest unit. As an example, to represent $1 USD, specify an amount of 100 (for 100 cents). |
| `payment_type` | [Payment Type](#payment-type) | Conditionally Required | If available from the source, the method used to pay for this event. |

[Top][toc]

Expand Down Expand Up @@ -247,6 +248,24 @@ Type(s) of lane used or blocked `vehicle_blocked_lane_types` by the vehicle perf

[Top][toc]

### Payment Type

Strings used to indicate how a curb user paid for a curb event.

| Name | Description |
| ----------------- | ------------------------------------------------------ |
| `cash` | Bills or coins at a meter. |
| `credit_card` | Visa, Mastercard, etc at a meter. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Idea to add sub payment type as an option under payment_type. Visa, MC, apple pay, etc. Or V2X payment possible.

| `membership_card` | A card used at a meter to pay via a corporate membership or loyalta program, etc. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could also be smart card or other type of card.

jiffyclub marked this conversation as resolved.
Show resolved Hide resolved
| `mobile` | Paid via a mobile app. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could add QR code or app clip type payment where it's on mobile but not an app.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mobile could potentially be ambiguous, since payment with a mobile app could be done with credit/debit cards, but also with digital wallets, prepaid accounts, permits, etc.

| `sms` | Paid via text message. |
| `billing` | Curb user will be billed for usage at a later time. |
| `permit` | Curb user has a permit allowing them to use the curb without payment. |
| `courtesy` | At a curb that normally requires payment this event for some reason did not. |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

| `other` | Some payment method not captured above (please submit a pull request!). |

[Top][toc]

### Curb Occupants

A Curb Occupant `curb_occupants` object represents a specific vehicle’s occupancy in a curb region at a specific point in time. Curb Occupant objects contain the following fields:
Expand Down