Payment
This API is used to take the payment via credit card or a debit card on the subscriber's account or refund.
Payments can be accepted for Add On, Equipment purchase, New signup plan purchase or on Plan Change.
Please note: There is another API AddBalanceWithPayment using which you can charge the credit or debit card and apply the Add on with one api call.
Sample Request XML
<?xml version="1.0" encoding="utf-8"?> <VCAREOSSAPI xmlns="http://www.oss.vcarecorporation.com/oss" mlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <CREDENTIALS> <VENDORID></VENDORID> <USERNAME></USERNAME> <PASSWORD></PASSWORD> <PIN></PIN> <REFERENCENUMBER></REFERENCENUMBER> </CREDENTIALS> <VCAREOSS> <PAYMENT> <ACTION></ACTION> <CUSTOMERID></CUSTOMERID> <ENROLLMENTID></ENROLLMENTID> <COMPANYID></COMPANYID> <TAXREQUIRED></TAXREQUIRED> <TOTALPAYMENT></TOTALPAYMENT> <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> <INVOICETYPEID></INVOICETYPEID> <TRANSACTIONID></TRANSACTIONID> <INVOICENUMBER></INVOICENUMBER> <LAST4DIGCC></LAST4DIGCC> <AGENTID></AGENTID> <AGENTPASSWORD></AGENTPASSWORD> <SOURCE></SOURCE> </PAYMENT> </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. |
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. |
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. |
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. |
130 | Invalid Company ID. | Please provide valid company id. |
168 | Invalid Amount. | Please provide a valid Amount. |
169 | Company ID is required. | Please provide company ID. |
179 | Amount should not be blank OR zero. | Please provide amount. Amount cannot be left blank OR zero. |
214 | Action should not be blank. | Please provide valid value as Action should not be blank. |
215 | Invalid Card Details. | Please provide a valid Card Details. |
220 | Card code is required. | Please provide Card code. |
356 | Agent ID cannot be blank. | Please provide Agent ID as it cannot be blank. |
395 | Invoice number should not be blank. | Please provide Invoice number as it cannot be blank. |
457 | Invalid Source. | Please provide a valid Source. Given value is invalid for Source. |
533 | Invalid invoice type ID. | Provide a valid invoice type ID. |
685 | Transaction ID should not be empty. | Provide a valid Transaction ID. Transaction ID should not be blank. |
686 | Invoice type ID is required. | Please provide a valid value as Invoice type ID is required. |
738 | Customer ID OR Enrollment ID not found in our system. | Customer ID OR Enrollment ID not found in our system. |
Sample Response
<?xml version="1.0" encoding="utf-8"?> <VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" mlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <credentials> <vendorId></vendorId> <referenceNumber></referenceNumber> </credentials> <Payment> <statusCode>00</statusCode> <description>SUCCESS</description> <transactionid></transactionid> <invoicenumber></invoicenumber> <totalchargedamount></totalchargedamount> <customerid></customerid> <enrollmentid></enrollmentid> <action></action> </Payment> </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> <Payment> <statusCode>13</statusCode> <description>FAIL</description> <errorDescription>Password is invalid.</errorDescription> </Payment> </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> <Payment> <statusCode>15</statusCode> <description>FAIL</description> <errorDescription>Zip code is invalid.</errorDescription> </Payment> </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> <Payment> <statusCode>16</statusCode> <description>FAIL</description> <errorDescription>Vendor not found. Wrong credentials.</errorDescription> </Payment> </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> <Payment> <statusCode>21</statusCode> <description>FAIL</description> <errorDescription>Invalid State.</errorDescription> </Payment> </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> <Payment> <statusCode>25</statusCode> <description>FAIL</description> <errorDescription>Customer ID is invalid.</errorDescription> </Payment> </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> <Payment> <statusCode>72</statusCode> <description>FAIL</description> <errorDescription>Invalid City.</errorDescription> </Payment> </VcareOssApi>
Error Description: Invalid City.
How to Resolve?: Please provide valid City.
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> <Payment> <statusCode>102</statusCode> <description>FAIL</description> <errorDescription>Card type is required.</errorDescription> </Payment> </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: 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> <Payment> <statusCode>105</statusCode> <description>FAIL</description> <errorDescription>Expiry Month is required.</errorDescription> </Payment> </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> <Payment> <statusCode>107</statusCode> <description>FAIL</description> <errorDescription>Expiry Year is required.</errorDescription> </Payment> </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> <Payment> <statusCode>109</statusCode> <description>FAIL</description> <errorDescription>Credit Card Number is required.</errorDescription> </Payment> </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> <Payment> <statusCode>110</statusCode> <description>FAIL</description> <errorDescription>Card Name is required.</errorDescription> </Payment> </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> <Payment> <statusCode>111</statusCode> <description>FAIL</description> <errorDescription>Name on Card is invalid.</errorDescription> </Payment> </VcareOssApi>
Error Description: Name on Card is invalid.
How to Resolve?: Please provide a valid Name on Card.
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> <Payment> <statusCode>113</statusCode> <description>FAIL</description> <errorDescription>Zip Code is required.</errorDescription> </Payment> </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: 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> <Payment> <statusCode>116</statusCode> <description>FAIL</description> <errorDescription>City is required.</errorDescription> </Payment> </VcareOssApi>
Error Description: City is required.
How to Resolve?: City cannot be blank. You should enter a valid City.
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> <Payment> <statusCode>118</statusCode> <description>FAIL</description> <errorDescription>State is required.</errorDescription> </Payment> </VcareOssApi>
Error Description: State is required.
How to Resolve?: State cannot be blank. You should enter a valid State.
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> <Payment> <statusCode>120</statusCode> <description>FAIL</description> <errorDescription>Billing Address is required.</errorDescription> </Payment> </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: 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> <Payment> <statusCode>130</statusCode> <description>FAIL</description> <errorDescription>Invalid Company ID.</errorDescription> </Payment> </VcareOssApi>
Error Description: Invalid Company ID.
How to Resolve?: Please provide valid company id.
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> <Payment> <statusCode>168</statusCode> <description>FAIL</description> <errorDescription>Invalid Amount.</errorDescription> </Payment> </VcareOssApi>
Error Description: Invalid Amount.
How to Resolve?: Please provide a valid Amount.
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> <Payment> <statusCode>169</statusCode> <description>FAIL</description> <errorDescription>Company ID is required.</errorDescription> </Payment> </VcareOssApi>
Error Description: Company ID is required.
How to Resolve?: Please provide company ID.
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> <Payment> <statusCode>179</statusCode> <description>FAIL</description> <errorDescription>Amount should not be blank OR zero.</errorDescription> </Payment> </VcareOssApi>
Error Description: Amount should not be blank OR zero.
How to Resolve?: Please provide amount. Amount cannot be left blank OR zero.
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> <Payment> <statusCode>214</statusCode> <description>FAIL</description> <errorDescription>Action should not be blank.</errorDescription> </Payment> </VcareOssApi>
Error Description: Action should not be blank.
How to Resolve?: Please provide valid value as Action should not 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> <Payment> <statusCode>215</statusCode> <description>FAIL</description> <errorDescription>Invalid Card Details.</errorDescription> </Payment> </VcareOssApi>
Error Description: Invalid Card Details.
How to Resolve?: Please provide a valid Card Details.
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> <Payment> <statusCode>220</statusCode> <description>FAIL</description> <errorDescription>Card code is required.</errorDescription> </Payment> </VcareOssApi>
Error Description: Card code is required.
How to Resolve?: Please provide Card code.
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> <Payment> <statusCode>356</statusCode> <description>FAIL</description> <errorDescription>Agent ID cannot be blank.</errorDescription> </Payment> </VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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> <Payment> <statusCode>395</statusCode> <description>FAIL</description> <errorDescription>Invoice number should not be blank.</errorDescription> </Payment> </VcareOssApi>
Error Description: Invoice number should not be blank.
How to Resolve?: Please provide Invoice number as it cannot be blank.
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> <Payment> <statusCode>457</statusCode> <description>FAIL</description> <errorDescription>Invalid Source.</errorDescription> </Payment> </VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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> <Payment> <statusCode>533</statusCode> <description>FAIL</description> <errorDescription>Invalid invoice type ID.</errorDescription> </Payment> </VcareOssApi>
Error Description: Invalid invoice type ID.
How to Resolve?: Provide a valid invoice type ID.
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> <Payment> <statusCode>685</statusCode> <description>FAIL</description> <errorDescription>Transaction ID should not be empty.</errorDescription> </Payment> </VcareOssApi>
Error Description: Transaction ID should not be empty.
How to Resolve?: Provide a valid Transaction ID. Transaction ID should not be blank.
Sample Fail Response: 29
<?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> <Payment> <statusCode>686</statusCode> <description>FAIL</description> <errorDescription>Invoice type ID is required.</errorDescription> </Payment> </VcareOssApi>
Error Description: Invoice type ID is required.
How to Resolve?: Please provide a valid value as Invoice type ID is required.
Sample Fail Response: 30
<?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> <Payment> <statusCode>738</statusCode> <description>FAIL</description> <errorDescription>Customer ID OR Enrollment ID not found in our system.</errorDescription> </Payment> </VcareOssApi>
Error Description: Customer ID OR Enrollment ID not found in our system.
How to Resolve?: Customer ID OR Enrollment ID not found in our system.
All the status codes are listed under the status code sections. Please click here to go to the status code.