GetBalanceInfo

This XML API is used to get subscribers balance information.
This is API is only functional for Sprint and TMobile.

End Point https://www.vcareapi.com/vcareOssApi/GetBalanceInfo/
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 string 1234567890 Required This is the telephone number which is attached to the subscriber's account No hyphen allowed
ESN / SIM string 8901260713156280780 Conditional This is the ESN / SIM subscriber is assigned with. This can be obtained using another API called GetCustomerInfo. Can be alpha numeric. Max length = 25
CUSTOMER ID Numeric 123456 Conditional Auto generated customer account number. This can be obtained using another API called GetCustomerInfo.
ENROLLMENT ID string 123456 Conditional Auto generated customer enrollment ID. This can be obtained using another API called GetCustomerInfo.
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.
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE,POS
Sample Request XML
<?xml version="1.0" encoding="utf-8"?>
<VCAREOSSAPI xmlns="http://www.oss.vcarecorporation.com/oss"
mlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CREDENTIALS>
<VENDORID></VENDORID>
<USERNAME></USERNAME>
<PASSWORD></PASSWORD>
<PIN></PIN>
<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<GETBALANCEINFO>
	<TELEPHONENUMBER></TELEPHONENUMBER>
	<ESN></ESN>
	<CUSTOMERID></CUSTOMERID>
	<ENROLLMENTID></ENROLLMENTID>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE>API</SOURCE>
</GETBALANCEINFO>
</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.
243 Record(s) not found. Please provide valid value as Record(s) not found.
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.
739 Telephone number OR ESN OR Customer ID OR Enrollment ID required. Telephone number OR ESN OR Customer ID OR Enrollment ID required.
Sample Fail Response
Carrier :: TMobile (TMB)

<?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>
<GetBalanceInfo>
<statusCode>00</statusCode>
<description>SUCCESS</description>
<errorDescription>SUCCESS</errorDescription>
<CustomerDetails>
	<CustomerID></CustomerID>
	<FirstName></FirstName>
	<LastName></LastName>
	<ServiceAddress1></ServiceAddress1>
	<ServiceAddress2></ServiceAddress2>
	<City></City>
	<State></State>
	<Zip></Zip>
	<ESNNumber></ESNNumber>
	<TelephoneNumber></TelephoneNumber>
	<AccountStatus></AccountStatus>
	<Carrier></Carrier>
	<serviceType></serviceType>
	<uiccid></uiccid>
</CustomerDetails>
 <BALANCEDETAIL>
            <HOTLINENUMBER></HOTLINENUMBER>
            <HOTLINECHARGEABLE></HOTLINECHARGEABLE>
            <PURCHASE>
                <PURCHASEID></PURCHASEID>
                <TARIFFNAME></TARIFFNAME>
                <PLANCODE></PLANCODE>
                <BALANCES>
                    <SUBSCRIPTIONID></SUBSCRIPTIONID>
                    <UOM>BYTE</UOM>
                    <BALANCE></BALANCE>
                    <VALIDFROM></VALIDFROM>
                    <VALIDTO></VALIDTO>
                </BALANCES>
                <BALANCES>
                    <SUBSCRIPTIONID></SUBSCRIPTIONID>
                    <UOM></UOM>
                    <BALANCE></BALANCE>
                    <VALIDFROM></VALIDFROM>
                    <VALIDTO></VALIDTO>
                </BALANCES>
                <BALANCES>
                    <SUBSCRIPTIONID></SUBSCRIPTIONID>
                    <UOM></UOM>
                    <BALANCE></BALANCE>
                    <VALIDFROM></VALIDFROM>
                    <VALIDTO></VALIDTO>
                </BALANCES>
            </PURCHASE>
            <TOTALBALANCE>
                <TALK></TALK>
                <TEXT></TEXT>
                <DATA></DATA>
            </TOTALBALANCE>
        </BALANCEDETAIL>
  </GetBalanceInfo>
</VcareOssApi>




Carrier :: Sprint (SPR)

<?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>111111</referenceNumber>
</credentials>
<GetBalanceInfo>
<statusCode>00</statusCode>
<description>SUCCESS</description>
<errorDescription></errorDescription>
<CustomerDetails>
	<CustomerID>SUCCESS</CustomerID>
	<FirstName></FirstName>
	<LastName></LastName>
	<ServiceAddress1></ServiceAddress1>
	<ServiceAddress2></ServiceAddress2>
	<City></City>
	<State></State>
	<Zip></Zip>
	<ESNNumber></ESNNumber>
	<TelephoneNumber></TelephoneNumber>
	<AccountStatus></AccountStatus>
	<Carrier></Carrier>
	<serviceType></serviceType>
	<uiccid></uiccid>
</CustomerDetails>
 <BALANCEDETAIL>
            <SUBSCRIBERID></SUBSCRIBERID>
            <SUBSCRIBERSTATE></SUBSCRIBERSTATE>
            <PRIMARY_RESOURCE></PRIMARY_RESOURCE>
            <PURCHASE>
                <PURCHASEID></PURCHASEID>
                <TARIFFNAME></TARIFFNAME>
                <TARIFFTYPE></TARIFFTYPE>
                <PLANCODE></PLANCODE>
                <PS_STATE></PS_STATE>
                <NEXT_RENEWAL></NEXT_RENEWAL>
                <TOTALBALANCE>
                    <TALK></TALK>
                    <TEXT></TEXT>
                    <DATA></DATA>
                </TOTALBALANCE>
                <BALANCES>
                    <CYCLE>
                        <SUBSCRIPTIONID></SUBSCRIPTIONID>
                        <UOM></UOM>
                        <BALANCE></BALANCE>
                        <VALIDFROM></VALIDFROM>
                        <VALIDTO></VALIDTO>
                        <CYCLE></CYCLE>
                    </CYCLE>
                    <CYCLE>
                        <SUBSCRIPTIONID></SUBSCRIPTIONID>
                        <UOM></UOM>
                        <BALANCE></BALANCE>
                        <VALIDFROM></VALIDFROM>
                        <VALIDTO></VALIDTO>
                        <CYCLE></CYCLE>
                    </CYCLE>
                </BALANCES>
            </PURCHASE>
        </BALANCEDETAIL>
  </GetBalanceInfo>
</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>
<GetBalanceInfo>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</GetBalanceInfo>
</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>
<GetBalanceInfo>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</GetBalanceInfo>
</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>
<GetBalanceInfo>
	<statusCode>243</statusCode>
	<description>FAIL</description>
	<errorDescription>Record(s) not found.</errorDescription>
</GetBalanceInfo>
</VcareOssApi>
Error Description: Record(s) not found.
How to Resolve?: Please provide valid value as Record(s) not found.
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>
<GetBalanceInfo>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</GetBalanceInfo>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
<GetBalanceInfo>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</GetBalanceInfo>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<GetBalanceInfo>
	<statusCode>739</statusCode>
	<description>FAIL</description>
	<errorDescription>Telephone number OR ESN OR Customer ID OR Enrollment ID required.</errorDescription>
</GetBalanceInfo>
</VcareOssApi>
Error Description: Telephone number OR ESN OR Customer ID OR Enrollment ID required.
How to Resolve?: Telephone number OR ESN OR Customer ID OR Enrollment ID required.

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