Telgoo5 APIs

AdjustBalance

This XMLAPI is used to adjust the balance of the subscriber's account.

End Point	https://www.vcareapi.com/vcareOssApi/AdjustBalance/
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.
MDN		Numeric	1234567890	Required	Telephone Number of the subscriber. This is returned in GetCustomerInfo
SUBSCRIPTION ID		Numeric	131534634636	Required	A unique id generated every time user purchases a plan. User can get it through Line inquiry API.
UOM		string	SECOND	Required	Type of balance user wants to adjust. User can get it through Line inquiry API.	BYTE,EVENT,SECOND Event represent the SMS, SECOND represent the Talk and BYTE represent the data. SECOND will adjust the balance in seconds and BYTE will adjust the data balance in bytes. Expiry date s an optional field and can be left blank if user does not wishes to change the expiry date of the plan.
AMOUNT		Number	1111	Conditional	Amount of the balance to be adjusted.	Balance you want adjust.
EXPIRY DATE		string	MM/DD/YYYY	Conditional	Enter the date if you want to change the expiry date of the Plan.	04/22/2020
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE, POS
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 don't need to pass the Agent Password in the XML API.

Sample Request XML

<?xml version="1.0" encoding="utf-8"?>
<VCAREOSSAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CREDENTIALS>
	<VENDORID></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
	<ADJUSTBALANCE>
		<MDN></MDN>
		<SUBSCRIPTIONID></SUBSCRIPTIONID>
		<UOM></UOM>
		<AMOUNT></AMOUNT>
		<EXPIRYDATE></EXPIRYDATE>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
	</ADJUSTBALANCE>
</VCAREOSS>
</VCAREOSSAPI>

List of status code and description.
Status Code	Description
00	SUCCESS
01	Error Received from Carrier.
13	Password is invalid.
16	Vendor not found. Wrong credentials.
43	Multiple input errors.
44	Input error.
125	MDN should not be blank.
126	Invalid MDN.
168	Invalid Amount.
257	MDN details not found in database.
367	MDN should be 10 digits.
807	UOM should not be blank.
808	UOM value should be BYTE,EVENT,SECOND
809	Subscription ID should not be blank

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>11111</referenceNumber>
    </credentials>
    <AdjustBalance>
	 <statusCode>00</statusCode>
	 <description>SUCCESS</description>
	 <errorDescription>SUCCESS</errorDescription>
	 <mdn></mdn>
	 <massage></massage>
    <AdjustBalance>
</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>
<AdjustBalance>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</AdjustBalance>
</VcareOssApi>

Error Received from Carrier.

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>
<AdjustBalance>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</AdjustBalance>
</VcareOssApi>

Password is invalid.

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>
<AdjustBalance>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</AdjustBalance>
</VcareOssApi>

Vendor not found. Wrong credentials.

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>
<AdjustBalance>
	<statusCode>43</statusCode>
	<description>FAIL</description>
	<errorDescription>Multiple input errors.</errorDescription>
</AdjustBalance>
</VcareOssApi>

Multiple input errors.

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>
<AdjustBalance>
	<statusCode>44</statusCode>
	<description>FAIL</description>
	<errorDescription>Input error.</errorDescription>
</AdjustBalance>
</VcareOssApi>

Input error.

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>
<AdjustBalance>
	<statusCode>125</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN should not be blank.</errorDescription>
</AdjustBalance>
</VcareOssApi>

MDN should not be blank.

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>
<AdjustBalance>
	<statusCode>126</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid MDN.</errorDescription>
</AdjustBalance>
</VcareOssApi>

Invalid MDN.

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>
<AdjustBalance>
	<statusCode>168</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Amount.</errorDescription>
</AdjustBalance>
</VcareOssApi>

Invalid Amount.

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>
<AdjustBalance>
	<statusCode>257</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN details not found in database.</errorDescription>
</AdjustBalance>
</VcareOssApi>

MDN details not found in database.

Sample Fail Response: 10

<?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>
<AdjustBalance>
	<statusCode>367</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN should be 10 digits.</errorDescription>
</AdjustBalance>
</VcareOssApi>

MDN should be 10 digits.

Sample Fail Response: 11

<?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>
<AdjustBalance>
	<statusCode>807</statusCode>
	<description>FAIL</description>
	<errorDescription>UOM should not be blank.</errorDescription>
</AdjustBalance>
</VcareOssApi>

UOM should not be blank.

Sample Fail Response: 12

<?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>
<AdjustBalance>
	<statusCode>808</statusCode>
	<description>FAIL</description>
	<errorDescription>UOM value should be BYTE,EVENT,SECOND</errorDescription>
</AdjustBalance>
</VcareOssApi>

UOM value should be BYTE,EVENT,SECOND

Sample Fail Response: 13

<?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>
<AdjustBalance>
	<statusCode>809</statusCode>
	<description>FAIL</description>
	<errorDescription>Subscription ID should not be blank</errorDescription>
</AdjustBalance>
</VcareOssApi>

Subscription ID should not be blank