Telgoo5 APIs

RedeemPin

This API can be used to redeem a Telgoo5 generated PIN to a subscribers telephone number.

End Point	https://www.vcareapi.com/vcareOssApi/RedeemPin/
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.
PIN NUMBER		Numeric/Alphanumeric	12365478965412300	Required	Telgoo5 generated PIN number. PIN NUMBER use for category as below . New Activation Change Plan Add Wallet TOPUP Data Topup ILD Topup	MIN =8, MAX=25 chars
MDN		Numeric	123456	Optional	A unique auto generated customer mdn. This is returned in createcustomer respoonse and can also be retrieved using GetCustomerInfo API call.
ZIP CODE		string	73001	Optional	This is the service address zipcode of the applicant.	Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
CATEGORY ID		string	73001	Optional	Category ID as below 1 = New Activation 2 = TOPUP 3 = Change Plan 4 = Add Wallet 5 = Data Topup 6 = ILD Topup	If Pin have not categorized then use the category ID.
PLAN ID		string	73001	Optional	This is RELOADID returned in another API response called "GetDenomination".
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.
SOURCE		string	API	Optional	Source of the order.	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>
	 <REDEEMPIN>
		<PINNUMBER></PINNUMBER>
		<MDN></MDN>
		<ZIP></ZIP>
		<CATEGORYID></CATEGORYID>
		<PLANID></PLANID>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE>API</SOURCE>
	 </REDEEMPIN>
    </VCAREOSS>
 </VCAREOSSAPI>

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
01	Error Received from Carrier.	Please try again with valid data.
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.
126	Invalid MDN.	Please provide valid MDN.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
436	PIN Number should not be blank.	PIN number can not be blank. You should enter a valid PIN number.
437	Invalid PIN Number.	Invalid PIN Number. You should enter a valid PIN number.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
701	PIN Number should be greater than 8 and less than 25 digits.	Enter a correct PIN Number. PIN Number should be greater than 8 and less than 25 digits.

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></vendorId>
        <referenceNumber></referenceNumber>
    </credentials>
    <RedeemPin>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
		<msg_code></msg_code>
		<enrollmentId></enrollmentId>
        <customerid>21424</customerid>
        <mdn>3432423432</mdn>
        <msl></msl>
        <ProvisionMsg>Provision Success</ProvisionMsg>
	</RedeemPin>
</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>
<RedeemPin>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</RedeemPin>
</VcareOssApi>

Error Description: Error Received from Carrier.

How to Resolve?: Please try again with valid data.

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

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

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>
<RedeemPin>
	<statusCode>15</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip code is invalid.</errorDescription>
</RedeemPin>
</VcareOssApi>

Error Description: Zip code is invalid.

How to Resolve?: Please enter valid zip code.

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

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

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

Error Description: Invalid MDN.

How to Resolve?: Please provide valid MDN.

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

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID as it cannot 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>
<RedeemPin>
	<statusCode>436</statusCode>
	<description>FAIL</description>
	<errorDescription>PIN Number should not be blank.</errorDescription>
</RedeemPin>
</VcareOssApi>

Error Description: PIN Number should not be blank.

How to Resolve?: PIN number can not be blank. You should enter a valid PIN number.

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>
<RedeemPin>
	<statusCode>437</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid PIN Number.</errorDescription>
</RedeemPin>
</VcareOssApi>

Error Description: Invalid PIN Number.

How to Resolve?: Invalid PIN Number. You should enter a valid PIN number.

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

Error Description: Invalid Source.

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

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>
<RedeemPin>
	<statusCode>701</statusCode>
	<description>FAIL</description>
	<errorDescription>PIN Number should be greater  than 8 and less than 25 digits.</errorDescription>
</RedeemPin>
</VcareOssApi>

Error Description: PIN Number should be greater than 8 and less than 25 digits.

How to Resolve?: Enter a correct PIN Number. PIN Number should be greater than 8 and less than 25 digits.

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