GetDenomination

This API is used to get the available topups/addons available for a subscriber to purchase.

End Point https://www.vcareapi.com/vcareOssApi/GetDenomination/
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.
COMPANY ID Numeric 28 Required This can be obtained using GetCompany API Numeric
STATE string MD Required The state in which subscriber belongs to. State should be in standard abbreviated form.
CARRIER string SPR Optional The carrier in which subscriber belongs to. carrier should be in standard abbreviated form.
PAYMENTTYPE string Credit Card Required This returns the denominations in the system on the basis of the payment type. Credit Card- This will return the topups/addons available for purchase. Courtesy- This will return the free topups/addons if configured. Credit Card or Courtesy
TYPE string TOPUP Optional TYPE as TOPUP / DATA / UPGRADE will fetch available Denomination along with plans id's in response accordingly. It should be TOPUP, DATA, UPGRADE
AMOUNT Numeric 30 Optional Search with plan using amount. All plan listed below input amount. It should be number
TOPUP CATEGORY string PREMIUM Optional Topup category as Premium will fetch available Denomination along with plans id's in response accordingly. It should be PREMIUM
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 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>
<GETDENOMINATION>
	<COMPANYID></COMPANYID>
	<STATE></STATE>
	<CARRIER></CARRIER>
	<PAYMENTTYPE></PAYMENTTYPE>
	<TYPE></TYPE>
	<AMOUNT></AMOUNT>
	<TOPUPCATEGORY></TOPUPCATEGORY>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
  </GETDENOMINATION>
 </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.
118 State is required. State cannot be blank. You should enter a valid State.
169 Company ID is required. Please provide company ID.
219 Payment type is required. Please provide Payment type.
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.
667 Type should be TOPUP, DATA, and UPGRADE. Provide correct Type. Type should be Topup or DATA or UPGRADE.
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></vendorId>
        <referenceNumber></referenceNumber>
    </credentials>
    <GetDenomination>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <carrier>
			<info>
				<carriercode></carriercode>
				<planid></planid>
				<reloadid></reloadid>
				<amount></amount>
				<type></type>
				<voice></voice>
				<sms></sms>
				<data></data>
				<carriername></carriername>
				<details></details>
				<topupcategory>premium</topupcategory>
			</info>
			 <info>
				<carriercode></carriercode>
				<planid></planid>
				<reloadid></reloadid>
				<amount></amount>
				<type></type>
				<voice></voice>
				<sms></sms>
				<data></data>
				<carriername></carriername>
				<details></details>
				<topupcategory>premium</topupcategory>
			</info>
			 <info>
				<carriercode></carriercode>
				<planid></planid>
				<reloadid></reloadid>
				<amount></amount>
				<type></type>
				<voice></voice>
				<sms></sms>
				<data></data>
				<carriername></carriername>
				<details></details>
				<topupcategory>premium</topupcategory>
			</info>
        </carrier>
    </GetDenomination>
</VcareOssApi>

SUCCESS

<carriercode>

This is the actual plan code which is setup at the carrier for the given topup/addon.

<planid>

This is ID which is setup in VCare for the given topup/addon, this Plan Id needs to be passed in the AddBalance API to apply add on to the subscriber's account.

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>
<GetDenomination>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</GetDenomination>
</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>
<GetDenomination>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</GetDenomination>
</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>
<GetDenomination>
	<statusCode>118</statusCode>
	<description>FAIL</description>
	<errorDescription>State is required.</errorDescription>
</GetDenomination>
</VcareOssApi>
Error Description: State is required.
How to Resolve?: State cannot be blank. You should enter a valid State.
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>
<GetDenomination>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</GetDenomination>
</VcareOssApi>
Error Description: Company ID is required.
How to Resolve?: Please provide company ID.
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>
<GetDenomination>
	<statusCode>219</statusCode>
	<description>FAIL</description>
	<errorDescription>Payment type is required.</errorDescription>
</GetDenomination>
</VcareOssApi>
Error Description: Payment type is required.
How to Resolve?: Please provide Payment type.
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>
<GetDenomination>
	<statusCode>243</statusCode>
	<description>FAIL</description>
	<errorDescription>Record(s) not found.</errorDescription>
</GetDenomination>
</VcareOssApi>
Error Description: Record(s) not found.
How to Resolve?: Please provide valid value as Record(s) not found.
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>
<GetDenomination>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</GetDenomination>
</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>
<GetDenomination>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</GetDenomination>
</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>
<GetDenomination>
	<statusCode>667</statusCode>
	<description>FAIL</description>
	<errorDescription>Type should be TOPUP, DATA, and UPGRADE.</errorDescription>
</GetDenomination>
</VcareOssApi>
Error Description: Type should be TOPUP, DATA, and UPGRADE.
How to Resolve?: Provide correct Type. Type should be Topup or DATA or UPGRADE.

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