Knowledge Base / API
עברית

Ask AI

✦ AI answer

Thinking…

Sources

    Receiving Information About Transaction Disputes, Subscription Cancellations, and Non-Receipt of Goods or Services — Special Transactions

    When should this function be used?

    If the business processes payments through us, it is always recommended to use this function. The function provides information, when available, about non-receipt of goods or services, transaction disputes, and subscription cancellations related to the business’s transactions.

    If such an action was performed on one of the transactions, the business will be aware of it and can act accordingly.

    Of course, this is relevant only if the business wants to manage everything independently. In the Cardcom interface, these transactions can be viewed in the credit-card-company reports, under the menu: Credit Card Company -> 1 -> 1.

    What does this function return?

    All the details of the original transaction, together with the dispute notification associated with it.

    Below is a link to the JSON function.

    Request method: POST.

    Special Transactions

    https://secure.cardcom.solutions/api/v11/Transactions/SpecialTransactions

    Below are the parameters that must be passed to the Special Transactions 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 name.

    2

    ApiPassword

    "test5000$"

    API password.

    3

    FromDate

    "19032025"

    Notifications received from this date.

    4

    ToDate

    "21032025"

    Notifications received up to this date.

     

    Special Transactions response.

    No.

    Parameter

    Example values

    Description

    1

    ResponseCode

    0

    0 — operation completed successfully.
    Any other value — error, usually a development error.

    2

    Description

    "The transaction was completed successfully"

    Description of the response. If a different response is received, the operation was not completed successfully.

     

    SpecialTransactions values (3).

    An array of objects.

    No.

    Parameter

    Example values

    Description

    1

    CreateDate

    "2025-03-20T18:39:11.983"

    Date the dispute notification was received.

    2

    SpecialType

    15, 19, 65, 69 — chargeback / transaction dispute.
    35, 75, 45 — reversal of a dispute, REV, receipt of the money back.
    51, 52 — request for a voucher from the issuer.

    Used for credit reconciliations. Displays the reason for the financial transaction.

    3

    SpecialTypeDesc

    15 — CHB(15)
    19 — Non-receipt of goods or services, CHB
    65 — CHB 2 (65)
    69 — Non-receipt of goods or services, CHB2 (69)
    10 — Special handling fee collection (10)
    20 — Refund of handling fee (20)
    11 — Cancellation of credit due to transaction closure
    21 — Credit due to transaction closure
    25 — Cancellation of charge transaction
    35 — Reversal CHB
    75 — Reversal CHB2
    45 — REP for a charge transaction (45)
    24 — Stop (24)
    51 — Request to provide the original voucher
    52 — Request to provide a copy of the voucher
    9001 — Recalculation of a transaction

    Used for credit reconciliations. Textual description of SpecialType.

    4

    SpecialTypeSubType

    41

    Used for credit reconciliations. Subcode of SpecialType.

    5

    Description

    "Cancellation of a standing order — subscription" / "Customer disputes the transaction" / "Non-receipt of goods or services — regular transaction"

    Textual description explaining the reason for the transaction (SpecialType + SpecialTypeSubType).

    6

    Amount

    -175.20
    150.50

    Negative Amount — money was taken from the business.

    Positive Amount — money was credited to the business.

    7

    OriginlTranAmount

    100

    Original transaction amount.

    8

    ARN

    "22707515052285"

    Used for credit reconciliations. Unique identifier assigned by the acquiring company.

    9

    UID

    "2505073844"

    Transaction identifier assigned by the Israeli payment system, device, or POS.

    10

    SapakNumber

    1075479

    Merchant number for which the action was performed.

    If a dispute, credit, or cancellation was performed from the transaction, the UID of the new action will be identical to the original transaction.

    If a credit was issued outside the transaction, for example as a new transaction using a token, the UID will be new.

    11

    TranzactionId

    201724409

    Cardcom’s unique identifier for the action, only if the charge was performed through a Cardcom terminal. This value is not necessarily present.

    12

    Last4CardDigits

    "5581"

    Last four digits.

    13

    MarkedAsRead

    Boolean — true / false

    Indicates whether the notification was marked as read or handled through the Cardcom UI.

    14

    CurrencyISO

    1 — Israeli shekel
    2 — US dollar
    For additional currency codes, see the list of currency codes.

    Currency of the amount.

    15

    CardToken

    "cd804-81f-45-a3-fea3480"

    Card token.

    16

    OriginlTranDate

    NULL

    Original date of the transaction for which the charge was changed.

    17

    SpecialTranDate

    "2024-11-19T00:00:00"

    Date the transaction was reported. For example, the cardholder called on Friday to complain about an invalid transaction.

    18

    SapakMutavNumber

    1234

    Customer number in a multiple-merchant arrangement.

     

    Below is sample code for the function together with the response.

    Example request for information about system notifications.

    {
      "ApiName": "rbnTcWLSjLx2IcMe4Htk",
      "ApiPassword": "lhXNCJtUeF4BBKZiV6SG$",
      "FromDate": "19032025",
      "ToDate": "21032025"
    }

     

    Example response:

    {
      "ResponseCode": 0,
      "Description": "OK",
      "SpecialTransactions": [
        {
          "CreateDate": "2025-03-20T18:39:11.983",
          "SpecialType": 15,
          "SpecialTypeDesc": "CHB(15)",
          "SpecialTypeSubType": 41,
          "Description": "Cancellation of a standing order — subscription",
          "Amount": -2446.0000,
          "OriginlTranAmount": 2446.0000,
          "ARN": "22707510069297285",
          "UID": "25022005073844",
          "SapakNumber": 107,
          "TranzactionId": 201724409,
          "Last4CardDigits": "5581",
          "MarkedAsRead": false,
          "CurrencyISO": 376,
          "CardToken": "cd84e09-89-45-a-aa-feac780",
          "OriginlTranDate": null,
          "SpecialTranDate": "2025-01-19T00:00:00",
          "SapakMutavNumber": 0
        }
      ]
    }

    Was this article helpful?