API docs by Redocly

Transactions API (1.0.0)

Download OpenAPI specification:

List registered product codes

List all product codes registered by the authenticated provider, identified by its API key.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • "PARKING_DAILY",
  • "PARKING_HOURLY"
]

Register product codes

Register product codes that the authenticated provider intends to use in transactions. The provider is identified by its API key. Registration is additive and safe to retry. Already registered codes are ignored, new codes are registered, and omitted codes remain registered.

Authorizations:
bearerAuth
Request Body schema: application/json
required

Product codes to register for the authenticated provider.

Array (non-empty)
string non-empty

Provider product code intended for use in the product_code field of a transaction.

Responses

Request samples

Content type
application/json
[
  • "PARKING_HOURLY",
  • "PARKING_DAILY"
]

Create transactions

Each product_code must already be registered by the authenticated provider.

Authorizations:
bearerAuth
Request Body schema: application/json
required
Array (non-empty)
id
required
string <uuid>

Unique identifier of the transaction.

amount
required
number <double>

Gross transaction amount including tax, expressed in the currency specified by currency_code. Subtract tax_amount to calculate the net amount.

tax_amount
required
number <double>

Tax included in the gross transaction amount, expressed in the currency specified by currency_code. The net amount is amount minus tax_amount.

currency_code
required
string^[A-Z]{3}$

ISO 4217 three-letter uppercase currency code for the transaction amounts.

product_code
required
string

Code identifying the product associated with the transaction. Must already be registered by the authenticated provider through POST /api/v1/product-codes.

booking_date
required
string <date-time>

Date and time the transaction was booked, formatted according to RFC 3339 with a timezone offset or Z for UTC.

payment_date
required
string <date-time>

Date and time of the payment, formatted according to RFC 3339 with a timezone offset or Z for UTC.

parking_start_date
required
string <date-time>

Date and time the parking session started, formatted according to RFC 3339 with a timezone offset or Z for UTC.

parking_end_date
required
string <date-time>

Date and time the parking session ended, formatted according to RFC 3339 with a timezone offset or Z for UTC.

cost_center
required
string

Cost center code associated with the transaction.

cancellation_date
string or null <date-time>

Date and time of cancellation, formatted according to RFC 3339 with a timezone offset or Z for UTC. A non-null timestamp identifies a cancellation. Omit or set to null if the transaction has not been cancelled.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "code": "UNREGISTERED_PRODUCT_CODES",
  • "message": "Register these product codes before submitting transactions.",
  • "product_codes": [
    ]
}