Documentation

PTP · Payments

No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.

ROADRoad deviations in this section
  • Payments module Road extensions
    Non-standard additions to the standard OCPI 2.3.0 payments module: the terminal providers listing and provision endpoints, the bare activate endpoint, and Road-custom terminal location assignment and provisioning modes.
    Available on every connection.When not enabled: Only the endpoints defined by the OCPI 2.3.0 payments module.
GET/ptp/payments/financial-advice-confirmations

List financial advice confirmations

Returns the financial advice confirmations shared with the calling party.

Responses
200OCPI response envelope application/json
dataobject[]
idstring
authorization_referencestring
total_costsobject
before_taxesnumber <double>
taxesobject[]
namestring
account_numberstring
percentagenumber <double>
amountnumber <double>
currencystring
eft_datastring[]
capture_status_codestring
capture_status_messagestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/ptp/payments/financial-advice-confirmations/{financial_advice_confirmation_id}

Get a financial advice confirmation

Returns a single financial advice confirmation by its id.

Request
Path parameters1
financial_advice_confirmation_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
idstring
authorization_referencestring
total_costsobject
before_taxesnumber <double>
taxesobject[]
namestring
account_numberstring
percentagenumber <double>
amountnumber <double>
currencystring
eft_datastring[]
capture_status_codestring
capture_status_messagestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/ptp/payments/terminals

List terminals

Returns the payment terminals shared with the calling party.

Responses
200OCPI response envelope application/json
dataobject[]
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
POST/ptp/payments/terminals/activate

Activate a terminal on a payments-capable PTP

Forwards a terminal activation to a PTP that implements the payments module and relays its response envelope. The created terminal is delivered asynchronously to the caller's receiver endpoint.

Request
Request bodyREQUIREDapplication/json
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/ptp/payments/terminals/providers

List terminal providers

Returns the payment terminal providers available to the calling party.

ROADRoad extension: Payments module Road extensions
Responses
200OCPI response envelope application/json
dataobject[]
party_idstring
country_codestring
namestring
implements_payments_moduleboolean
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
POST/ptp/payments/terminals/provision

Provision a terminal

Provisions a payment terminal for a PTP that does not implement the payments module itself.

ROADRoad extension: Payments module Road extensions
Request
Request bodyREQUIREDapplication/json
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
GET/ptp/payments/terminals/{terminal_id}

Get a terminal

Returns a single payment terminal by its id.

Request
Path parameters1
terminal_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
PATCH/ptp/payments/terminals/{terminal_id}

Patch a terminal

Partially updates a payment terminal.

Request
Path parameters1
terminal_idstringREQUIRED
Request bodyREQUIREDapplication/json
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
POST/ptp/payments/terminals/{terminal_id}/activate

Activate a terminal

Activates a payment terminal.

ROADRoad extension: Payments module Road extensions
Request
Path parameters1
terminal_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.
POST/ptp/payments/terminals/{terminal_id}/deactivate

Deactivate a terminal

Deactivates a payment terminal. An internally provisioned terminal is toggled locally; a PTP-owned terminal has the deactivation forwarded to the owning PTP first and the state is stored once the PTP acknowledges it.

Request
Path parameters1
terminal_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
status_codeinteger
status_messagestring
timestampstring
401Missing or invalid OCPI token
No response body.