Knowledge Base / API
עברית

Ask AI

✦ AI answer

Thinking…

Sources

    Financial - Charges and Credits Details (Financial Transaction)

    The Financial Transactions function returns details of credit card charges and credits within a specified date range, including deposit dates, transaction amounts, VAT, the last four card digits, merchant number, and internal transaction identifiers.

    When should this function be used?

    This function provides details of charges and credits from the credit card company for a specified date range.

    The response includes the deposit dates and amounts of the transactions, the VAT applied to them, the last four card digits, the merchant number, and the internal transaction identifier.

    JSON function documentation:

    Request method: POST

    Financial Transaction

    Endpoint: https://secure.cardcom.solutions/api/v11/Financial/FinancialTransactions

    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

    No.ParameterExample valuesDescription
    1ApiName"kzFKfohEvL6AOF8aMEJz"API name.
    2ApiPassword"FIDHIh4pAadw3Slbdsjg"API password.
    3FromCreateDate"25032025"Find transactions from date X.
    4ToCreateDate"26032025"Find transactions through date Y.
    5Page1The page from which to retrieve the transaction list details.
    7AddDepositedTransactionfalseDisplays transactions according to CreateDate.
    8Page_size20The number of rows per page from which the transaction list details are retrieved.

    Financial Transaction response

    No.ParameterExample valueDescription
    1ResponseCode0Response code. If it equals zero, the function was executed successfully. Any other value indicates that the operation was unsuccessful.
    2Description"OK"Response description. “OK” indicates success.
    3Page1The page from which to retrieve the transaction list details.
    4Page_size20The number of rows per page from which the transaction list details are retrieved.

    CreditCardTransactions values

    No.ParameterExample valueDescription
    1Id(Int)Internal credit transaction identifier.
    2ARN(String) "2135146546"Acquirer identifier at the acquiring credit card company.
    3SapakNumber(Int)Cardcom merchant number.
    4OrigTransactionAmount(Number)Original transaction amount.
    5BankDepositeId105478Bank deposit reference.
    6CreditCardTransactionsId7127717Transaction identifier.
    7ConcentrationNumber4064Concentration number.
    8DepositeCurrency376Deposit currency – always Israeli shekels.
    9ActionCode
    • NoActionCode – No action code
    • Purchase_1 – Purchase
    • Return_6 – Return
    • FeeCharge_10 – Fee charge
    • CloseTXNReturn_11 – Close transaction and return
    • CHB_15 – CHB charge
    • CHBNoMerchandis_19 – CHB charge without merchandise
    • FeeChargeReturn_20 – Fee charge and return
    • CloseTXN_21 – Close transaction
    • HOLD_24 – Hold
    • Cancel_25 – Cancel
    • RevCHB_35 – CHB charge reversal
    • Rep_45 – Recovery
    • OriginalRequest_51 – Original request
    • CopyRequest_52 – Copy request
    • CHB2_65 – CHB 2 charge
    • CHB2NoMerchandi_69 – CHB 2 charge without merchandise
    • RevCHB2_75 – CHB 2 charge reversal
    • BlockedCard_90 – Blocked card
    • NEW_ISSUER_NOTIFY_ISSUANCE_CARD_91 – Card issuance – new issuer notification
    • OLD_ISSUER_RESPONSE_FOR_NOTIFY_92 – Response from the old issuer to the notification
    • FRAUD_93 – Fraud
    • CANCEL_STANDING_ORDER_94 – Cancel standing order
    • CHANGE_CARD_STANDING_ORDER_95 – Change card standing order
    • ISSUER_CANCEL_STANDING_ORDER_96 – Standing order canceled by issuer
    • RESUME_CARD_97 – Reactivate card
    • CHANGE_NOT_ACTIVATED_CARD_98 – Change a card that was not activated
    • CBH_SECOND_FULL_205 – Second full CBH
    • CBH_SECOND_PARTIAL_282 – Second partial CBH
    • CBH_FIRST_FULL_450 – First full CBH
    • CBH_FIRST_FULL_451 – First full CBH
    • CBH_FIRST_PARTIAL_453 – First partial CBH
    • CBH_FIRST_PARTIAL_454 – First partial CBH
    • PrePayment_1001 – Prepayment
    • PrePaymentFutureDebts_1002 – Prepayment for future debts
    • CHBCommition_1003 – CHB fee
    • CancelMTI520Commition_1004 – Cancel MTI520 fee
    • RefundAC6Commition_1005 – AC6 fee refund
    • NotUsedRefundsSum_2001 – Unpaid refund amount
    • GetMoneyFromMerchant_2002 – Receive money from merchant
    • FixVat_2003 – VAT correction
    • InternalTransactionRecalc_9001 – Recalculate internal transaction
    Action code number.
    10CreditCardCurrency376Transaction currency.
    11DepositeAmount390.3900Deposit amount.
    12IfPct0.01200000000000000000000Percentage of the fee charged for the transaction.
    13FeePerTrnAmt0.0000Per-transaction fee in the original transaction currency.
    14FixFeeAmtDepoCurr0.0000Fixed fee in the deposit currency (Israeli shekels).
    15MngtFeePct0.0000Management fee percentage.
    16BrutoOrgCurAmt170.0000Gross amount in the original currency.
    17DiscOrigCurrAmt0.0000Discount in the original currency.
    18ClDscOrgCurAmt0.0000Final amount after discount in the original currency.
    19DiscFreqShopAmt0.0000Frequent-shopper discount.
    20AftDiscAmtDepoCur170.0000Amount after discount in the deposit currency.
    21IfAmtDepoCur2.0400Fee per transaction in shekels.
    22VatPrc0.1800VAT rate.
    23VatIfNisDepoCur0.3700VAT if the deposit currency is Israeli shekels.
    24CurrencyOrIndexRate0.0000Currency or index rate.
    25EffectiveCurrencyOrIndexRate0.0000Effective currency or index rate.
    26EstimateDepositeDate"2025-03-06T00:00:00"Estimated deposit date.
    27NoOfPmt0Number of payments.
    28PmtNo0Payment number.
    29TxnType1 – Regular, deferred by months
    2 – 30+, preferred
    3 – Immediate charge
    6 – Credit
    7 – New immediate charge
    8 – Installments
    12 – Isracredit
    17 – Immediate charge for a prepaid card
    71 – Currency exchange
    78 – Currency exchange installments
    Transaction type.
    30IndexLinkType1Index-link type.
    31PurchaseDate"2025-02-28T00:00:00"Purchase date.
    32CreateDate"2025-03-02T13:43:54.7922104"Creation date.
    33UID"25022822501590562905492"Unique transaction identifier.

    If a chargeback, credit, or cancellation is performed from the transaction, the UID of the new action is identical to the original transaction. If a credit is performed outside the transaction—for example, as a new transaction using a token—the UID is new.
    34Last4CardDigits5794Last four digits of the card.
    35SapakMutavNumber0Beneficiary merchant number.

    Example function call and response

    Example request:

    {
      "ApiName": "XFVXHjbcOxoYo",
      "ApiPassword": "85yikxn25pKZHg",
      "FromCreateDate": "01032025",
      "ToCreateDate": "26032025",
      "Page": "1",
      "Page_size": "20",
      "BankDepositeId": "<integer>"
    }

    Example response:

    {
      "ResponseCode": 0,
      "Description": "ok",
      "Page": 1,
      "Page_size": 20,
      "FinancialTransactions": [
        {
          "FirstCardDigits": 401047,
          "Id": 7729027,
          "ARN": "24396415061000070987712",
          "SapakNumber": 1119361,
          "OrigTransactionAmount": 396.0000,
          "BankDepositesId": 105478,
          "BankDepositAt": "2025-03-06T00:00:00",
          "CreditCardTransactionsId": 7127717,
          "ConcentrationNumber": 40016493,
          "DepositeCurrency": 376,
          "ActionCode": 1,
          "CreditCardCurrency": 376,
          "DepositeAmount": 390.3900,
          "IfPct": 0.01200000000000000000000,
          "FeePerTrnAmt": 0.0000,
          "FixFeeAmtDepoCurr": 0.0000,
          "MngtFeePct": 0.0000,
          "BrutoOrgCurAmt": 396.0000,
          "DiscOrigCurrAmt": 0.0000,
          "ClDscOrgCurAmt": 0.0000,
          "DiscFreqShopAmt": 0.0000,
          "AftDiscAmtDepoCur": 396.0000,
          "IfAmtDepoCur": 4.7500,
          "VatPrc": 0.1800,
          "VatIfNisDepoCur": 0.8600,
          "CurrencyOrIndexRate": 0.0000,
          "EffectiveCurrencyOrIndexRate": 0.0000,
          "EstimateDepositeDate": "2025-03-06T00:00:00",
          "NoOfPmt": 0,
          "PmtNo": 0,
          "TxnType": 1,
          "IndexLinkType": 1,
          "PurchaseDate": "2025-02-28T00:00:00",
          "CreateDate": "2025-03-02T13:43:54.789908",
          "UID": "25022821592090562905497",
          "Last4CardDigits": 3436,
          "SapakMutavNumber": 0
        }
      ]
    }

    Was this article helpful?