BillPay

This API is used to pay a billed invoice. A transaction invoice is already generated for this bill payment api call and hence do not require any invoice to be added using any other method.

End Point https://www.vcareapi.com/vcareOssApi/BillPay/
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.
CUSTOMER ID Numeric 123456 Required Auto generated customer account number. This is returned in GetCustomerInfo
PAYMENT TYPE string CC Required This is the payment source CC,CASH,WALLET,DEALER_WALLET
CARD NUMBER Numeric 4111111111111110 Conditional This is the credit/debit card number. This is required if the payment type is CC. Max=16 digits
CARD TYPE String VISA Conditional This is the CVV number of the card. This is required if the payment type is CC. VISA, MASTER, DISCOVER, AMEX
EXPIRATION MONTH Numeric 11 Conditional This is the expiration month of the credit/debit card. This is required if the payment type is CC. Max 2 digits
EXPIRATION YEAR Numeric 2018 Conditional This is the expiration year of the card. This is required if the payment type is CC. Exactly 4 digits
CVV NUMBER string Numeric Conditional This is the CVV number of the card. This is required if the payment type is CC. Max=4 digits
NAME ON CARD string John Doe Conditional This is the name on the credit/debit. This is required if the payment type is CC.  
BILLING ADDRESS1 string 123 Main st Conditional This is the Billing address line 1 for the associated bank account. This is required if the payment type is CC. Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
BILLING ADDRESS2 string Apt 1 Optional This is the Billing address line 2 for the associated bank account. Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
BILLING CITY string San Jose Conditional This is the Billing address City for the associated bank account. This is required if the payment type is CC. Should allow only letters, hyphen and space.
BILLING STATE string CA Conditional This is the state of the registered billing address in the bank account to which the card is associated. This is required if the payment type is CC. State should be standard abbreviated form.
BILLING ZIPCODE string 90001 Conditional This is the Billing address Zip Code for the associated bank account. This is required if the payment type is CC. Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
TOTAL PAYMENT string 30 Conditional This is required if the payment type is CC or CASH. This is the amount that will be charged against the card.Total payments exclude taxes and processing fees. To get the tax details and processing fees call the GetTaxDetails API.
INVOICE NO string 2018-10-687 Optional This can be obtained using the GetInvoiceDetails XML API You can pay multiple invoice with comma seprated. Ex:- 2018-10-687,2018-10-686,2018-10-685
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 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>
<BILLPAY>
	<CUSTOMERID></CUSTOMERID>
	<PAYMENTTYPE></PAYMENTTYPE>
	<CARD></CARD>
	<CARDTYPE></CARDTYPE>
	<EXPIRATION_MONTH></EXPIRATION_MONTH>
	<EXPIRATION_YEAR></EXPIRATION_YEAR>
	<CARDCODE></CARDCODE>
	<NAMECARD></NAMECARD>
	<ADD1></ADD1>
	<ADD2></ADD2>
	<CITY></CITY>
	<STATE></STATE>
	<ZIP></ZIP>
	<TOTALPAYAMOUNT></TOTALPAYAMOUNT>
	<INVOICE_NO></INVOICE_NO>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</BILLPAY>
</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.
21 Invalid State. Provide a valid State
25 Customer ID is invalid. Provide a valid Customer ID.
71 Invalid OR empty address. Please provide a valid address.
72 Invalid City. Please provide valid City.
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.
109 Credit Card Number is required. Credit card number cannot be blank. You should enter a valid Credit card number.
110 Card Name is required. Card name cannot be blank. You should enter a valid Card name.
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.
215 Invalid Card Details. Please provide a valid Card Details.
219 Payment type is required. Please provide Payment type.
220 Card code is required. Please provide Card code.
226 Customer ID is required. Please provide Customer ID.
288 Updated OR Created by user ID not found. Updated OR Created by user ID not found.
335 Payment type is Invalid. Please provide a valid Payment 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.
757 Total amount should not be blank OR zero. Provide a valid Total amount. Total amount should not be blank.
758 Invalid total amount. Please provide a valid total amount. Given value is invalid for total amount.
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>
    <BillPay>
		<statusCode>00</statusCode>
		<description>SUCCESS</description>
		<errorDescription>SUCCESS</errorDescription>
		<transactionNumber>3543543</transactionNumber>
		<invoiceNumber>4543543</invoiceNumber>
		<payBillMsg>test</payBillMsg>
		<invoices>
			<invoice>
				<msg_code></msg_code>
				<msg></msg>
				<invoiceNumber></invoiceNumber>
				<invoiceAmount></invoiceAmount>
				<transactionId></transactionId>
			</invoice>
			<invoice>
				<msg_code></msg_code>
				<msg></msg>
				<invoiceNumber></invoiceNumber>
				<invoiceAmount></invoiceAmount>
				<transactionId></transactionId>
			</invoice>
		</invoices>

    </BillPay>
