CPO · 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.
POST/cpo/payments/financial-advice-confirmations
Create a financial advice confirmation
Submits a financial advice confirmation to the CPO.
Request
Request bodyREQUIREDapplication/json
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>
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/cpo/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/cpo/payments/terminals
List terminals
Returns the payment terminals the calling PTP has created with the CPO, paginated via date_from, date_to, offset and limit query params.
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/cpo/payments/terminals
Create a terminal
Registers a payment terminal with the CPO.
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/cpo/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.