Knowledge Base / API
עברית

Ask AI

✦ AI answer

Thinking…

Sources

    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.ParameterExample valuesDescription
    1ApiNametest2025API username.
    2ApiPassword"kzFKfohEvL6AOF8aMEJz"API password, intended for refunds and transaction cancellations.
    3TerminalNumber1000The terminal that performs the action - an internal number, not the external terminal number.
    4RavMutavTerminalNumber(Int)The terminal number of the authorized institution (internal terminal number).
    5DeviceUUID(String)Unique device identifier.

    Values of the TransactionInfo object (6).

    No.ParameterExample valuesDescription
    1Amount(String) "150"Transaction amount.
    2Type(Int) 1 - Charge, 51 - RefundTransaction type.
    3CreditType(Int) 1 - Regular charge, 6 - Credit installments, 8 - Regular installmentsCredit transaction type.
    4NumberOfPayments(Int)Number of payments.
    5CustomerName(String)Customer name.
    6CustomerEmail(String)Customer email address.
    7CustomerPhoneNumber(String)Customer phone number.
    8CustomerIdNumber(String)Customer ID number.
    9ResponseCode(Int)0 - The action was successful.
    Any other value indicates an error - a development error.
    10Message(String)Transaction message.
    11Status(String)Transaction status.
    12TransactionId(Int)Transaction number.
    13ReturnCode(Int)Code to return after the transaction.
    14ReturnMessage(String)The message returned in the response.
    15CardNumber(String)Card number.
    16CardExpireDateMMYY(String)Card expiration date.
    17CardBrandCode(Int) Card brand codeCard brand.
    18CardIssuerCode(Int) Issuer codeIssuing company.
    19CardFinancerCode(Int)Card financier code.
    20Token(String)Token used for charging.
    21ApprovalNumber(String)Approval number.
    22ResultRecord(String)Result record.
    23UID"21121517002429612920744"Unique transaction identifier.

    ProcessTransaction - Process Tap On Phone transaction response.

    No.ParameterExample valuesDescription
    1ResponseCode00 - The action was successful.
    Any other value indicates an error - a development error.
    2Description"The transaction was successfully completed"Response description. If a different response is received, the transaction was not completed successfully.
    3DealNumber(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
    }

    Was this article helpful?