Send Logs request
An overview of the Send Logs request message for iOS.
Our ‘Viva.com Terminal’ application (tap-on-phone) supports Apple Tap to Pay in the the UK, the Netherlands, France, Austria, Czech Republic, Ireland, Romania, and Sweden, Italy & Germany.
Overview
👉 The Send Logs request is used to send the logs of the Viva POS App to the Viva payment platform. This is particularly useful for troubleshooting purposes.
The client app must implement a mechanism to send messages using URL schemes and to receive the result in a custom URI callback.
- Send Logs request originating from the client app to open/close (if possible) a batch.
- Send Logs response originating from the Viva POS App to return the result of a batch request.
Send Logs request
For a typical Send Logs request, the client app must provide the following information:
Field | Description | Example |
---|---|---|
scheme | The Viva's custom URL scheme, the host and the version. | 'vivapayclient://pay/v1' |
merchantKey | The merchant's key. For successful validation, should not be empty. Deprecated: you may pass any value |
'SG23323424EXS3' |
appId | The client app ID. For successful validation, should not be empty. | 'com.example.myapp' |
action | Cancel transaction. For successful validation, should not be empty. | 'sendLogs' |
callback | The URI callback that will handle the result. For successful validation, should not be empty. | 'interapp-callback’ |
The above information elements must create a URI call, i.e.
// USE LIKE THIS
func sendLogs() {
let sendLogsUrlString = Constants.sendLogsUrlString //"vivapayclient://pay/v1?callback=interapp-callback&merchantKey=SG23323424EXS3&appId=com.vivawallet.InterAppDemo&action=sendLogs"
(UIApplication.shared.delegate as? AppDelegate)?.performInterAppRequest(request: Constants.sendLogsUrlString)
}
Send Logs response
After executing an abort transaction, the ‘Viva.com Terminal’ application responds with an abort response result to indicate if the abort request has been successful or not. Also, we should state that the response from the abort action is actually a response of a failed transaction.
The result is received as a URI in the application(_:open:options:)
method on the AppDelegate file.
The table below summarises the contents of a successful response.
Field | Description | Example |
---|---|---|
callback | The URI callback that will handle the result. | 'interapp-callback://result' |
status | The status of the request. | 'success' |
message | A string containing information about the send logs status. | 'Logs sent!' |
action | Send logs. | 'sendLogs' |
A send logs response result looks as follows:
interapp-callback://result?status=success&message=Logs%2520sent!&action=sendLogs
Get Support
If you would like to integrate with Viva, or if you have any queries about our products and solutions, please see our Contact & Support page to see how we can help!