Service Location:
For SOAP connections:
https://<assigned domain>/paygate/ws/recurring.asmx?op=ManageCreditCardInfo
For standard HTTPS connections:
https://<assigned domain>/paygate/ws/recurring.asmx/ManageCreditCardInfo?
Description:
This service allows you to store a credit card number securely within the Payment Server database. Calling this service is the second step towards succesfully storing and initiating recurring payments if a credit card is to be the preferred method of payment.
Developer Notes:
The service returns a CCInfoKey value which takes the place of the cardholder data with which it is associated. It is the responsibility of the integrator to keep track of and store these keys.
An unlimited number of credit card profiles can be stored for any given customer.
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. |
TransType |
R |
Indicates whether the payment type is being added, updated, or deleted. Valid entries are: • ADD • UPDATE • DELETE |
Vendor |
R |
Unique numeric value used to identify the merchant. Note: Vendor key may also be called Merchant ID, Merchant Number, or RPNum. To locate your Vendor key on the virtual terminal, click Password under the Preferences menu. |
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. |
CardInfoKey |
O |
Numerical key value assigned to the payment method when it was added to the system. |
CcAccountNum |
O |
Credit card number used to uniquely identify the card owner’s account. |
CcExpDate |
O |
Credit card date of expiration in MMYY format. |
CcNameOnCard |
O |
Card owner’s name as it appears on the card. |
CcStreet |
O |
Card owner’s billing address street name and number. |
CCZip |
O |
Card owner’s billing address postal/zip code. |
ExtData |
O |
Reserved for future use. |