ValidatePin

This api is used to validate a pin. This is only applicable if you are using Telgoo5 PIN management system.

End Point https://www.vcareapi.com/vcareOssApi/ValidatePin/
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 12365478965412300 Required Telgoo5 generated PIN number. Validate PIN NUMBER for category as below .
  • New Activation
  • Change Plan
  • Add Wallet
  • TOPUP
  • Data Topup
  • ILD Topup
 MIN =8, MAX=25 chars
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 The order request source Expected Value:API, TABLET, IVR, WEBSITE
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>
	<VALIDATEPIN>
	<PINNUMBER></PINNUMBER>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
	</VALIDATEPIN>
</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.
55 Invalid agent login. Please provide valid agent login.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
390 Currently given agent ID status is inactive in system. Please provide active agent ID.
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>
     <ValidatePin>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <msg_code>00</msg_code>
        <pin>131241423423432</pin>
        <category_id>1</category_id>
        <category_name>TOPUP</category_name>
        <denomination>WD3</denomination>
        <company_id>1</company_id>
    </ValidatePin>
</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>
	<ValidatePin>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ValidatePin>
</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>
	<ValidatePin>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ValidatePin>
</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>
	<ValidatePin>
	<statusCode>55</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid agent login.</errorDescription>
</ValidatePin>
</VcareOssApi>
Error Description: Invalid agent login.
How to Resolve?: Please provide valid agent login.
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>
	<ValidatePin>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</ValidatePin>
</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>
	<ValidatePin>
	<statusCode>390</statusCode>
	<description>FAIL</description>
	<errorDescription>Currently given agent ID status is inactive in system.</errorDescription>
</ValidatePin>
</VcareOssApi>
Error Description: Currently given agent ID status is inactive in system.
How to Resolve?: Please provide active agent ID.
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>
	<ValidatePin>
	<statusCode>436</statusCode>
	<description>FAIL</description>
	<errorDescription>PIN Number should not be blank.</errorDescription>
</ValidatePin>
</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: 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>
	<ValidatePin>
	<statusCode>437</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid PIN Number.</errorDescription>
</ValidatePin>
</VcareOssApi>
Error Description: Invalid PIN Number.
How to Resolve?: Invalid PIN Number. 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>
	<ValidatePin>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</ValidatePin>
</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>
	<ValidatePin>
	<statusCode>701</statusCode>
	<description>FAIL</description>
	<errorDescription>PIN Number should be greater  than 8 and less than 25 digits.</errorDescription>
</ValidatePin>
</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.