With an integration that uses local communications, your ECR and the payment terminal communicate with each other over your local network.
Messages to implement
You will find below the main message you can implement with our integration;
Some of the messages are mandatory in order to process correctly transactions in an integration mode.
Message | M/O* | Description |
|---|---|---|
M | Opens or Close the payment terminal session. The session must be opened to perform any other operations. | |
M | Initiate a payment request. | |
M | Initiate a refund request. | |
M | Abort an on-going transaction | |
M | Requests the payment terminal to perform an update. | |
M | Performs transaction reversal operation. | |
O | Informs about the status of terminal. | |
O | Checks whether the terminal connection is correct or not. | |
O | Performs terminal activation before first use. | |
M | Tries to find last operation state and provides result if available. | |
O | Reads card identification data including loyalty ID. |
M = Mandatory ; O = Optional
API structure
Our Terminal API communicates with the terminal using XML messages. All requests and responses have the following message header-body structure:
Message header: identifies the type of transaction, the terminal being used, and unique transaction identifiers.
Body: a request or response object, depending on the type of transaction. For example, when you make a payment request this is a PaymentRequest object, and when you receive a payment response this is a PaymentResponse object.
The message header and body of Terminal API requests and responses are described in more detail below.
Requests
Each request you make is contained in a SaletoPOIRequest object. This follows a hierarchical structure containing the following main elements:
MessageHeader : contains metadata about the message itself.
Request body which encapsultates details of the request, depending on the type of operation requested.