EcheckPayment

This API is used to charge the Echeck Payment and apply the 'topup', 'data', 'upgrade','paybill','changeplan' at the same time.

End Point https://www.vcareapi.com/vcareOssApi/EcheckPayment/
Field 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.
ACTION string NEW Required Should be NEW, REPROCESS
CUSTOMER ID string 123456 Required Auto generated customer account number. This is returned in GetCustomerInfo.
TOTALPAYMENT string 30 Conditional This is the amount that will be charged to the Echeck Payment.
  • if action Reprocess then totalpayment is not required
  • if action New then totalpayment is required
TRANSACTION ID string 316584 Conditional Transaction id is reference payment id.
  • if action Reprocess then transactionid is required
  • if action New then transactionid is not required
ACCOUNT TYPE string CHECKING Required This is the type of the account. CHECKING,SAVING,BUSINESS CHECKING
CHECK NUMBER Numeric 465879456 Optional This is the check number. only digits
NAME on ACCOUNT string John Doe Required This is the name on the credit/debit.  
ROUTING NUMBER String 113454356 Required This is the Routing number.
ACCOUNT NUMBER Numeric 125368 Required This is the account number. Only digits.
BANK NAME string Bank Name Required This is the name of the bank account to which the associated. Full Name of Bank.
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.
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE
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></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
	<ECHECKPAYMENT>
		<ACTION></ACTION>
		<CUSTOMERID></CUSTOMERID>
		<TOTALPAYMENT></TOTALPAYMENT>
		<TRANSACTIONID></TRANSACTIONID>
		<TYPEOFACCOUNT></TYPEOFACCOUNT>
		<CHECKNUMBER></CHECKNUMBER>
		<NAMEACCOUNT></NAMEACCOUNT>
		<ROUTINGNUMBER></ROUTINGNUMBER>
		<ACCOUNTNUMBER></ACCOUNTNUMBER>
		<BANKNAME></BANKNAME>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
	 </ECHECKPAYMENT>
</VCAREOSS>
</VCAREOSSAPI>
List of status code, description and resolution.
Status Code Description How to Resolve?
00 SUCCESS SUCCESS
01 Error Received from Carrier. Please try again with valid data.
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.
166 Total payment should not be blank. Please provide Total payment. Total payment cannot be left blank.
172 Invalid total payment. Please provide a valid total payment.
214 Action should not be blank. Please provide valid value as Action should not be blank.
226 Customer ID is required. Please provide Customer ID.
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.
630 Account number is required. Provide a valid Account number. Account number should not be blank.
631 Routing number is required. Provide a valid Routing number. Routing number should not be blank.
632 Type of account is required. Provide a valid Type of account. Type of account should not be blank.
633 Type of account is invalid. Please provide a valid Type of account. Given value is invalid for Type of account.
634 Name on account is required. Provide a valid Name on account. Name on account should not be blank.
635 Name of bank account is required. Provide a valid Name of bank account. Name of bank account should not be blank.
696 Account Number should be numeric. Only numeric value is allowed for Account Number.
697 Check Number should be numeric. Only numeric value is allowed for Check Number.
698 Action Should be New OR Reprocess. Provide correct Action. Action should be New or Reprocess.
699 Transaction ID is required. Transaction ID can not be blank. You should enter a valid Transaction ID.
700 Invalid Transaction ID. Please provide a valid Transaction ID. Given value is invalid for Transaction ID.
751 Custom message. This is dynamic message.
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>Vcarecorporation</vendorId>
        <referenceNumber>111111111</referenceNumber>
    </credentials>
    <EcheckPayment>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
		<transactionNumber>23432423</transactionNumber>
		<invoiceNumber>353543</invoiceNumber>
	</EcheckPayment>
</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>
<EcheckPayment>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Error Received from Carrier.
How to Resolve?: Please try again with valid data.
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>
<EcheckPayment>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Password is invalid.
How to Resolve?: Provide a valid Password.
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>
<EcheckPayment>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</EcheckPayment>
</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>
<EcheckPayment>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Customer ID is invalid.
How to Resolve?: Provide a valid Customer ID.
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>
<EcheckPayment>
	<statusCode>166</statusCode>
	<description>FAIL</description>
	<errorDescription>Total payment should not be blank.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Total payment should not be blank.
How to Resolve?: Please provide Total payment. Total payment cannot be left 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>
<EcheckPayment>
	<statusCode>172</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid total payment.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Invalid total payment.
How to Resolve?: Please provide a valid total payment.
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>
<EcheckPayment>
	<statusCode>214</statusCode>
	<description>FAIL</description>
	<errorDescription>Action should not be blank.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Action should not be blank.
How to Resolve?: Please provide valid value as Action should not be blank.
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>
<EcheckPayment>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Customer ID is required.
How to Resolve?: Please provide Customer ID.
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>
<EcheckPayment>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
<EcheckPayment>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<EcheckPayment>
	<statusCode>630</statusCode>
	<description>FAIL</description>
	<errorDescription>Account number is required.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Account number is required.
How to Resolve?: Provide a valid Account number. Account number should not be blank.
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>
<EcheckPayment>
	<statusCode>631</statusCode>
	<description>FAIL</description>
	<errorDescription>Routing number is required.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Routing number is required.
How to Resolve?: Provide a valid Routing number. Routing number should not be blank.
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>
<EcheckPayment>
	<statusCode>632</statusCode>
	<description>FAIL</description>
	<errorDescription>Type of account is required.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Type of account is required.
How to Resolve?: Provide a valid Type of account. Type of account should not be blank.
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>
<EcheckPayment>
	<statusCode>633</statusCode>
	<description>FAIL</description>
	<errorDescription>Type of account is invalid.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Type of account is invalid.
How to Resolve?: Please provide a valid Type of account. Given value is invalid for Type of account.
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>
<EcheckPayment>
	<statusCode>634</statusCode>
	<description>FAIL</description>
	<errorDescription>Name on account  is required.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Name on account is required.
How to Resolve?: Provide a valid Name on account. Name on account should not be 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>
<EcheckPayment>
	<statusCode>635</statusCode>
	<description>FAIL</description>
	<errorDescription>Name of bank account is required.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Name of bank account is required.
How to Resolve?: Provide a valid Name of bank account. Name of bank account should not be blank.
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>
<EcheckPayment>
	<statusCode>696</statusCode>
	<description>FAIL</description>
	<errorDescription>Account Number should be numeric.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Account Number should be numeric.
How to Resolve?: Only numeric value is allowed for Account Number.
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>
<EcheckPayment>
	<statusCode>697</statusCode>
	<description>FAIL</description>
	<errorDescription>Check Number should be numeric.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Check Number should be numeric.
How to Resolve?: Only numeric value is allowed for Check Number.
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>
<EcheckPayment>
	<statusCode>698</statusCode>
	<description>FAIL</description>
	<errorDescription>Action Should be New OR Reprocess.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Action Should be New OR Reprocess.
How to Resolve?: Provide correct Action. Action should be New or Reprocess.
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>
<EcheckPayment>
	<statusCode>699</statusCode>
	<description>FAIL</description>
	<errorDescription>Transaction ID is required.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Transaction ID is required.
How to Resolve?: Transaction ID can not be blank. You should enter a valid Transaction ID.
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>
<EcheckPayment>
	<statusCode>700</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Transaction ID.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Invalid Transaction ID.
How to Resolve?: Please provide a valid Transaction ID. Given value is invalid for Transaction ID.
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>
<EcheckPayment>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</EcheckPayment>
</VcareOssApi>
Error Description: Custom message.
How to Resolve?: This is dynamic message.

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