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
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. | Parameter | Example values | Description |
|---|---|---|---|
| 1 | ApiName | "kzFKfohEvL6AOF8aMEJz" | API name. |
| 2 | ApiPassword | "FIDHIh4pAadw3Slbdsjg" | API password. |
| 3 | FromCreateDate | "25032025" | Find transactions from date X. |
| 4 | ToCreateDate | "26032025" | Find transactions through date Y. |
| 5 | Page | 1 | The page from which to retrieve the transaction list details. |
| 7 | AddDepositedTransaction | false | Displays transactions according to CreateDate. |
| 8 | Page_size | 20 | The number of rows per page from which the transaction list details are retrieved. |
Financial Transaction response
| No. | Parameter | Example value | Description |
|---|---|---|---|
| 1 | ResponseCode | 0 | Response code. If it equals zero, the function was executed successfully. Any other value indicates that the operation was unsuccessful. |
| 2 | Description | "OK" | Response description. “OK” indicates success. |
| 3 | Page | 1 | The page from which to retrieve the transaction list details. |
| 4 | Page_size | 20 | The number of rows per page from which the transaction list details are retrieved. |
CreditCardTransactions values
| No. | Parameter | Example value | Description |
|---|---|---|---|
| 1 | Id | (Int) | Internal credit transaction identifier. |
| 2 | ARN | (String) "2135146546" | Acquirer identifier at the acquiring credit card company. |
| 3 | SapakNumber | (Int) | Cardcom merchant number. |
| 4 | OrigTransactionAmount | (Number) | Original transaction amount. |
| 5 | BankDepositeId | 105478 | Bank deposit reference. |
| 6 | CreditCardTransactionsId | 7127717 | Transaction identifier. |
| 7 | ConcentrationNumber | 4064 | Concentration number. |
| 8 | DepositeCurrency | 376 | Deposit currency – always Israeli shekels. |
| 9 | ActionCode |
| Action code number. |
| 10 | CreditCardCurrency | 376 | Transaction currency. |
| 11 | DepositeAmount | 390.3900 | Deposit amount. |
| 12 | IfPct | 0.01200000000000000000000 | Percentage of the fee charged for the transaction. |
| 13 | FeePerTrnAmt | 0.0000 | Per-transaction fee in the original transaction currency. |
| 14 | FixFeeAmtDepoCurr | 0.0000 | Fixed fee in the deposit currency (Israeli shekels). |
| 15 | MngtFeePct | 0.0000 | Management fee percentage. |
| 16 | BrutoOrgCurAmt | 170.0000 | Gross amount in the original currency. |
| 17 | DiscOrigCurrAmt | 0.0000 | Discount in the original currency. |
| 18 | ClDscOrgCurAmt | 0.0000 | Final amount after discount in the original currency. |
| 19 | DiscFreqShopAmt | 0.0000 | Frequent-shopper discount. |
| 20 | AftDiscAmtDepoCur | 170.0000 | Amount after discount in the deposit currency. |
| 21 | IfAmtDepoCur | 2.0400 | Fee per transaction in shekels. |
| 22 | VatPrc | 0.1800 | VAT rate. |
| 23 | VatIfNisDepoCur | 0.3700 | VAT if the deposit currency is Israeli shekels. |
| 24 | CurrencyOrIndexRate | 0.0000 | Currency or index rate. |
| 25 | EffectiveCurrencyOrIndexRate | 0.0000 | Effective currency or index rate. |
| 26 | EstimateDepositeDate | "2025-03-06T00:00:00" | Estimated deposit date. |
| 27 | NoOfPmt | 0 | Number of payments. |
| 28 | PmtNo | 0 | Payment number. |
| 29 | TxnType | 1 – 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. |
| 30 | IndexLinkType | 1 | Index-link type. |
| 31 | PurchaseDate | "2025-02-28T00:00:00" | Purchase date. |
| 32 | CreateDate | "2025-03-02T13:43:54.7922104" | Creation date. |
| 33 | UID | "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. |
| 34 | Last4CardDigits | 5794 | Last four digits of the card. |
| 35 | SapakMutavNumber | 0 | Beneficiary 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
}
]
}