Get Recurring Payment Information
When should this function be used?
Merchants who want to retrieve information about a recurring payment in the Cardcom website and integrate the recurring payment details into their CRM system or interface can use the Get recurring payment info function.
This function is intended to provide information on an individual basis for the merchant’s specific needs.
What does this function return?
The function returns the number of remaining charges, the number of charges that have already been processed, the internal name of the recurring payment, the next billing date, and several additional parameters related to the recurring payment.
Required models
The Recurring Payment and Existing Recurring Payments models are available in the Cardcom interface.
Here is a link to the function in JSON.
Request method: GET.
https://secure.cardcom.solutions/api/v11/RecuringPayments/GetRecurringPayment
The following parameters must be passed to the Get recurring payment info function.
Legend:
Red parameter — required
Bold parameter — recommended
A parameter that is neither red nor bold — optional
| Number | Parameter | Example values | Description |
|---|---|---|---|
| 1 | apiUserName | "test2025" | API username |
| 2 | apiPassword | "test5000$" | API user password |
| 3 | AccountId | 13744 | Customer card number |
| 4 | RecurringId | 37930 | Recurring payment number for the customer card |
Response from Get recurring payment info
| Number | Parameter | Example values | Description |
|---|---|---|---|
| 1 | ResponseCode | 0 | Response code. If it equals zero, the function was executed successfully. Any other response indicates that the operation was unsuccessful. |
| 2 | Description | "OK" | Response description. “OK” indicates success. |
UpdateList values (3)
An array of objects.
| Number | Parameter | Example values | Description |
|---|---|---|---|
| 1 | RecurringId | 37930 | Recurring payment number for the customer card |
| 2 | InternalDecription | "A cute item" | Internal description name of the recurring payment |
| 3 | NextDateToBill | "2025-04-18T00:00:00" | Next billing date |
| 4 | TotalNumOfBills | 99999 | Number of charges |
| 5 | NumOfPaymentsAlreadyCharged | 1 | Number of charges already processed |
| 6 | IsActive | boolean — true / false | Whether the recurring payment is still active |
| 7 | ChargeIntervals Object containing parameters | TimeIntervalId - 1 | ChargeIntervals — the billing interval, or the time between charges. TimeIntervalId — internal ID of the billing interval defined in Cardcom. AddDays — number of days in the billing interval. AddWeeks — number of weeks in the billing interval. AddMonth — number of months in the billing interval. AddYears — number of years in the billing interval. |
| 8 | FinalDebitCoinId | 1 | Currency number. 1 — shekel 2 — dollar For additional currency codes, see the currency code list. |
| 9 | IsDocumentCreate | boolean — true / false | Whether document-generation settings are enabled for the recurring payment |
| 10 | DocTypeToCreate | 1 — tax invoice/receipt 2 — credit invoice and refund 3 — nonprofit/VAT-exempt receipt 4 — nonprofit credit receipt (refund) 50 — quote 100 — order (without payment) 101 — order confirmation from the website (internal document, not for bookkeeping) — paid order 102 — order credit from the website (internal document, not for bookkeeping) — refunded order 200 — delivery note 210 — return note 300 — transaction invoice 301 — payment demand 302 — payment demand cancellation 305 — tax invoice 330 — credit invoice 400 — receipt (for an invoice) 410 — customer refund (credit receipt) 405 — donation receipt 406 — donation receipt credit (refund) 303 — receipt invoice (similar to an invoice for an עוסק פטור; rarely used) 304 — credit receipt invoice | Document type to generate |
| 11 | Comment | "VIP customer" | Internal note for the recurring payment; not displayed to the customer |
| 12 | IsPrintNumOfPayments | boolean — true / false | Whether the number of payments is configured to be printed on the document |
| 13 | IsPrintBillMonth | boolean — true / false | Whether the billing month number is configured to be printed |
| 14 | DepartmentId | INT | Internal number to which the recurring payment is assigned |
| 15 | UserId | INT | Cardcom subscription user number who created the recurring payment |
| 16 | ReturnValue | string | Value to return; usually an order number |
| 17 | ChargeInTerminal | 1000 | Terminal that processes the recurring payment |
| 18 | FlexItem Object containing parameters | DocumentLineDesc — "Moses’s vacuum cleaners" Price — 420 IsPriceIncludeVat — boolean (true / false) ProductId — string | FlexItem — details of a flexible charge. DocumentLineDesc — name of the item being charged. Price — price of the item being charged. IsPriceIncludeVat — whether the price includes VAT. ProductId — internal product code. |
| 19 | IsByProducts | boolean — true / false | Whether the recurring payment amount is calculated according to the product list price (ProdList), or charged as a flexible charge (FlexItem). |
| 20 | ProdList Array of objects | ProductId — string Quantity — 5 | ProdList — list of products to which the recurring payment applies. ProductId — the product’s internal ID in Cardcom. Quantity — product quantity. |
The following is an example of the function together with its response.
POST request for retrieving recurring payment information:
{
"apiUserName": "test2025",
"apiPassword": "test5000$",
"AccountId": "13744",
"RecurringId": "37930"
}Response received from the first request:
{
"ResponseCode": 0,
"Description": "ok",
"UpdateList": [
{
"RecurringId": 37930,
"InternalDecription": "A cute item",
"NextDateToBill": "2025-04-18T00:00:00",
"TotalNumOfBills": 99999,
"NumOfPaymentsAlreadyCharged": 1,
"IsActive": true,
"ChargeIntervals": {
"TimeIntervalId": 1,
"AddDays": 0,
"AddWeeks": 0,
"AddMonth": 1,
"AddYears": 0
},
"FinalDebitCoinId": 1,
"IsDocumentCreate": true,
"DocTypeToCreate": null,
"Comment": null,
"IsPrintNumOfPayments": true,
"IsPrintBillMonth": true,
"DepartmentId": 0,
"UserId": 1,
"ReturnValue": null,
"ChargeInTerminal": 1002,
"FlexItem": {
"DocumentLineDesc": "A cute item",
"Price": 1111.0000,
"IsPriceIncludeVat": true,
"ProductId": null
},
"IsByProducts": false,
"ProdList": null
}
]
}