TAP ON PHONE - Getting Device Information (PrepareDevice - Get device information before performing Tap On Phone transaction)
Learn how to use the PrepareDevice function to retrieve information about a device before performing a Tap On Phone transaction.
When should this function be used?
This function is intended for merchants who work with the TAP ON PHONE model and want to retrieve information about the device.
Below is a link to the JSON function.
Request method - POST.
PrepareDevice - Get device information before performing Tap On Phone transaction
https://secure.cardcom.solutions/api/v11/TapTransactions/PrepareDevice
The parameters that must be passed to the function are listed below.
Legend:
Red parameter - required
Bold parameter - recommended
Parameter that is neither red nor bold - optional
| Number |
Parameter | Example values | Description |
| 1 | ApiName | test2025 | Interface username |
| 2 | ApiPassword | "kzFKfohEvL6AOF8aMEJz" | API password, intended for crediting and canceling transactions. |
| 3 | TerminalNumber | 1000 | The terminal performing the operation - an internal number, not a Shva number. |
| 4 | DeviceUUID | (String) | The device UUID |
| 5 | DeviceManufacturer | (String) | The phone manufacturer. |
| 6 | DeviceModel | (String) | A unique identifier for the device |
RESPONSE for ProcessTransaction - Process Tap On Phone transaction.
| Number |
Parameter | Example values | Description |
| 1 | ResponseCode | 0 | 0 - The operation was successful Otherwise - Invalid; a development error occurred. |
| 2 | Description | "The transaction was completed successfully" | Response description. If a different response is received, the transaction was not completed successfully. |
| 3 | TPN | (string) | TPN for the Tap On Phone device |
| 4 | MerchantCode | (string) | Merchant code for the Tap On Phone device |
| 5 | SapakMutavNumber | (string) | Beneficiary provider number for the Cardcom terminal number sent in the request |
| 6 | RavMutavTerminalNumber | (Int) | Cardcom's multi-beneficiary terminal number derived from the terminal number sent in the request |
Below is sample code for the function together with the response.
Request example:
{
"ApiName": "string",
"ApiPassword": "string",
"TerminalNumber": 0,
"DeviceUUID": "string",
"DeviceManufacturer": "string",
"DeviceModel": "string"
}
"ApiName": "string",
"ApiPassword": "string",
"TerminalNumber": 0,
"DeviceUUID": "string",
"DeviceManufacturer": "string",
"DeviceModel": "string"
}
Example response:
{
"ResponseCode": 0,
"Description": "string",
"TPN": "string",
"MerchantCode": "string",
"SapakMutavNumber": "string",
"RavMutavTerminalNumber": 0
}
"ResponseCode": 0,
"Description": "string",
"TPN": "string",
"MerchantCode": "string",
"SapakMutavNumber": "string",
"RavMutavTerminalNumber": 0
}