Manage Saved Card

This API is used to take the Manage Saved Card via credit card or a debit card on the subscriber's account.

End Point https://www.vcareapi.com/vcareOssApi/ManageSavedCard/
Field (Short Description) Value/Tag Name Format Field Example Type Notes Validation rules
VENDOR ID string Vcarecorporation Required A unique Vendor ID is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
USER NAME string Vcarecorporation Required A unique User name is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
PASSWORD string Vcarecorporation Required This is a random string which is generated by Vcare and is tied to the MVNO/OSS user name. This is specifically used for authentication purpose and can be obtained by contacting your account manager.
PIN string 123456789 Required This is generated by Vcare to provide an additional layer of security in the Interim API. This is used for authentication purpose and can be obtained by contacting your account manager.
REFERENCE NUMBER string 123456789 Required Auto generated unique reference number is required to be passed with each transaction.
MODE String ADD Required ADD = Saved card. REMOVE = removed card from card list. VIEW = card details. ADD,REMOVE,VIEW
CARD ID string 123456 Required REMOVE= removed card from card list. VIEW = card details. Required if ACTION="REMOVE"
CUSTOMER ID string 123456 Conditional Required if ACTION="ADD"
MDN string 123456 Conditional 1313331311 Required if ACTION="ADD"
COMPANY ID Numeric 28 Conditional This can be obtained using GetCompany API Required if ACTION="ADD"
CARDTYPE string VISA Conditional This is the type of the card. Required if ACTION="ADD". 'VISA','MASTERCARD','DISCOVER','AMERICAN EXPRESS','AMERICAN','UNIPAY'
CARD NUMBER Numeric 4111111111111110 Conditional This is the credit/debit card number. Required if ACTION="ADD" Max=16 digits
CVV NUMBER Numeric 234 Conditional This is the CVV number of the card. Required if ACTION="ADD". Max=4 digits
EXPIRATION MONTH Numeric 11 Conditional This is the expiration month of the credit/debit card. Required if ACTION="ADD" digits=2
EXPIRATION YEAR Numeric 2018 Conditional This is the expiration year of the credit/debit. Required if ACTION="ADD" Exactly 4 digits.
NAME ON CARD string John Doe Conditional This is the name on the credit/debit. Required if ACTION="ADD".
BILLING ZIPCODE Numeric 90001 Conditional Required if ACTION="ADD". This is the Billing address Zip Code for the associated bank account. Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
BILLING CITY string San Jose Conditional Required if ACTION="ADD". This is the Billing address City for the associated bank account. Should allow only letters, hyphen and space.
BILLING STATE string CA Conditional This is the state of the registered billing address in the bank account to which the card is associated. Required if ACTION="ADD". State should be standard abbreviated form.
BILLING ADDRESS string 123 Main st Conditional This is the Billing address line 1 for the associated bank account. Required if ACTION="ADD". Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
BILLING ADDRESS2 string Apt 1 Conditional Required if ACTION="ADD". This is the Billing address line 2 for the associated bank account. Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
SOURCE string API Optional Source of the order/application Expected Value:API,TABLET,IVR,WEBSITE
AGENTID string John Doe Required This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENTPASSWORD string John Doe Conditional This is the password for the Agent Id mentioned above. This is configuration level field. If you have set the permissions for the Agent Id for the requirement of the password in API transactions then you will need to pass the Agent Password in all the XML API transaction, else if you have set the permissions to password not required then you do not need to pass the Agent Password in the XML API.
Sample Request XML
<?xml version="1.0" encoding="utf-8"?>
<VCAREOSSAPI xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CREDENTIALS>
 <vendorId></vendorId>
 <username></username>
 <password></password>
 <pin></pin>
<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<MANAGESAVEDCARD>
 <MODE></MODE>
 <CARDID></CARDID>
 <CUSTOMERID></CUSTOMERID>
 <MDN></MDN>
 <COMPANYID></COMPANYID>
 <CARDTYPE></CARDTYPE>
 <CARDVALUE></CARDVALUE>
 <CARDCODE></CARDCODE>
 <EXPIRATION_MONTH></EXPIRATION_MONTH>
 <EXPIRATION_YEAR></EXPIRATION_YEAR>
 <NAMEONCARD></NAMEONCARD>
 <BILLINGSTATE></BILLINGSTATE>
 <BILLINGADDRESS></BILLINGADDRESS>
 <BILLINGADDRESS2></BILLINGADDRESS2>
 <BILLINGCITY></BILLINGCITY>
 <BILLINGZIPCODE></BILLINGZIPCODE>
 <AGENTID></AGENTID>
 <AGENTPASSWORD></AGENTPASSWORD>
 <SOURCE></SOURCE>
