Overview
The Filling Service API supports forecourt operations by enabling communication between an IFSF-compliant Mobile Payment Processing Application (MPPA) and Vynamic FCx MobilePay Service.
MPPA, in conjunction with a dedicated mobile app, enables consumers to select filling station, choose fuel grade, lock the pump and pay for fuel directly on a mobile app.
Vynamic FCx is Diebold Nixdorf's strategic next generation point-of-sale and back-office solution for filling station operators. It is cloud-native and based on microservices.
The Filling Service API integrates MPPA with Vynamic FCx MobilePay Service.
Features
The Filling Service API enables Vynamic FCx to:
Login (POST /mppa/login) to and logoff (POST /mppa/logoff) from MPPA. Login informs MPPA that the site (filling station) is ready to receive requests. When the site is logged off, it will not accept any MPPA requests. That site will not be available for selection on the mobile app.
Send filling station details (POST /mppa/siteInformation) to MPPA, so it can be displayed to the consumer on their mobile app. Site information includes site's location (physical address) and pump products (types of fuel with prices, grades, units of measure).
Monitor the connection to MPPA by sending a diagnosis (POST /mppa/diagnosis) request.
Inform the MPPA that the consumer has lifted the pump's nozzle (event - POST /mppa/event).
Send final sales information (POST /mppa/cardFinancialAdvice) and ticket information (POST /mppa/output) to MPPA, so it can be displayed to the consumer on their mobile app.
Reconcile fuel sales between MPPA and Vynamic FCx (POST /mppa/globalReconciliationWithClosure).
Send information to MPPA that the consumer's order was cancelled by the cashier (abort request - POST /mppa/abortRequest), so that this information can be displayed to the consumer on their mobile app.
The Filling Service API also enables MPPA to:
Lock pump (POST /mobile-pay/reservePump) - Consumer may pick a filling station and a pump on their mobile app. This information will be sent to the Vynamic FCx POS component and displayed to the cashier.
Abort (POST /mobile-pay/abortRequest) - Consumer may decide to cancel their fuel order on their mobile app before starting the filling. This information will be sent to the Vynamic FCx services.
Set pump preset (POST /mobile-pay/mobileAuth) - When the consumer has successfully made the pre-authorization payment for the fuel order, MPPA will send a pump preset request to Vynamic FCx.
Send sales ticket information to Vynamic FCx. MPPA also provides Vynamic FCx service with an EFT block information after a successful fuel sale (POST /mobile-pay/output).
Send a health check request to Vynamic FCx (GET /mobile-pay/healthCheck).
Use Cases
The Filling Service API supports the following use cases:
Consumer selects a manned filling station, chooses fuel grade and locks the pump directly on their mobile app. Consumer then confirms the fuel order and makes a pre-authorization payment for it via the mobile app. From that point on, three possible paths are available:
- Consumer fuels the car and finalizes the sale process on the mobile app, without visiting the POS. Or
- Consumer decides to cancel the order before starting the filling. The pump is unlocked. Or
- The filling cannot proceed and the cashier cancels the customer's request. Pump is unlocked and the consumer receives a message on their mobile app.
Sequence diagram
The following diagram illustrates the sequence of interactions for the 3 use cases outlined above:
Built-in Resiliency
We have built resiliency into the Vynamic FCx to MPPA integration by adding the following features:
Additional storage component for the reconciliation message - In case of MPPA failure, a dedicated software component will attempt to redeliver the reconciliation message as soon as it detects that Vynamic FCx has re-established the connection with MPPA and has successfully sent the filling site information to MPPA.
ReLogin flow - As soon as Vynamic FCx receives a message from MPPA that the request could not be processed, FCx will attempt to re-establish the connection to MPPA by sending a Login request and Site Information requests. When the connection is re-established, FCx resends the failed request. This functionality was implemented for the following endpoints in the Filling Service API:
- POST /mppa/siteInformation
- POST /mppa/event
- POST /mppa/abortRequest
- POST /mppa/cardFinancialAdvice
- POST /mppa/output
ReLogin flow example:
Security
The Filling Service API supports OAuth 2.0 for authentication purposes.
The supported protocol for the Filling Service API is HTTPS.