This API call let's you add a new credit card to a specific customer. The response is an XML of the available new credit card information.
Request Fields
| Field Name |
Type |
Required |
Description |
| action |
String |
Yes |
customerCardEdit |
| accountId |
Integer |
Yes |
The Helcim Commerce account ID. |
| apiToken |
String |
Yes |
API token used for authentication and access control. |
| customerCode |
String |
Yes |
The customer code. |
| cardHolderName |
String |
Yes |
The card holder's name. |
| cardNumber |
Integer |
Yes |
The credit card number. |
| cardExpiry |
String |
Yes |
The credit card expiry date. |
| cardCVV |
Integer |
No |
The card verification value. |
| cardToken |
String |
No |
If entered, user is editing an existing card. |
| default |
Integer |
No |
1 or 0. Whether the card is set as default or not. |
| cardHolderAddress |
String |
No |
The card holder's address. |
| cardHolderPostalCode |
String |
No |
The card holder's postal code. |
| terminalId |
Integer |
No |
The terminal ID. |
| verify |
Integer |
No |
1 or 0. Whether the card will be verified or not. |
Response Fields (XML)
| Field Name |
Type |
Description |
| message |
- |
XML structure |
| response |
Integer |
1 or 0. Whether the new credit card was added or not. |
| responseMessage |
String |
Response message confirming actions taken. |
| customer |
- |
XML structure |
| customerCode |
String |
the customer code. |
| businessName |
String |
The business name. |
| contactName |
String |
The contact name. |
| card |
- |
XML structure |
| cardNumber |
Integer |
The credit card number (first four and last four digits only). |
| cardToken |
String |
The credit card token. |
| cardF4L4 |
Integer |
The first four and last four credit card digits. |
| dateLastUsed |
String |
The date the credit card was last used. |
Errors
For all API requests, there are also generic API authentication and user access restriction errors.
| Response Code |
Error Code |
Message |
Description |
| 0 |
- |
Invalid Customer Code |
The customer code you provided cannot be found. |
| 0 |
- |
Invalid credit card number (Lunh Check) |
The credit card number you provided is invalid, or not entered. |
| 0 |
- |
Invalid Field - Cardholder Name |
The card holder's name is invalid, or not entered. |
| 0 |
- |
Card has expired |
The credit card has expired, or the credit card expiry date was not entered. |
