Telgoo5 APIs

CheckAutoPayStatus

This API used to get the auto pay status on the customer's account. If there was no auto-pay set up ever on the account it will return the result as "Autopay is not setup for this customer.". This currently the auto-pay is active on the account it will return the auto pay status as yes with the description of the service plan for which it is setup for. If auto-pay was set up on the account at some point in time but is currently cancelled then it will return the status as cancelled.

End Point	https://www.vcareapi.com/vcareOssApi/CheckAutoPayStatus/
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.
CUSTOMER ID		Numeric	123456	Conditional	Auto generated customer account number. This is returned in GetCustomerInfo	This API will not show any result for those customers whose auto pay is never set.
MDN		string	1234567890	Conditional	This is the telephone number which is attached to the subscriber's account	MDN and customer id is supposed to be passed together. If you are passing the Customer Id then MDN are not required. This API will not show any result for those customers whose auto pay is never set.
AGENTID		string	John Doe	Required	This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENTPASSWORD		string	JohnDoe	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 don't need to pass the Agent Password in the XML API.
SOURCE		string	API	Optional	Source of the order application	Expected Value:API, TABLET, IVR, WEBSITE

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>
	<CHECKAUTOPAYSTATUS>
	<CUSTOMERID></CUSTOMERID>
	<MDN></MDN>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</CHECKAUTOPAYSTATUS>
</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.
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.
564	Customer ID OR MDN is required.	Choose between Customer ID or MDN. Customer ID or MDN is required.
726	Autopay is not setup for this customer.	Autopay is not setup for this customer.

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>11111111</referenceNumber>
</credentials>
<CheckAutoPayStatus>
<statusCode>00</statusCode>
<description>SUCCESS</description>
<errorDescription>SUCCESS</errorDescription>
<data>
   <CardLast4Digit></CardLast4Digit>
   <datatopupname> TopUp</datatopupname>
   <datatopupcode></datatopupcode>
   <planamount></planamount>
   <datathreshold></datathreshold>
   <autopayType></autopayType>
   <autopay_status></autopay_status>
   <create_datetime></create_datetime>
   <update_datetime></update_datetime>
</data>
<plan>
   <CardLast4Digit></CardLast4Digit>
   <plan_id></plan_id>
   <planName></planName>
   <planamount></planamount>
   <autopayType></autopayType>
   <autopay_status></autopay_status>
   <next_autopay_date></next_autopay_date>
   <create_datetime></create_datetime>
   <update_datetime></update_datetime>
</plan>
<minute>
   <CardLast4Digit></CardLast4Digit>
   <minuttopupname></minuttopupname>
   <minuttopupcode></minuttopupcode>
   <planamount></planamount>
   <voicethreshold></voicethreshold>
   <autopayType></autopayType>
   <autopay_status></autopay_status>
   <create_datetime></create_datetime>
   <update_datetime></update_datetime>
</minute>
</CheckAutoPayStatus>
</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>
<CheckAutoPayStatus>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</CheckAutoPayStatus>
</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>
<CheckAutoPayStatus>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</CheckAutoPayStatus>
</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>
<CheckAutoPayStatus>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</CheckAutoPayStatus>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID as it cannot be blank.

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>
<CheckAutoPayStatus>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</CheckAutoPayStatus>
</VcareOssApi>

Error Description: Invalid Source.

How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

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>
<CheckAutoPayStatus>
	<statusCode>564</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID OR MDN is required.</errorDescription>
</CheckAutoPayStatus>
</VcareOssApi>

Error Description: Customer ID OR MDN is required.

How to Resolve?: Choose between Customer ID or MDN. Customer ID or MDN is required.

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>
<CheckAutoPayStatus>
	<statusCode>726</statusCode>
	<description>FAIL</description>
	<errorDescription>Autopay is not setup for this customer.</errorDescription>
</CheckAutoPayStatus>
</VcareOssApi>

Error Description: Autopay is not setup for this customer.

How to Resolve?: Autopay is not setup for this customer.

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