Telgoo5 APIs

GetTaxDetails

This XML API returns the status of the tax details

End Point	https://www.vcareapi.com/vcareOssApi/GetTaxDetails/
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.
AMOUNT		string	30	Required	This is the amount on which you want to calculate the tax and want the tax break up
ZIP CODE		string	21215	Required	This is the state Zipcode. This is required because taxes may vary from state to state
TRANSACTION TYPE		string	ProcessingFee	Required	This is the transaction type on the basis of which tax is calculated. Taxes may vary for different transaction types.	ProcessingFee EquipmentPurchase Topup RegularMonthlyBilling
PLAN TOPUP ID		Numeric	452	Optional	Plan ID : This is returned in GetPlanList API and RELOADID : This is returned in GetDenomination API	If category is TOPUP/DATA/UPGRADE then pass RELOADID. If category is CHANGE_PLAN/PLAN_RENEW then pass Plan ID
PAYMENT CATEGORY		string	Payment category	Optional	This is the payment category on the basis of which Processing fee is calculated. Payment category as below.	TOPUP DATA UPGRADE CHANGE_PLAN PLAN_RENEW EQUIPMENT_PURCHASE AUTOPAY NEW_SIGNUP BILL_PAY ADD_WALLET
PAYMENT TYPE		string	Payment Type	Optional	This is the payment type on the basis of which Processing fee is calculated. Payment type as below.	Credit_Card Wallet Dealer_Wallet Money_Gram Money_Order Cash Echeck
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE
AGENT ID		string	John Doe	Required	This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENT PASSWORD		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.

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>Vcarecorporation</VENDORID>
	<USERNAME>Vcarecorporation</USERNAME>
	<PASSWORD>Vcarecorporation</PASSWORD>
	<PIN>Vcarecorporation</PIN>
	<REFERENCENUMBER>11111</REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
<GETTAXDETAILS>
	<AMOUNT>30.00</AMOUNT>
	<ZIPCODE>21215</ZIPCODE>
	<TRANSACTIONTYPE>Topup</TRANSACTIONTYPE>
	<PLANTOPUPID></PLANTOPUPID>
	<PAYMENTCATEGORY></PAYMENTCATEGORY>
	<PAYMENTTYPE></PAYMENTTYPE>
	<AGENTID>Zeeshan Ahmed</AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</GETTAXDETAILS>
</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.
15	Zip code is invalid.	Please enter valid zip code.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
168	Invalid Amount.	Please provide a valid Amount.
179	Amount should not be blank OR zero.	Please provide amount. Amount cannot be left blank OR zero.
272	Wrong transaction type.	Please provide correct transaction type.
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.
492	Zip code should not be blank.	Provide correct Zip code. Zip code should not be blank.

Sample Response 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>Vcarecorporation</vendorId>
        <referenceNumber>11111</referenceNumber>
    </credentials>
    <GetTaxDetails>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <taxTotal>4.69</taxTotal>
        <subTotal>30.00</subTotal>
        <total>34.69</total>
		<processing_fee>0.00</processing_fee>
        <taxDetail>
            <tax>
                <amount>1.93</amount>
                <name>STATE SALES TAX</name>
            </tax>
            <tax>
                <amount>0.60</amount>
                <name>MD PREPAID WIRELESS E 911 FEE</name>
            </tax>
            <tax>
                <amount>1.90</amount>
                <name>FEDERAL UNIVERSAL SERVICE FUND</name>
            </tax>
            <tax>
                <amount>0.25</amount>
                <name>FEDERAL COST RECOVERY CHARGE</name>
            </tax>
        </taxDetail>
    </GetTaxDetails>
</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>
<GetTaxDetails>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</GetTaxDetails>
</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>
<GetTaxDetails>
	<statusCode>15</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip code is invalid.</errorDescription>
</GetTaxDetails>
</VcareOssApi>

Error Description: Zip code is invalid.

How to Resolve?: Please enter valid zip code.

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

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor 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>
<GetTaxDetails>
	<statusCode>168</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Amount.</errorDescription>
</GetTaxDetails>
</VcareOssApi>

Error Description: Invalid Amount.

How to Resolve?: Please provide a valid Amount.

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>
<GetTaxDetails>
	<statusCode>179</statusCode>
	<description>FAIL</description>
	<errorDescription>Amount should not be blank OR zero.</errorDescription>
</GetTaxDetails>
</VcareOssApi>

Error Description: Amount should not be blank OR zero.

How to Resolve?: Please provide amount. Amount cannot be left blank OR zero.

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>
<GetTaxDetails>
	<statusCode>272</statusCode>
	<description>FAIL</description>
	<errorDescription>Wrong transaction type.</errorDescription>
</GetTaxDetails>
</VcareOssApi>

Error Description: Wrong transaction type.

How to Resolve?: Please provide correct transaction type.

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>
<GetTaxDetails>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</GetTaxDetails>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

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

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

Error Description: Invalid Source.

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

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>
<GetTaxDetails>
	<statusCode>492</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip code  should not be blank.</errorDescription>
</GetTaxDetails>
</VcareOssApi>

Error Description: Zip code should not be blank.

How to Resolve?: Provide correct Zip code. Zip code should not be blank.

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