Hii Mobile Payments
The Mobile Payments Service enables mobile payment transactions for HiiRetail customers. This document provides an overview of the service, including its purpose, components, and usage.
Overview
The Hii Mobile Payments service is designed to process mobile payment flows for mobile app payments. It is built on a microservices architecture, with each Mobile Payment Connector deployed as a separate microservice. The service is designed to be highly available, scalable, and secure, handling high transaction volumes and providing real-time payment processing capabilities.
The Mobile Payments Flow covers the following components:
- Mobile Payment Plugins - Mobile Payment Plugins are used to integrate the POS system (checkout engine) with the Mobile Payment Service.
- Mobile Payment Connector - The Mobile Payment Connector is responsible for processing mobile payment requests and handling the payment response for a specific provider. It acts as a singular microservice that internally decides which provider to use based on the path of the request. After processing the payment response, the Mobile Payment Connector dispatches the response to the Outbox Service.
- Mobile Payment Outbox Service - The Outbox Service listens to events from the Mobile Payment Connector and stores them in a database waiting for the POS System to pick them up by polling.
Integration & Usage
To use the Mobile Payments Service, developers can:
- Integrate with the Mobile Payment Plugins to enable mobile payment transactions.
- Implement the Unified Mobile Payment API to submit mobile payment requests to the Mobile Payment Connector.
APIs
The following APIs are part of Hii Mobile Payments:
- Unified Mobile Payment API
- API used by Checkout Engine and potentially other POS systems to integrate with once to be able to use any existing PSP connector. This API is available as a Open API. The message format is defined as JSON schema.
- This API is supported by every Mobile Payment Connector.
Features
The Unified Mobile Payment API provides the following operations:
- Payment: Initiate a payment transaction. The customer will be prompted to enter their payment details (phone number) and to approve the transaction on the mobile device in order to complete the payment.
- QR payment: Initiate a QR code payment transaction. The cashier will scan the QR code from the customer's mobile device to initiate the payment.
- Refund: Refund money to the customer
- Abort: Abort an ongoing payment transaction
- Void: Revert a payment or a refund transaction after its completion
The exact type of transactions supported may vary depending on the mobile payment provider.
Mobile Payment Connectors
The Mobile Payment Service integrates with the following mobile payment providers:
Provider | Documentation | API |
---|---|---|
Swish | Swish Docs | https://developer.hiiretail.com/api/swish-connector-apis/ |
Vipps | Vipps Docs | https://developer.hiiretail.com/api/vipps-connector-apis/ |