Implement your payment flow
This chapter describes the structure of the message payloads, and is applicable to both Local and Cloud Integration
All messages are of either type;
- 'SaleToPOIRequest' or
- 'SaleToPOIResponse',
which contains the actual request or response for the specific message category.
NOTE: 'SaleToPOIRequest' is used for all requests and 'SaleToPOIResponse' is used for all responses, regardless of message direction . For example, if the terminal (POI) sends a request to the ECR (Sale), it is still called 'SaleToPOIRequest'.
Supported messages
The following table provides an overview of the messages supported by Aera.
| Function | Description | Message Class | Message Category |
|---|---|---|---|
| Login | Establish a session between ECR and terminal | Service | Login |
| Logout | End session between ECR and terminal | Service | Logout |
| Card acquisition | Acquirers card data from the card, to be followed by a payment request, balance inquiry request or load stored card request | Service | CardAcquisition |
| Payment | Perform a regular payment | Service | Payment |
| Payment with loyalty lookup | Perform a payment with a preceding loyalty lookup | Service | Payment |
| Payment with cashback | Perform a payment with a cashback amount included the requested amount, for cash withdrawal the cashback amount is equal to the requested amount | Service | Payment |
| Cash advance | Cash advance (cash withdrawal or cashout) for BankAxept KIB ("kontanttjenester i butikk") | Service | Payment |
| Cash deposit | Cash deposit for BankAxept KIB ("kontanttjenester i butikk") | Service | Payment |
| Refund | Refund to the card account of the presented payment card | Service | Payment |
| Activate and load stored value card | Activation and load of gift cards | Service | StoredValue |
| Card Balance Inquiry | Balance request of stored value cards | Service | BalanceInquiry |
| Reconciliation | Closing a reconciliation period or requsting a reconciliation report | Service | Reconciliation |
| Get customer identity | Using CardAcquisition to look up customer identity | Service | CardAcquisition |
| Customer Onboarding | Using CardAcquisition request to collect reference to card data and Display and Input requests to request customer to enter mobile number in the terminal, out of bounds customer onboarding and link to card data | Service | CardAcquisition |
| TransactionStatus | Get status of a previous transaction | Service | TransactionStatus |
| Diagnosis | Check connectivity between ECR and terminal, and terminal and payment host | Service | Diagnosis |
| Abort | Attempt to abort transaction. | Service | Abort |
| Abort after CardAcquisition request | Abort further processing after a CardAcquistion request | Service | EnableService |
| Reversal | Manual reversal of last transaction | Service | Reversal |
| Display | Send message to be displayed on ECR | Device | Display |
| PIN | Request PIN entry on terminal | Device | PIN |
| Event | Used for unsolicited event notifications to the ECR, and as a response to unparseable requests from ECR. | Event | Event |
| Voice authorisation | Voice authorisation for BankAxept backup solution | Device | Input |
Messages of class "Service" are always sent from ECR to terminal, and come in Request and Response pairs, with the exception of Abort which only has a Request message.
Messages of class "Device" can be sent by either ECR or terminal, depending on the use case.
Messages of class "Event" are always sent from the terminal to the ECR and require no response.
Updated 13 days ago