Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release Number | Enhancements | API Version |
|---|---|---|
| 2024.2-SP5 and Patch in API 2024.2 | We extended the GET /api/v1/mobile-pay/healthCheck endpoint with the following fields: - moreDetails.service - it depicts a backend service URL, - moreDetails.response - it depicts a backend service response. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy. We also enhanced the health check transformation logic: - for status codes other than 200, the API provides "Unhealthy" response with the respective status message. | v1 |
| 2023.3-SP2, 2024.1, 2024.2, 2024.2-SP5 | In order to standardize communication and facilitate customization between public APIs and 3rd-party Mobile Payment Processing Applications (MPPA), we extended Filling SAPI with an ADDITIONAL_HEADERS configuration parameter. This parameter is optional and can be defined as needed. | v1 |
| 2024.2 | To support concurrent communication with multiple Mobile Payment Processing Applications (MPPA) in the same store or station, we introduced the following changes: - In the following endpoints calling from Vynamic FCx to MPPA: -POST /api/v1/mppa/login, -POST /api/v1/mppa/logoff, -POST /api/v1/mppa/siteInformation, -POST /api/v1/mppa/diagnosis, -POST /api/v1/mppa/event, -POST /api/v1/mppa/abortRequest, -POST /api/v1/mppa/cardFinancialAdvice, -POST /api/v1/mppa/output, -POST /api/v1/mppa/globalReconciliationWithClosure we added the optional request field: mppaId in EAPI and PAPI layers. Using this parameter, you can connect to different mobile applications via multiple SAPIs (one per MPPA). If the parameter is provided, a configurable PAPI calls to a dedicated SAPI. SAPI URL depends on the mppaId value. If the parameter is not provided, the default SAPI is called. - In the following endpoints calling from MPPA to Vynamic FCx: POST /mobile-pay/abortRequest, GET /mobile-pay/healthCheck, POST /mobile-pay/reservePump, POST /mobile-pay/output, POST /mobile-pay/mobileAuth we added new PAPI and SAPI request field: mppaId to be passed to FCx (backend only). This mppaId code is obtained based on authorization token (different for each MPPA). As for the current scope, these changes are not not used by FCx. | v1 |
| 2024.2 | The Vynamic FCx MobilePay Service and Mobile Payment Platform Application (MPPA) are extended to handle loyalty scenarios in the pre-authorization flow (for instance, DN's Vynamic Engage coupouns and vouchers, as well as 3rd-party Loyalty hosts). To support this enhancement we introduced the following changes: - we added the following request fields: cardValues [], saleItem.priceAdjustment [] and response fields: tender.authorization.cardCircuit, cardValues.cardCircuit, cardValues.cardAmount to the POST /api/v1/mppa/cardFinancialAdvice endpoint. - we added the request field tender.authorization.cardCircuit to the POST /api/v1/mppa/abortRequest and POST /api/v1/mobile-pay/abortRequest endpoints. - we added the request field cardValues.cardAmount to the POST /mobile-pay/mobileAuth endpoint. | v1 |
| 2023.3 | Sending the Card Financial Advice is a mandatory step of the IFSF OMPI flow. In relation to this, we have now extended VAT related attributes in the POST /api/v1/mppa/cardFinancialAdvice endpoint to correct the issue where receipts generated by the mobile payment service (MPPA) were delivered without a visible VAT value. We have now added the following optional fields to the Card Financial Advice (CFA) request: - saleItem.taxCode - saleItem.taxPercentage - saleItem.vatAmount To be consistent with the current implementation, we added information about no validation rule defined for fields size. | v1 |
| 1.5 | To complement the FCx feature released in Q3 2022, we have released the Filling Service API which integrates FCx with MPPA. The Filling Service API exposes the following endpoints: POST /api/v1/mppa/login, POST /api/v1/mppa/logoff, POST /api/v1/mppa/siteInformation, POST /api/v1/mppa/diagnosis, POST /api/v1/mppa/event, POST /api/v1/mppa/output, POST /api/v1/mppa/globalReconciliationWithClosure, POST /api/v1/mppa/abortRequest, POST /api/v1/mobile-pay/reservePump, POST /api/v1/mobile-pay/abortRequest, POST /api/v1/mobile-pay/mobileAuth, POST /api/v1/mobile-pay/output, GET /api/v1/mobile-pay/healthCheck | v1 |