</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>
<BillPay>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</BillPay>
</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>
<BillPay>
	<statusCode>15</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip code is invalid.</errorDescription>
</BillPay>
</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>
<BillPay>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</BillPay>
</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>
<BillPay>
	<statusCode>21</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid State.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Invalid State.
How to Resolve?: Provide a valid State
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>
<BillPay>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Customer ID is invalid.
How to Resolve?: Provide a valid Customer 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>
<BillPay>
	<statusCode>71</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid OR empty address.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Invalid OR empty address.
How to Resolve?: Please provide a valid address.
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>
<BillPay>
	<statusCode>72</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid City.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Invalid City.
How to Resolve?: Please provide valid City.
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>
<BillPay>
	<statusCode>105</statusCode>
	<description>FAIL</description>
	<errorDescription>Expiry Month is required.</errorDescription>
</BillPay>
</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: 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>
<BillPay>
	<statusCode>107</statusCode>
	<description>FAIL</description>
	<errorDescription>Expiry Year is required.</errorDescription>
</BillPay>
</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: 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>
<BillPay>
	<statusCode>109</statusCode>
	<description>FAIL</description>
	<errorDescription>Credit Card Number is required.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Credit Card Number is required.
How to Resolve?: Credit card number cannot be blank. You should enter a valid Credit card number.
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>
<BillPay>
	<statusCode>110</statusCode>
	<description>FAIL</description>
	<errorDescription>Card Name is required.</errorDescription>
</BillPay>
</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: 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>
<BillPay>
	<statusCode>113</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip Code is required.</errorDescription>
</BillPay>
</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: 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>
<BillPay>
	<statusCode>116</statusCode>
	<description>FAIL</description>
	<errorDescription>City is required.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: City is required.
How to Resolve?: City cannot be blank. You should enter a valid City.
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>
<BillPay>
	<statusCode>118</statusCode>
	<description>FAIL</description>
	<errorDescription>State is required.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: State is required.
How to Resolve?: State cannot be blank. You should enter a valid State.
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>
<BillPay>
	<statusCode>215</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Card Details.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Invalid Card Details.
How to Resolve?: Please provide a valid Card Details.
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>
<BillPay>
	<statusCode>219</statusCode>
	<description>FAIL</description>
	<errorDescription>Payment type is required.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Payment type is required.
How to Resolve?: Please provide Payment type.
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>
<BillPay>
	<statusCode>220</statusCode>
	<description>FAIL</description>
	<errorDescription>Card code is required.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Card code is required.
How to Resolve?: Please provide Card code.
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>
<BillPay>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Customer ID is required.
How to Resolve?: Please provide Customer ID.
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>
<BillPay>
	<statusCode>288</statusCode>
	<description>FAIL</description>
	<errorDescription>Updated OR Created by user ID not found.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Updated OR Created by user ID not found.
How to Resolve?: Updated OR Created by user ID not found.
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>
<BillPay>
	<statusCode>335</statusCode>
	<description>FAIL</description>
	<errorDescription>Payment type is Invalid.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Payment type is Invalid.
How to Resolve?: Please provide a valid Payment type.
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>
<BillPay>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
<BillPay>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<BillPay>
	<statusCode>757</statusCode>
	<description>FAIL</description>
	<errorDescription>Total amount should not be blank OR zero.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Total amount should not be blank OR zero.
How to Resolve?: Provide a valid Total amount. Total amount should not be blank.
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>
<BillPay>
	<statusCode>758</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid total amount.</errorDescription>
</BillPay>
</VcareOssApi>
Error Description: Invalid total amount.
How to Resolve?: Please provide a valid total amount. Given value is invalid for total amount.

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