PTP · Payments
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
ROADPayments module
Terminal and financial-advice-confirmation endpoints on the CPO interface plus the whole PTP role, anticipating the OCPI 2.3.0 payments module. Includes the non-standard terminal providers listing and provision endpoints. Not part of the OCPI 2.2.1 specification. Available on every connection.
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[]
dataobject[]
idstring
authorization_referencestring
total_costsobject
total_costsobject
excl_vatnumber <double>
incl_vatnumber <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
dataobject
idstring
authorization_referencestring
total_costsobject
total_costsobject
excl_vatnumber <double>
incl_vatnumber <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[]
dataobject[]
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
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
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.
Responses
200OCPI response envelope application/json
dataobject[]
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.
Request
Request bodyREQUIREDapplication/json
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
dataobject
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
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
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
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
coordinatesobject
latitudestring
longitudestring
invoice_base_urlstring
invoice_creatorstring
location_idsstring[]
evse_uidsstring[]
referencestring
last_updatedstring <date-time>
Responses
200OCPI response envelope application/json
dataobject
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
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.
Request
Path parameters1
terminal_idstringREQUIRED
Responses
200OCPI response envelope application/json
dataobject
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
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
dataobject
terminal_idstring
customer_referencestring
party_idstring
country_codestring
addressstring
citystring
postal_codestring
statestring
countrystring
coordinatesobject
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.