Skip to main content

Connecting Platforms

Testing OCPI

Unlike other integrations, Payter's OCPI implementation is reliant on a minimum level of development already having been completed.

We are unable to provide a sandbox or demonstration of the solution, although we can connect any of your environments to our Staging or Live environment as needed.

This means much of the development effort must be completed, before the two platforms should be connected.

Connecting the Payter OCPI platform to a CPO platform relies on functionality in the Credentials module. The below is a summary of this only, and the original specification should be the primary source of information.

Payter Platform Structure​

Payter offer a simple hierarchy in our OCPI offering. A CPO Platform will complete a handshake. Once done, multiple potentially differently configured Contracts can be set up for that platform. This is not required however. A new handshake can be completed for each new sub-entity that a given CPO, or a Software as a Service provider reselling to multiple CPO's, wants to onboard.

Platform Handshake​

This can be completed in either direction. Payter details are in (brackets) below.

Where Payter are the receiver, we would supply this data to the CPO platform who would initiate the handshake. In the other direction, a CPO could provide us all this data and we could initiate registration.

Contract Creation​

Terminals are assigned to contracts so that individual customers can be iterated. In Payter's OCPI implementation, we send the CPO a customer_reference which is detailed in the Terminals module. A CPO should expect this specific refence, so prior to creating a contract and assigning terminals, a CPO should confirm the required customer_reference so the PATCH method Payter's solution uses is authorised and properly formed.

Assign a Location to a Terminal​

CPO's are responsible for this step, completed using the Tariffs and Locations and Terminals modules. CPO's can push (PATCH) this data to Payter, or Payter can GET this using a Polling mechanism. In Live, this polling can be no more frequent than every 60 mins, to reduce server load.

Configuring a Terminal​

When a CPO has assigned terminals, Payter then finally configure them to be usable.

An OCPI compliant CPO platform should now be able to complete charge sessions using Payments.

caution

We will complete all of these steps in our Staging environment before we attempt any live deployments.