Get Recurring Payment History
Use this function to retrieve information about all charges recorded in the recurring payment history within a specific date range.
When should you use this function?
This function is very similar to Get recurring payment info. The main difference is that it retrieves information about all charges recorded in the recurring payment history within a specific date range.
What does this function return?
The response includes the charge amount, transaction and document numbers, and additional recurring payment details. This is an excellent solution for updating interfaces and CRM systems according to the business's needs.
Required models:
The Recurring Payment model and existing recurring payment models are available in the Cardcom interface.
JSON function link:
Request method: GET
https://secure.cardcom.solutions/api/v11/RecuringPayments/GetRecurringPaymentHistory
Parameters to send to the Get recurring payment history function
Legend:
Red parameter – required
Bold parameter – recommended
Parameter that is neither red nor bold – optional
| No. | Parameter | Example values | Description |
|---|---|---|---|
| 1 | apiUserName | "test2025" | API username |
| 2 | apiPassword | "test5000$" | API user password |
| 3 | RowId | "13463" | Recurring payment charge row in the payment history |
| 4 | AccountId | 13463 | Internal customer card number |
| 5 | FromDate | DDMMYYYY – "01012025" | Start date |
| 6 | ToDate | DDMMYYYY – "17042025" | End date |
Get recurring payment history response
| No. | Parameter | Example value | Description |
|---|---|---|---|
| 1 | ResponseCode | 0 | Response code. If the value is 0, the function was executed successfully. Any other value indicates that the operation was unsuccessful. |
| 2 | Description | "OK" | Response description. “OK” indicates success. |
RecurringPaymentHistory values
An array of objects.
| No. | Parameter | Example value | Description |
|---|---|---|---|
| 1 | RowId | "13463" | Recurring payment charge row in the payment history |
| 2 | RecurringId | 37930 | Recurring payment number associated with the customer card |
| 3 | TerminalNumber | 1000 | Terminal used to charge the recurring payment |
| 4 | AccountID | 13744 | Customer card number |
| 5 | DocumentDescription | "item (Payment 1 of 99999) for January" | Item description on the document |
| 6 | LastDate | "2025-02-03T12:18:00" | Last charge date |
| 7 | OriginalNextDate | "2025-01-27T00:00:00" | Original charge date |
| 8 | FinalDebitCoinID | 1 | Currency number: 1 – ILS; 2 – USD. For additional currency codes, see the currency code list. |
| 9 | SumToBill | 100.00 | Amount to charge through the recurring payment |
| 10 | SumToBillNoVat | 84.75 | Amount to charge through the recurring payment before VAT |
| 11 | DepartmentID | 1 | Department number associated with the recurring payment |
| 12 | IsDocumentCreate | boolean – true / false | Whether a document was configured to be issued for the recurring payment charge |
| 13 | AgentID | 1 | User number who created the recurring payment |
| 14 | PaymentNum | 1 | Payment number |
| 15 | IsReNewOrder | boolean – true / false | Whether the recurring payment is new |
| 16 | ProductID | (string) | Internal product code |
| 17 | TranzactionId | 202406493 | Cardcom internal transaction number |
| 18 | ResposeCode | 0 | Response code. A value of 0 indicates successful execution. |
| 19 | ProcessID | 4467 | Process number |
| 20 | DocumentType | 1, 2, 3, 4, 50, 100, 101, 102, 200, 210, 300, 301, 302, 303, 304, 305, 330, 400, 405, 406, 410 | Document type to issue. 1 – tax invoice/receipt; 2 – credit invoice/refund; 3 – non-profit receipt / receipt without VAT; 4 – non-profit credit receipt; 50 – quotation; 100 – order without payment; 101 – order confirmation; 102 – order credit; 200 – delivery note; 210 – return note; 300 – transaction account; 301 – payment demand; 302 – payment demand cancellation; 303 – receipt account; 304 – receipt account credit; 305 – tax invoice; 330 – credit invoice; 400 – receipt for an invoice; 405 – donation receipt; 406 – donation receipt credit; 410 – customer refund |
| 21 | DocumentNumber | 18039 | Document number |
| 22 | Quantity | 1 | Item quantity |
| 23 | UnitPrice | 100 | Item price |
| 24 | UnitPriceNoVAT | 84.75 | Item price excluding VAT |
| 25 | IsIncludesVAT | boolean – true / false | Whether the price includes VAT |
| 26 | VAT | 15.25 | VAT amount |
| 27 | BillingAttempts | 1 | Number of charge attempts for this charge |
| 28 | CreateDate | "2025-02-27T00:00:00" | Creation date |
| 29 | ActualBillingType | 0 – Bank; 1 – Credit Card | Recurring payment type: credit card or bank |
| 30 | NumOfCreditPayments | INT | If the recurring payment was configured as a single charge paid in installments, this parameter contains the number of installments. |
| 31 | Status | "SUCCESSFUL" / "DEBTAUTOBILLING" | Normally, no other response is returned. If the charge could not be processed, an empty history array is returned. |
System messages in the URLResp field – server response
The URLResp field displays the result of an attempt to send a Webhook notification:
- OK : empty – The notification was sent successfully, but the receiving server returned an empty response. If the server returns content, it will be displayed in this field.
- ERROR : No url in config – The notification was not sent because no URL was configured in the Webhook notification settings.
- ERROR : Max Retry – The system reached the maximum number of notification attempts and will not try again. An email is also sent to the business at the address configured in the company notification settings.
Note: If a notification attempt was made, the URLResp field will not be empty.
Example request and response
GET request for recurring payment history
{
"apiUserName": "test2025",
"apiPassword": "test5000$",
"RowId": "341344",
"AccountId": "13463",
"FromDate": "01012025",
"ToDate": "17042025"
}Response
{
"ResponseCode": 0,
"Description": "ok",
"RecurringPaymentHistory": [
{
"RowID": 341344,
"RecurringId": 37551,
"TerminalNumber": 1001,
"AccountID": 13463,
"DocumentDescription": "item (Payment 2 of 99999) for February",
"LastDate": "2025-02-27T12:18:00",
"OriginalNextDate": "2025-02-27T00:00:00",
"FinalDebitCoinID": 1,
"SumToBill": 100.00,
"SumToBillNoVat": 100.00,
"DepartmentID": 0,
"IsDocumentCreate": true,
"AgentID": 0,
"PaymentNum": 2,
"IsReNewOrder": false,
"ProductID": null,
"TranzactionId": 202406493,
"ResposeCode": 0,
"ProcessID": 4467,
"DocumentType": 3,
"DocumentNumber": 18039,
"Quantity": 1.00,
"UnitPrice": 100.00,
"UnitPriceNoVAT": 100.00,
"IsIncludesVAT": false,
"VAT": 0.0000,
"BillingAttempts": 1,
"CreateDate": "2025-02-27T00:00:00",
"ActualBillingType": 1,
"NumOfCreditPayments": null,
"Status": "SUCCESSFUL"
}
]
}