Service Location:
For SOAP connections:
https://<assigned domain>/ws/cardsafe.asmx?op=StoreCard
For standard HTTPS connections:
https://<assigned domain>/ws/cardsafe.asmx/StoreCard?
Description:
This service is used to add a stored payment method to an existing customer record. Calling this service is the first step towards succesfully storing and initiating recurring payments.
Developer Notes:
It is very important to understand that this web service is used for storing payment methods, and is not for querying previously stored data. It is the responsibility of the integrator to store and maintain all returned ‘Info Keys’ for later use.
It should also be noted that all information stored via the CardSafe will be accessible through the Recurring web services and vice versa.
Input Parameters:
O = Optional, R = Required
|
Parameter Name |
Opt/Req |
Description |
|
UserName |
R |
User name assigned in the payment server. The user must have an appropriate level of access within the system in order to utilize the web service. |
|
Password |
R |
Password associated with the user name provided. |
|
TokenMode |
R |
Indicates what type of token will be returned when calling the service. • DEFAULT - Returns a numeric CcInfoKey
• CARDFORMAT – Returns a randomly generated number in the format of a credit card matching the card type of the actual card
|
|
CardNum |
R |
Credit card number used to uniquely identify the card owner’s account. |
|
ExpDate |
R |
Credit card date of expiration in MMYY format. |
|
CustomerKey |
R |
Unique identifier assigned to the customer record by the system at the time the customer record is created. Note: The CustomerKey value can be found on the virtual terminal by accessing the View Customers option under the Recurring Billing menu. Display a list of customers by entering search criteria. The CustomerKey appears in the Key column. |
|
NameOnCard |
O |
Card owner’s name as it appears on the card. |
|
Street |
O |
Card owner’s billing address street name and number. |
|
Zip |
O |
Card owner’s billing address postal/zip code. |
|
ExtData |
O |
Reserved for future use. |