TAP ON PHONE - Process a Transaction - (ProcessTransaction - Process Tap On Phone transaction)
When should this function be used?
This function is intended for businesses that use the TAP ON PHONE model and want to process a transaction.
Below is a link to the function in JSON.
Request method: POST.
ProcessTransaction - Process Tap On Phone transaction
https://secure.cardcom.solutions/api/v11/TapTransactions/ProcessTransaction
The following parameters must be passed to the function.
Legend:
Red parameter - Required
Bold parameter - Recommended
Parameter that is neither red nor bold - Optional
| No. | Parameter | Example values | Description |
|---|---|---|---|
| 1 | ApiName | test2025 | API username. |
| 2 | ApiPassword | "kzFKfohEvL6AOF8aMEJz" | API password, intended for refunds and transaction cancellations. |
| 3 | TerminalNumber | 1000 | The terminal that performs the action - an internal number, not the external terminal number. |
| 4 | RavMutavTerminalNumber | (Int) | The terminal number of the authorized institution (internal terminal number). |
| 5 | DeviceUUID | (String) | Unique device identifier. |
Values of the TransactionInfo object (6).
| No. | Parameter | Example values | Description |
|---|---|---|---|
| 1 | Amount | (String) "150" | Transaction amount. |
| 2 | Type | (Int) 1 - Charge, 51 - Refund | Transaction type. |
| 3 | CreditType | (Int) 1 - Regular charge, 6 - Credit installments, 8 - Regular installments | Credit transaction type. |
| 4 | NumberOfPayments | (Int) | Number of payments. |
| 5 | CustomerName | (String) | Customer name. |
| 6 | CustomerEmail | (String) | Customer email address. |
| 7 | CustomerPhoneNumber | (String) | Customer phone number. |
| 8 | CustomerIdNumber | (String) | Customer ID number. |
| 9 | ResponseCode | (Int) | 0 - The action was successful. Any other value indicates an error - a development error. |
| 10 | Message | (String) | Transaction message. |
| 11 | Status | (String) | Transaction status. |
| 12 | TransactionId | (Int) | Transaction number. |
| 13 | ReturnCode | (Int) | Code to return after the transaction. |
| 14 | ReturnMessage | (String) | The message returned in the response. |
| 15 | CardNumber | (String) | Card number. |
| 16 | CardExpireDateMMYY | (String) | Card expiration date. |
| 17 | CardBrandCode | (Int) Card brand code | Card brand. |
| 18 | CardIssuerCode | (Int) Issuer code | Issuing company. |
| 19 | CardFinancerCode | (Int) | Card financier code. |
| 20 | Token | (String) | Token used for charging. |
| 21 | ApprovalNumber | (String) | Approval number. |
| 22 | ResultRecord | (String) | Result record. |
| 23 | UID | "21121517002429612920744" | Unique transaction identifier. |
ProcessTransaction - Process Tap On Phone transaction response.
| No. | Parameter | Example values | Description |
|---|---|---|---|
| 1 | ResponseCode | 0 | 0 - The action was successful. Any other value indicates an error - a development error. |
| 2 | Description | "The transaction was successfully completed" | Response description. If a different response is received, the transaction was not completed successfully. |
| 3 | DealNumber | (Int) | Transaction number. |
The following is an example of the function call and its response.
Example request:
{
"ApiName": "<string>",
"ApiPassword": "<string>",
"TerminalNumber": "<integer>",
"DeviceUUID": "<string>",
"TransactionInfo": {
"Amount": "<string>",
"Type": "<integer>",
"CreditType": "<integer>",
"NumberOfPayments": "<integer>",
"CustomerName": "<string>",
"ResponseCode": "<integer>",
"Message": "<string>",
"Status": "<string>",
"TransactionId": "<integer>",
"ReturnCode": "<integer>",
"ReturnMessage": "<string>",
"CardNumber": "<string>",
"CardExpireDateMMYY": "<string>",
"CardBrandCode": "<integer>",
"CardIssuerCode": "<integer>",
"CardFinancerCode": "<integer>",
"Token": "<string>",
"ApprovalNumber": "<string>",
"ResultRecord": "<string>",
"UID": "<string>",
"CustomerEmail": "<string>",
"CustomerPhoneNumber": "<string>",
"CustomerIdNumber": "<string>"
},
"RavMutavTerminalNumber": "<integer>"
}
Example response:
{
"ResponseCode": 0,
"Description": "string",
"DealNumber": 0
}