Retrieving Customer Account Details (Get Account info by cardcom Account Id)
When should this function be used?
Customers who use their own CRM, or who want to update customer details on their website or in their internal database, can use the Get Account info by cardcom Account Id function.
What does this function return?
The function provides the available customer data from the Cardcom website, including parameters such as:
- Customer name
- Customer city
- Phone number
- Special comments
- Additional secondary data.
Below is a link to the function's JSON documentation.
Request method: POST.
Get Account info by cardcom Account Id
https://secure.cardcom.solutions/api/v11/Account/GetByAccountId
Below are the parameters that must be passed to the Get recurring payment history function.
Key:
Red parameter – required
Bold parameter – recommended
A parameter that is neither red nor bold is optional.
| No. |
Parameter | Example values | Description |
| 1 | ApiName | "test2025" | API username |
| 2 | ApiPassword | "test5000$" | API user password |
| 3 | AccountId | 13463 | Internal customer account number |
Get Account info by cardcom Account Id RESPONSE.
| No. |
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. |
Account object values (3).
| No. |
Parameter | Example values | Description |
| 1 | AccountId | 13463 | Customer account number. |
| 2 | Name | "Test customer" | Customer name. |
| 3 | FirstName | "First name" | Additional customer name for the document. |
| 4 | TaxId | "516731969" | Company registration number or ID number. |
| 5 | City | "Rishon LeZion" | City. |
| 6 | AddressLine1 | "1 Rothschild St." | First address line. |
| 7 | AddressLine2 | "Floor 2, Apartment 20" | Second address line. |
| 8 | Mobile | "0522222222" | Mobile phone number. |
| 9 | Phone | "03161635" | Landline phone number. |
| 10 | "t.@t.com" | Customer email address. | |
| 11 | IsVatFree | boolean - true / false | Whether the customer is VAT-exempt, for example, a customer located outside Israel. |
| 12 | ZipCode | "41565748" | Customer postal code. |
| 13 | PoBox | "P.O. Box 5" | P.O. box. |
| 14 | Fax | "03548135" | Fax. |
| 15 | OpenDate | "4.12.2019" | Opening date |
| 16 | Comments | "VIP customer" | Comments |
| 17 | AccountForeignKey | "513" | Accounting system number. |
| 18 | SiteUniqueId | "849" | The merchant's unique identifier for this customer account. |
| 19 | ContactName | "Moshe" | Contact person's name. |
| 20 | ISOCoinId | 1 - Israeli shekel 2 - US dollar For additional currency codes, see the Currency Code List | The currency used in customer documents. |
| 21 | Balance | 500 | The balance in the customer account. |
| 22 | OpeningBalance | 0 | The opening balance in the customer account. |
Below are sample code snippets for retrieving customer account information.
Sending the request to retrieve the account details:
Response received: