ApplyCredit

This XML API is used to apply credit.

End Point https://www.vcareapi.com/vcareOssApi/ApplyCredit/
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 string 123456 Required Auto generated customer account number. This is returned in GetCustomerInfo  
INVOICE CATEGORY string Bill-Pay Required This is the invoice category which you want to add on the account for applying the credit The list of different INVOICECATEGORY can be obtained using InvoicePaymentType API.
INVOICETRANSACTIONTYPE string Credit Adj Required This is the type of transaction for which you are creating the invoice and adding credit The list of different INVOICETRANSACTIPTYPE can be obtained using InvoicePaymentType API.
TRANSACTION YEAR string 2017 Required This is the year of the transaction YYYY
TRANSACTION MONTH string 09 Required This is the month of the transaction MM
TRANSACTION DAY string 04 Required This is the day of the transaction DD
AMOUNT string 20 Required This is the amount that is paid by the customer
TAXAMOUNT string 1 Optional This is the tax amount if you want to generate a credit for tax as well
PROCESSINGFEE string 2 Optional This is the credit of the processing fee.
PROCESSINGFEETAX string 0.2 Optional This is the credit of the processing fee tax.
TOTAL AMOUNT string 30 Required This is the total amount for which the credit will be applied and credit invoice will be generated on the account
TRANSDESCRIPTION string Credit applied for the inconveinence Optional These are the additional notes which you can leave while creating the credit
REFERANCEID string VOBAD456 Optional If the credit needs to be applied for the payment which has been taken on the account then you need to mention the reference id for that payment.
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE
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.
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>Vcarecorporation</VENDORID>
<USERNAME>Vcarecorporation</USERNAME>
<PASSWORD>Vcarecorporation</PASSWORD>
<PIN>Vcarecorporation</PIN>
<REFERENCENUMBER>11111</REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
    <APPLYCREDIT>
   <CUSTOMERID>3265412</CUSTOMERID>
   <INVOICECATEGORY>Bill-Pay</INVOICECATEGORY>
   <INVOICETRANSACTIONTYPE>Credit Adj</INVOICETRANSACTIONTYPE>
   <TRANSACTIONDATE>
	   <YEAR></YEAR>
	   <MONTH></MONTH>
	   <DAY></DAY>
	</TRANSACTIONDATE>
   <AMOUNT>20.00</AMOUNT>
   <TAXAMOUNT>1.00</TAXAMOUNT>
   <PROCESSINGFEE>00.00</PROCESSINGFEE>
   <PROCESSINGFEETAX>00.00</PROCESSINGFEETAX>
   <TOTALAMOUNT>21.00</TOTALAMOUNT>
   <TRANSDESCRIPTION>Adjustment</TRANSDESCRIPTION>
   <REFERANCEID>VOBAD456</REFERANCEID>
   <AGENTID>Zeeshan Ahmed</AGENTID>
   <AGENTPASSWORD></AGENTPASSWORD>
   <SOURCE>API</SOURCE>
  </APPLYCREDIT>
</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.
25 Customer ID is invalid. Provide a valid Customer ID.
127 Invalid Data Amount. Please provide a valid Data Amount.
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.
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>
  <ApplyCredit>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <INVOICENUMBER>34624357</INVOICENUMBER>
    </ApplyCredit>
</VcareOssApi>
</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>
<ApplyCredit>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ApplyCredit>
</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>
<ApplyCredit>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ApplyCredit>
</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>
<ApplyCredit>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</ApplyCredit>
</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>
<ApplyCredit>
	<statusCode>127</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Data Amount.</errorDescription>
</ApplyCredit>
</VcareOssApi>
Error Description: Invalid Data Amount.
How to Resolve?: Please provide a valid Data Amount.
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>
<ApplyCredit>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</ApplyCredit>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
<ApplyCredit>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</ApplyCredit>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

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