AddBalanceWithInvoice
One can apply Addon/Toup and generate an invoice for the payments made outisde vcare system. This API can be used for Cash Payment, Money Gram, Western Union. Ace Cash etc.
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> <PartnerName></PartnerName> <PASSWORD></PASSWORD> <PIN></PIN> <REFERENCENUMBER></REFERENCENUMBER> </CREDENTIALS> <VCAREOSS> <ADDBALANCEWITHINVOICE> <CUSTOMERID></CUSTOMERID> <MDN></MDN> <PLANID></PLANID> <ILDAMOUNT></ILDAMOUNT> <RECEIPTNUMBER></RECEIPTNUMBER> <PAYMENTTYPE></PAYMENTTYPE> <BALANCETYPE></BALANCETYPE> <TAXREQUIRED></TAXREQUIRED> <--Card Info Start--> <CARDTYPE></CARDTYPE> <CARDVALUE></CARDVALUE> <CARDCODE></CARDCODE> <EXPIRATION_MONTH></EXPIRATION_MONTH> <EXPIRATION_YEAR></EXPIRATION_YEAR> <NAMEONCARD></NAMEONCARD> <BILLINGSTATE></BILLINGSTATE> <BILLINGADDRESS></BILLINGADDRESS> <BILLINGADDRESS2></BILLINGADDRESS2> <BILLINGCITY></BILLINGCITY> <BILLINGZIPCODE></BILLINGZIPCODE> <--Card Info End--> <AGENTID></AGENTID> <AGENTPASSWORD></AGENTPASSWORD> <SOURCE></SOURCE> </ADDBALANCEWITHINVOICE> </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. |
25 | Customer ID is invalid. | Provide a valid Customer ID. |
72 | Invalid City. | Please provide valid City. |
102 | Card type is required. | Card Type can not be blank. You should enter a valid Card Type. |
104 | Credit Card Number is not valid. | Please provide a valid Credit Card. |
105 | Expiry Month is required. | Expiry month cannot be blank. You should enter a valid expire month. |
107 | Expiry Year is required. | Expire year cannot be blank. You should enter a valid expire year. |
110 | Card Name is required. | Card name cannot be blank. You should enter a valid Card name. |
111 | Name on Card is invalid. | Please provide a valid Name on Card. |
113 | Zip Code is required. | Zip code cannot be blank. You should enter a valid Zip code. |
116 | City is required. | City cannot be blank. You should enter a valid City. |
118 | State is required. | State cannot be blank. You should enter a valid State. |
120 | Billing Address is required. | Billing address cannot be blank. You should enter a valid billing address. |
125 | MDN should not be blank. | Please provide MDN. MDN cannot be left blank. |
126 | Invalid MDN. | Please provide valid MDN. |
174 | You are not eligible for upgrade topup. | You are not eligible for upgrade topup. |
204 | PlanID cannot be empty. | Provide a valid PlanID. |
219 | Payment type is required. | Please provide Payment type. |
220 | Card code is required. | Please provide Card code. |
300 | Balance Type is required. | Please provide Balance Type. |
367 | MDN should be 10 digits. | Please provide a valid MDN and it should be 10 digits. |
431 | Wallet balance is low. | Wallet balance is low. |
483 | Payment type should be CREDIT CARD, CASH, MONEY ORDER, MONEY GRAM, WALLET, MY WALLET, COURTESY | Provide correct Payment Type. Payment type should be CREDIT CARD, CASH, MONEY ORDER, MONEY GRAM, WALLET, MY WALLET, COURTESY. |
484 | Balance type should be TOPUP, DATA, UPGRADE, and ILD. | Provide correct Balance type. Balance type should be TOPUP, DATA, UPGRADE, and ILD. |
485 | Plan ID is not correct. | Provide correct plan id. |
564 | Customer ID OR MDN is required. | Choose between Customer ID or MDN. Customer ID or MDN is required. |
745 | ILD AMOUNT required. | ILD AMOUNT can not be blank. You should enter a valid ILD AMOUNT. |
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> <AddBalanceWithInvoice> <statusCode>00</statusCode> <description>SUCCESS</description> <postbalance></postbalance> <prebalance></prebalance> <topupstatus></topupstatus> <topupvalue></topupvalue> <invoiceNumber></invoiceNumber> <TRANSACTIONID></TRANSACTIONID> <totalamount></totalamount> <purchase_id></purchase_id> <msg></msg> </AddBalanceWithInvoice> </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> <AddBalanceWithInvoice> <statusCode>13</statusCode> <description>FAIL</description> <errorDescription>Password is invalid.</errorDescription> </AddBalanceWithInvoice> </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> <AddBalanceWithInvoice> <statusCode>15</statusCode> <description>FAIL</description> <errorDescription>Zip code is invalid.</errorDescription> </AddBalanceWithInvoice> </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> <AddBalanceWithInvoice> <statusCode>25</statusCode> <description>FAIL</description> <errorDescription>Customer ID is invalid.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Customer ID is invalid.
How to Resolve?: Provide a valid Customer ID.
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> <AddBalanceWithInvoice> <statusCode>72</statusCode> <description>FAIL</description> <errorDescription>Invalid City.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Invalid City.
How to Resolve?: Please provide valid City.
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> <AddBalanceWithInvoice> <statusCode>102</statusCode> <description>FAIL</description> <errorDescription>Card type is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Card type is required.
How to Resolve?: Card Type can not be blank. You should enter a valid Card 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> <AddBalanceWithInvoice> <statusCode>104</statusCode> <description>FAIL</description> <errorDescription>Credit Card Number is not valid.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Credit Card Number is not valid.
How to Resolve?: Please provide a valid Credit Card.
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> <AddBalanceWithInvoice> <statusCode>105</statusCode> <description>FAIL</description> <errorDescription>Expiry Month is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Expiry Month is required.
How to Resolve?: Expiry month cannot be blank. You should enter a valid expire month.
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> <AddBalanceWithInvoice> <statusCode>107</statusCode> <description>FAIL</description> <errorDescription>Expiry Year is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Expiry Year is required.
How to Resolve?: Expire year cannot be blank. You should enter a valid expire year.
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> <AddBalanceWithInvoice> <statusCode>110</statusCode> <description>FAIL</description> <errorDescription>Card Name is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Card Name is required.
How to Resolve?: Card name cannot be blank. You should enter a valid Card name.
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> <AddBalanceWithInvoice> <statusCode>111</statusCode> <description>FAIL</description> <errorDescription>Name on Card is invalid.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Name on Card is invalid.
How to Resolve?: Please provide a valid Name on Card.
Sample Fail Response: 11
<?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> <AddBalanceWithInvoice> <statusCode>113</statusCode> <description>FAIL</description> <errorDescription>Zip Code is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Zip Code is required.
How to Resolve?: Zip code cannot be blank. You should enter a valid Zip code.
Sample Fail Response: 12
<?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> <AddBalanceWithInvoice> <statusCode>116</statusCode> <description>FAIL</description> <errorDescription>City is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: City is required.
How to Resolve?: City cannot be blank. You should enter a valid City.
Sample Fail Response: 13
<?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> <AddBalanceWithInvoice> <statusCode>118</statusCode> <description>FAIL</description> <errorDescription>State is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: State is required.
How to Resolve?: State cannot be blank. You should enter a valid State.
Sample Fail Response: 14
<?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> <AddBalanceWithInvoice> <statusCode>120</statusCode> <description>FAIL</description> <errorDescription>Billing Address is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Billing Address is required.
How to Resolve?: Billing address cannot be blank. You should enter a valid billing address.
Sample Fail Response: 15
<?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> <AddBalanceWithInvoice> <statusCode>125</statusCode> <description>FAIL</description> <errorDescription>MDN should not be blank.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: MDN should not be blank.
How to Resolve?: Please provide MDN. MDN cannot be left blank.
Sample Fail Response: 16
<?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> <AddBalanceWithInvoice> <statusCode>126</statusCode> <description>FAIL</description> <errorDescription>Invalid MDN.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Invalid MDN.
How to Resolve?: Please provide valid MDN.
Sample Fail Response: 17
<?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> <AddBalanceWithInvoice> <statusCode>174</statusCode> <description>FAIL</description> <errorDescription>You are not eligible for upgrade topup.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: You are not eligible for upgrade topup.
How to Resolve?: You are not eligible for upgrade topup.
Sample Fail Response: 18
<?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> <AddBalanceWithInvoice> <statusCode>204</statusCode> <description>FAIL</description> <errorDescription>PlanID cannot be empty.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: PlanID cannot be empty.
How to Resolve?: Provide a valid PlanID.
Sample Fail Response: 19
<?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> <AddBalanceWithInvoice> <statusCode>219</statusCode> <description>FAIL</description> <errorDescription>Payment type is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Payment type is required.
How to Resolve?: Please provide Payment type.
Sample Fail Response: 20
<?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> <AddBalanceWithInvoice> <statusCode>220</statusCode> <description>FAIL</description> <errorDescription>Card code is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Card code is required.
How to Resolve?: Please provide Card code.
Sample Fail Response: 21
<?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> <AddBalanceWithInvoice> <statusCode>300</statusCode> <description>FAIL</description> <errorDescription>Balance Type is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Balance Type is required.
How to Resolve?: Please provide Balance Type.
Sample Fail Response: 22
<?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> <AddBalanceWithInvoice> <statusCode>367</statusCode> <description>FAIL</description> <errorDescription>MDN should be 10 digits.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: MDN should be 10 digits.
How to Resolve?: Please provide a valid MDN and it should be 10 digits.
Sample Fail Response: 23
<?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> <AddBalanceWithInvoice> <statusCode>431</statusCode> <description>FAIL</description> <errorDescription>Wallet balance is low.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Wallet balance is low.
How to Resolve?: Wallet balance is low.
Sample Fail Response: 24
<?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> <AddBalanceWithInvoice> <statusCode>483</statusCode> <description>FAIL</description> <errorDescription>Payment type should be CREDIT CARD, CASH, MONEY ORDER, MONEY GRAM, WALLET, MY WALLET, COURTESY</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Payment type should be CREDIT CARD, CASH, MONEY ORDER, MONEY GRAM, WALLET, MY WALLET, COURTESY
How to Resolve?: Provide correct Payment Type. Payment type should be CREDIT CARD, CASH, MONEY ORDER, MONEY GRAM, WALLET, MY WALLET, COURTESY.
Sample Fail Response: 25
<?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> <AddBalanceWithInvoice> <statusCode>484</statusCode> <description>FAIL</description> <errorDescription>Balance type should be TOPUP, DATA, UPGRADE, and ILD.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Balance type should be TOPUP, DATA, UPGRADE, and ILD.
How to Resolve?: Provide correct Balance type. Balance type should be TOPUP, DATA, UPGRADE, and ILD.
Sample Fail Response: 26
<?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> <AddBalanceWithInvoice> <statusCode>485</statusCode> <description>FAIL</description> <errorDescription>Plan ID is not correct.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Plan ID is not correct.
How to Resolve?: Provide correct plan id.
Sample Fail Response: 27
<?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> <AddBalanceWithInvoice> <statusCode>564</statusCode> <description>FAIL</description> <errorDescription>Customer ID OR MDN is required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: Customer ID OR MDN is required.
How to Resolve?: Choose between Customer ID or MDN. Customer ID or MDN is required.
Sample Fail Response: 28
<?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> <AddBalanceWithInvoice> <statusCode>745</statusCode> <description>FAIL</description> <errorDescription>ILD AMOUNT required.</errorDescription> </AddBalanceWithInvoice> </VcareOssApi>
Error Description: ILD AMOUNT required.
How to Resolve?: ILD AMOUNT can not be blank. You should enter a valid ILD AMOUNT.
All the status codes are listed under the status code sections. Please click here to go to the status code.