</MANAGESAVEDCARD>
</VCAREOSS>
</VCAREOSSAPI>
List of status code, description and resolution.
Status Code Description How to Resolve?
00 SUCCESS SUCCESS
13 Password is invalid. Provide a valid Password.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
25 Customer ID is invalid. Provide a valid Customer ID.
126 Invalid MDN. Please provide valid MDN.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
457 Invalid Source. Please provide a valid Source. Given value is invalid for Source.
491 No record(s) found. No record(s) found.
547 Mode is required. Provide a correct Mode. Mode is mandatory.
548 Mode should be ADD and UPDATE. Chose Mode between ADD or UPDATE. ADD or UPDATE is required for Mode.
Sample Response
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <credentials>
        <vendorId>Vcarecorporation</vendorId>
        <referenceNumber>1111111111</referenceNumber>
    </credentials>
	<ManageSavedCard>
	<statusCode>00</statusCode>
	<description>SUCCESS</description>
	<errorDescription>SUCCESS</errorDescription>
	<cardInfo>
		<cardId></cardId>
		<cardType></cardType>
		<cardNumberLastFourDigits></cardNumberLastFourDigits>
		<cardNumber></cardNumber>
		<primaryCard></primaryCard>
		<totalCard></totalCard>
		<nameOncard></nameOncard>
		<mdn></mdn>
		<customerId></customerId>
		<addRess1></addRess1>
		<addRess2></addRess2>
		<city></city>
		<state></state>
		<zipcode></zipcode>
	</cardInfo>
	</ManageSavedCard>
</VcareOssApi>
SUCCESS
Sample Fail Response: 1
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<ManageSavedCard>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ManageSavedCard>
</VcareOssApi>
Error Description: Password is invalid.
How to Resolve?: Provide a valid Password.
Sample Fail Response: 2
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<ManageSavedCard>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ManageSavedCard>
</VcareOssApi>
Error Description: Vendor not found. Wrong credentials.
How to Resolve?: Please enter valid vendor credentials.
Sample Fail Response: 3
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<ManageSavedCard>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</ManageSavedCard>
</VcareOssApi>
Error Description: Customer ID is invalid.
How to Resolve?: Provide a valid Customer ID.
Sample Fail Response: 4
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<ManageSavedCard>
	<statusCode>126</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid MDN.</errorDescription>
</ManageSavedCard>
</VcareOssApi>
Error Description: Invalid MDN.
How to Resolve?: Please provide valid MDN.
Sample Fail Response: 5
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<ManageSavedCard>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</ManageSavedCard>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
Sample Fail Response: 6
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<ManageSavedCard>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</ManageSavedCard>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
Sample Fail Response: 7
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<ManageSavedCard>
	<statusCode>491</statusCode>
	<description>FAIL</description>
	<errorDescription>No record(s) found.</errorDescription>
</ManageSavedCard>
</VcareOssApi>
Error Description: No record(s) found.
How to Resolve?: No record(s) found.
Sample Fail Response: 8
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<ManageSavedCard>
	<statusCode>547</statusCode>
	<description>FAIL</description>
	<errorDescription>Mode is required.</errorDescription>
</ManageSavedCard>
</VcareOssApi>
Error Description: Mode is required.
How to Resolve?: Provide a correct Mode. Mode is mandatory.
Sample Fail Response: 9
<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<ManageSavedCard>
	<statusCode>548</statusCode>
	<description>FAIL</description>
	<errorDescription>Mode should be ADD and UPDATE.</errorDescription>
</ManageSavedCard>
</VcareOssApi>
Error Description: Mode should be ADD and UPDATE.
How to Resolve?: Chose Mode between ADD or UPDATE. ADD or UPDATE is required for Mode.

All the status codes are listed under the status code sections. Please click here to go to the status code.