Credit Card
Sandbox end point URL: https://gateway2-stg.tcbpay.com/apis/{method}
Example: https://gateway2-stg.tcbpay.com/apis/sale.php
Production end point URL: https://gateway2.tcbpay.com/apis/{method}
Sale API
This API is responsible to create a new payment transaction. API is compatible of both encrypted and plain credit card method of transactions.
URL To Call: https://gateway2.tcbpay.com/apis/sale.php
Method of Form Submission: POST
proxynization library:
- Sandbox:
https://gateway2-stg.tcbpay.com/services/proxynization_api.js
- Production:
https://gateway2.tcbpay.com/services/proxynization_api.js
Example:
<script type="text/javascript" src="https://[server-name]/services/proxynization_api.js"></script>
Example:
<script type="text/javascript" >
function tcbpayClientCallback(responseCode, responseMessage, proxyNumber){
if(responseCode == "A01"){
document.getElementById('creditcard_number').value = proxyNumber;
document.getElementById("formID").submit();
} else{
alert(responseMessage);
return false;
}
}
</script>
- 3)Design your payment form and insert a proxynization call within the form's submit action.
- 3.1)The first parameter can either be the value of credit card number, or it can be the ID of the credit card number field. If the value of the parameter starts with a hashtag (#) symbol, the first parameter is assumed to be the ID of the credit card number field. If a hashtag is not present, the first parameter is assumed to be a credit card number.
- 3.2)The second parameter is the name of the callback function, that will be called when the proxynization call is completed.
Example:
<input type="button" value="submit" onClick="TCBPayProxynizationAPI.process('#creditcard_number','tcbpayClientCallback');" />
The table describes the request parameters for Sale API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
card_token | Get token during Add Card vault API. If you use card token then credit card number, expiry month and expiry year are not required. | C | XXXXXXXXXXXXXXXXXXXXXXXXX |
creditcard_number | Credit Card Number upon which Sales to be done. It is not required, if use card token number. | C | 4111111111111111 |
expire_month | Expiry Month of the Credit Card. It is not required, if use card token number. | C | 06 |
expire_year | Expiry Year of the Credit Card. It is not required, if use card token number. | C | 2025 |
cvv | CVV of the Credit Card. To force CVV as required for every transaction in the account setting then cvv is required otherwise it is optional. |
C | 123 |
use_secret_key | To encrypt creditcard_number without using proxynization_api.js then set secret key in account setting. Make sure to encrypt credit card numbers with AES 128 bit ECB cipher code. | N | Y or N (default value N) Y- encrypt creditcard_number using AES 128 bit ECB cipher mode encryption |
amount | Amount to be charged | Y | 133.24 |
currency | Currency of Transaction (Allowed currencies will be determined during the time of merchant registration.) | Y | USD,EUR,GBP,CAD,AUD,NZD,AED, DKK,MXN,SEK,CHF |
company_name | Company Name of the customer | N | - |
first_name | First name of Account Holder | Y | Roberto |
last_name | Last name of Account Holder | Y | Diaz |
adress | Address of the customer | N | 4446 Green Avenue, Suite 56 |
city | City of the customer | N | Los Angeles |
state | State of the customer | N | CA |
country_code | Country of the customer(ISO alpha-2) | Y | US, CN |
zip_code | Zipcode of the customer | Y | 94085 |
phone_number | Phone Number of the customer | N | 408-345-2323 |
Email ID of the customer | Y | test@test.com | |
email_receipt | Send transaction details to specified card holder email | N | Y or N (default value N) Y- Send email N- Not send |
emailReceiptDBAEmail | Email Receipt To Merchant DBA Contact Email | N | Y or N (default value N) Y- Send email N- Not send |
memo | Memo of transaction | N | |
client_ip | Client ip address | N | 127.0.0.1 |
custom_field_1 | N | additional parameter 1 | |
custom_filed_2 | N | additional parameter 2 | |
source | C | source=SHOPIFY if using Shopify otherwise it is not required | |
3ds_redirect_url | Redirect to this url after 3D-Secure authentication. (To process transactions with 3Ds, contact TCB Pay to enable 3DS and set 'Denied Payment Transaction' or 'Continue Payment Transaction' for non 3-D Secure card transactions.) |
C | if using 3D-Secure then it is require otherwise it is not required. |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and transaction_id. Response code is always 00 for successful API call.
Example:
<form name="" id="formID" action="https://gateway2.tcbpay.com/apis/sale.php" method="post">
<input type="text" name="username" value="tcbpayusername"/>
<input type="text" name="api_key" value="tcbpayapikey"/>
<input type="text" name="creditcard_number" id="creditcard_number" value="4111111111111111"/>
<input type="text" name="expire_month" value="06"/>
<input type="text" name="expire_year" value="2025"/>
<input type="text" name="cvv" value="123"/>
<input type="text" name="amount" value="14.5"/>
<input type="text" name="currency" value="USD"/>
<input type="text" name="company_name" value="TCB Pay"/>
<input type="text" name="first_name" value="Roberto"/>
<input type="text" name="last_name" value="Diaz"/>
<input type="text" name="address" value="4446 Green Avenue, Suite 56"/>
<input type="text" name="city" value="Los Angeles"/>
<input type="text" name="state" value="CA"/>
<input type="text" name="country_code" value="US"/>
<input type="text" name="zip_code" value="11111"/>
<input type="text" name="phone_number" value="323-323-3223"/>
<input type="text" name="client_ip" value="127.0.0.1"/>
<input type="text" name="email" value="abcdef@mail.com"/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="button" value="submit" onClick="TCBPayProxynizationAPI.process('#creditcard_number','tcbpayClientCallback');" />
</form>
<script type="text/javascript" >
function tcbpayClientCallback(responseCode, responseMessage, proxyNumber){
if(responseCode == "A01"){
document.getElementById('creditcard_number').value = proxyNumber;
document.getElementById("formID").submit();
} else{
alert(responseMessage);
return false;
}
}
</script>
Sample Response :
{"response":{"code":"00","description":" Transaction Entry Success","transaction_id":102," total_amount":15.7," convenience_fee":1.2}}
Sample Response for 3D-Secure :
{"response":{"code":"00","description":"Transaction pending cardholder authentication","transaction_id":102,"redirect_url":"https://gateway2.tcbpay.com/challenge_request.php?uid=xxxxxxxxx"}}
Subscriber need to redirect to redirect_url within 30 seconds.
After 3DS challenge API response is redirected to 3ds_redirect_url, parameters are transaction_id, code and description.
Authorize API:
This API is responsible to perform pre-authorization payment. Note: API is compatible of both encrypted and plain credit card method of transactions.
URL To Call: https://gateway2.tcbpay.com/apis/ authorize.php
Method of Form Submission: POST
proxynization library:
- Sandbox:
https://gateway2-stg.tcbpay.com/services/proxynization_api.js
- Production:
https://gateway2.tcbpay.com/services/proxynization_api.js
Example:
<script type="text/javascript" src="https://[server-name]/services/proxynization_api.js"></script>
Example:
function tcbpayClientCallback(responseCode, responseMessage, proxyNumber){
if(responseCode == "A01"){
document.getElementById('creditcard_number').value = proxyNumber;
document.getElementById("formID").submit();
} else{
alert(responseMessage);
return false;
}
}
</script>
- 3)Design your payment form and insert a proxynization call within the form's submit action.
- 3.1)The first parameter can either be the value of credit card number, or it can be the ID of the credit card number field. If the value of the parameter starts with a hashtag (#) symbol, the first parameter is assumed to be the ID of the credit card number field. If a hashtag is not present, the first parameter is assumed to be a credit card number.
- 3.2)The second parameter is the name of the callback function, that will be called when the proxynization call is completed.
Example:
<input type="button" value="submit" onClick="TCBPayProxynizationAPI.process('#creditcard_number','tcbpayClientCallback');" />
The table describes the request parameters for Authorize API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
card_token | Get token during Add Card vault API. If you use card token then not required credit card number, expiry month and expiry year. | C | XXXXXXXXXXXXXXXXXXXXXXXXX |
creditcard_number | Credit Card Number upon which Sales to be done. It is not required, if use card token number. | C | 4111111111111111 |
expire_month | Expiry Month of the Credit Card. It is not required, if use card token number. | C | 06 |
expire_year | Expiry Year of the Credit Card. It is not required, if use card token number. | C | 2025 |
cvv | CVV of the Credit Card | Y | 123 |
amount | Amount to be charged | Y | 133.24 |
currency | Currency of Transaction (Allowed currencies will be determined during the time of merchant registration.) | Y | USD,EUR,GBP,CAD,AUD,NZD,AED,DKK,MXN,SEK,CHF |
company_name | Company Name of the customer | N | - |
first_name | First name of Account Holder | Y | Roberto |
last_name | Last name of Account Holder | Y | Diaz |
adress | Address of the customer | N | 4446 Green Avenue, Suite 56 |
city | City of the customer | N | Los Angeles |
state | State of the customer | N | CA |
country_code | Country of the customer(ISO alpha-2) | Y | US, CN |
zip_code | Zipcode of the customer | Y | 94085 |
phone_number | Phone Number of the customer | N | 408-345-2323 |
Email ID of the customer | Y | test@test.com | |
email_receipt | Send transaction details to specified card holder email | N | Y or N (default value N) Y- Send email N- Not send |
emailReceiptDBAEmail | Email Receipt To Merchant DBA Contact Email | N | Y or N (default value N) Y- Send email N- Not send |
memo | Memo of transaction | N | |
client_ip | Client ip address | N | 127.0.0.1 |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and transaction_id. Response code is always 00 for successful API call.
Example:
<form name="" id="formID" action="https://gateway2.tcbpay.com/apis/authorize.php" method="post">
<input type="text" name="username" value="tcbpayusername"/>
<input type="text" name="api_key" value="tcbpayapikey"/>
<input type="text" name="creditcard_number" id="creditcard_number" value="4111111111111111"/>
<input type="text" name="expire_month" value="06"/>
<input type="text" name="expire_year" value="2025"/>
<input type="text" name="cvv" value="123"/>
<input type="text" name="amount" value="14.5"/>
<input type="text" name="currency" value="USD"/>
<input type="text" name="company_name" value="TCB Pay"/>
<input type="text" name="first_name" value="Roberto"/>
<input type="text" name="last_name" value="Diaz"/>
<input type="text" name="address" value="4446 Green Avenue, Suite 56"/>
<input type="text" name="city" value="Los Angeles"/>
<input type="text" name="state" value="CA"/>
<input type="text" name="country_code" value="US"/>
<input type="text" name="zip_code" value="11111"/>
<input type="text" name="phone_number" value="323-323-3223"/>
<input type="text" name="email" value="abcdef@mail.com"/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="button" value="submit" onClick="TCBPayProxynizationAPI.process('#creditcard_number','tcbpayClientCallback');" />
</form>
<script type="text/javascript" >
function tcbpayClientCallback(responseCode, responseMessage, proxyNumber){
if(responseCode == "A01"){
document.getElementById('creditcard_number').value = proxyNumber;
document.getElementById("formID").submit();
} else{
alert(responseMessage);
return false;
}
}
</script>
Sample Response :
{"response":{"code":"01","description":" Merchant Information is Missing"}}
Capture API:
This API is responsible to capture an existing authorization transaction.
URL To Call: https://gateway2.tcbpay.com/apis/ capture.php
Method of Form Submission: POST
The table describes the request parameters for Capture API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
transaction_id | Unique transaction id generate by gateway | Y | - |
amount | Amount to be charged, <= orginal transaction amount | Y | 133.24 |
email_receipt | Send transaction details to specified email during authorize | N | Y or N (default value N) Y- Send email N- Not send |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and transaction_id. Response code is always 00 for successful API call.
Example:
<form name="" action="https://gateway2.tcbpay.com/apis/capture.php" method="post">
<input type="text" name="username" value=" tcbpayusername"/>
<input type="text" name="api_key" value=" tcbpayapikey"/>
<input type="text" name="transaction_id" value=""/>
<input type="text" name="amount" value="14.5"/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="submit" value="submit"/>
</form>
Sample Response :
{"response":{"code":"01","description":" Merchant Information is Missing"}}
Void API:
This API is responsible to cancel an existing transaction.
URL To Call: https://gateway2.tcbpay.com/apis/ void.php
Method of Form Submission : POST
The table describes the request parameters for Void API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
transaction_id | Unique transaction id generate by gateway | Y | - |
email_receipt | Send transaction details to specified email during authorize | N | Y or N (default value N) Y- Send email N- Not send |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and transaction_id. Response code is always 00 for successful API call.
Example:
<form name="" action="https://gateway2.tcbpay.com/apis/void.php" method="post">
<input type="text" name="username" value=" tcbpayusername"/>
<input type="text" name="api_key" value=" tcbpayapikey"/>
<input type="text" name="transaction_id" value=""/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="submit" value="submit"/>
</form>
Sample Response :
{"response":{"code":"01","description":" Merchant Information is Missing"}}
Refund API:
This API is responsible to refund an existing successful transaction.
URL To Call: https://gateway2.tcbpay.com/apis/ refund.php
Method of Form Submission : POST
The table describes the request parameters for Refund API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
transaction_id | Unique transaction id generate by gateway | Y | - |
amount | Amount to be charged, <= orginal transaction amount | Y | 133.24 |
email_receipt | Send transaction details to specified email during authorize | N | Y or N (default value N) Y- Send email N- Not send |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and transaction_id. Response code is always 00 for successful API call.
Example :
<form name="" action="https://gateway2.tcbpay.com/apis/refund.php" method="post">
<input type="text" name="username" value=" tcbpayusername"/>
<input type="text" name="api_key" value=" tcbpayapikey"/>
<input type="text" name="transaction_id" value=""/>
<input type="text" name="amount" value="14.5"/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="submit" value="submit"/>
</form>
Sample Response :
{"response":{"code":"01","description":" Merchant Information is Missing"}}
Unreference Refund API
This API is responsible to create a new payment transaction. API is compatible of both encrypted and plain credit card method of transactions.
URL To Call: https://gateway2.tcbpay.com/apis/unreference_refund.php
Method of Form Submission: POST
proxynization library:
- Sandbox:
https://gateway2-stg.tcbpay.com/services/proxynization_api.js
- Production:
https://gateway2.tcbpay.com/services/proxynization_api.js
Example:
<script type="text/javascript" src="https://[server-name]/services/proxynization_api.js"></script>
Example:
<script type="text/javascript" >
function tcbpayClientCallback(responseCode, responseMessage, proxyNumber){
if(responseCode == "A01"){
document.getElementById('creditcard_number').value = proxyNumber;
document.getElementById("formID").submit();
} else{
alert(responseMessage);
return false;
}
}
</script>
- 3)Design your payment form and insert a proxynization call within the form's submit action.
- 3.1)The first parameter can either be the value of credit card number, or it can be the ID of the credit card number field. If the value of the parameter starts with a hashtag (#) symbol, the first parameter is assumed to be the ID of the credit card number field. If a hashtag is not present, the first parameter is assumed to be a credit card number.
- 3.2)The second parameter is the name of the callback function, that will be called when the proxynization call is completed.
Example:
<input type="button" value="submit" onClick="TCBPayProxynizationAPI.process('#creditcard_number','tcbpayClientCallback');" />
The table describes the request parameters for Unreference Refund API
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
creditcard_number | Credit Card Number upon which Unreference Refund to be done. It is not required, if use card token number. | C | 4111111111111111 |
expire_month | Expiry Month of the Credit Card. It is not required, if use card token number. | C | 06 |
expire_year | Expiry Year of the Credit Card. It is not required, if use card token number. | C | 2025 |
use_secret_key | To encrypt creditcard_number without using proxynization_api.js then set secret key in account setting. Make sure to encrypt credit card numbers with AES 128 bit ECB cipher code. | N | Y or N (default value N) Y- encrypt creditcard_number using AES 128 bit ECB cipher mode encryption |
amount | Amount to be charged | Y | 133.24 |
currency | Currency of Transaction (Allowed currencies will be determined during the time of merchant registration.) | Y | USD,EUR,GBP,CAD,AUD,NZD,AED, DKK,MXN,SEK,CHF |
company_name | Company Name of the customer | N | - |
first_name | First name of Account Holder | Y | Roberto |
last_name | Last name of Account Holder | Y | Diaz |
adress | Address of the customer | N | 4446 Green Avenue, Suite 56 |
city | City of the customer | N | Los Angeles |
state | State of the customer | N | CA |
country_code | Country of the customer(ISO alpha-2) | Y | US, CN |
zip_code | Zipcode of the customer | Y | 94085 |
phone_number | Phone Number of the customer | N | 408-345-2323 |
Email ID of the customer | Y | test@test.com | |
email_receipt | Send transaction details to specified card holder email | N | Y or N (default value N) Y- Send email N- Not send |
emailReceiptDBAEmail | Email Receipt To Merchant DBA Contact Email | N | Y or N (default value N) Y- Send email N- Not send |
client_ip | Client ip address | N | 127.0.0.1 |
custom_field_1 | N | additional parameter 1 | |
custom_filed_2 | N | additional parameter 2 |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and transaction_id. Response code is always 00 for successful API call.
Example:
<form name="" id="formID" action="https://gateway2.tcbpay.com/apis/unreference_refund.php" method="post">
<input type="text" name="username" value="tcbpayusername"/>
<input type="text" name="api_key" value="tcbpayapikey"/>
<input type="text" name="creditcard_number" id="creditcard_number" value="4111111111111111"/>
<input type="text" name="expire_month" value="06"/>
<input type="text" name="expire_year" value="2025"/>
<input type="text" name="amount" value="4.5"/>
<input type="text" name="currency" value="USD"/>
<input type="text" name="company_name" value="TCB Pay"/>
<input type="text" name="first_name" value="Roberto"/>
<input type="text" name="last_name" value="Diaz"/>
<input type="text" name="address" value="4446 Green Avenue, Suite 56"/>
<input type="text" name="city" value="Los Angeles"/>
<input type="text" name="state" value="CA"/>
<input type="text" name="country_code" value="US"/>
<input type="text" name="zip_code" value="11111"/>
<input type="text" name="phone_number" value="323-323-3223"/>
<input type="text" name="client_ip" value="127.0.0.1"/>
<input type="text" name="email" value="abcdef@mail.com"/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="button" value="submit" onClick="TCBPayProxynizationAPI.process('#creditcard_number','tcbpayClientCallback');" />
</form>
<script type="text/javascript" >
function tcbpayClientCallback(responseCode, responseMessage, proxyNumber){
if(responseCode == "A01"){
document.getElementById('creditcard_number').value = proxyNumber;
document.getElementById("formID").submit();
} else{
alert(responseMessage);
return false;
}
}
</script>
Sample Response :
{"response":{"code":"00", "transaction_id":102, "amount":4.5, "description":" Your transaction is approved."}}
Report API:
This API is responsible to generate transaction reports.
URL To Call: https://gateway2.tcbpay.com/apis/report.php
Method of Form Submission : POST
The table describes the request parameters for Report API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
start_date | From transaction date | Y | date format YYYY-MM-DD |
end_date | To transaction date | Y | date format YYYY-MM-DD |
transaction_type | Type of transaction | N | (default all transaction) SALE,AUTHORIZE,CAPTURE,REFUND,VOID,CREDIT |
transaction_status | Status of transaction | N | (default all transaction) SUCCESS,FAIL |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and array of transactions. Response code is always 00 for successful API call.
Example :
<form name="" action="https://gateway2.tcbpay.com/apis/report.php" method="post">
<input type="text" name="username" value="tcbpayusername"/>
<input type="text" name="api_key" value="tcbpayapikey"/>
<input type="text" name="start_date" value="2021-01-15"/>
<input type="text" name="end_date" value="2021-03-15"/>
<br/>
<input type="submit" value="submit"/>
</form>
Sample Response :
{ "response": { "code": "00", "description": "success", "transactions": [ { "transaction_id": "****************", "parent_transaction_id": "", "transaction_type": "SALE", "transaction_status": "SUCCESS", "transaction_time": "2021-03-12 01:45:20", "time_zone": "---------", "gmt_time": "2021-03-16 06:22:00", "credit_card_number": "************0013", "currency": "USD", "total_amount": "14.5", "amount": "14.5", "surcharge": "0", "tax": "0", "tip": "0", "first_name": "", "last_name": "", "company_name": "", "address_1": "", "address_2": "", "city": "", "state": "", "zip_code": "", "email": "test@test.com", "phone_no": "", "is_risk_hold": "YES", "risk_description": "High Average Ticket vs Contract, Increased Credit Ratio - 90-Day AVG Returns" } ] } }
Response Codes:
Code | Description |
---|---|
01 | username is missing or invalid |
02 | Credit card is missing or invalid |
03 | Expiration Date is missing or invalid |
04 | First/Last Name is missing |
05 | Invalid Country Code |
06 | Proper Customer Email Id is missing |
07 | Invalid Amount |
08 | Transaction Currency is Missing |
09 | api_key is missing or invalid |
10 | Requested Currency is not allowed for this Merchant |
11 | Couldn't process transaction due to load balancer rules!! |
12 | Transaction ID is missing or invalid |
13 | Refund is not possible,Its already Void |
14 | Refund is not possible,Its already exceeds Actual Amount |
15 | Capture is not possible |
16 | Void is not possible |
17 | Sale Limit exceeded |
18 | Monthly Limit exceeded |
19 | Transaction Limit exceeded |
20 | IP/Transaction Limit exceeded |
21 | Slang word not allowed |
22 | IP Address is missing/invalid |
A1 | Transaction Entry Failure |
A2 | Transaction Update Failure |
UN | Unknown error, Please contact to administrator |
F | Your transaction is declined |
00 | Transaction Entry Success |
Sandbox:
Sandbox end point URL: https://gateway2-stg.tcbpay.com/apis/{method}
Example: https://gateway2-stg.tcbpay.com/apis/sale.php
Test Credit Card's Details:
Card Number | Type of use | CVV |
---|---|---|
4005510000000013 | Regular | 123 |
4111111111111111 | Regular | 111 |
4012001037141112 | Regular | 083 |
5111111111111111 | Regular | 123 |
4761739000091011 (success OTP: 0101 , fail OTP: 3333) | 3DS | 123 |
5204730000001011 (success OTP: 4445 , fail OTP: 9999) | 3DS | 123 |
Vault
Sandbox end point URL: https://gateway2-stg.tcbpay.com/apis/{method}
Example: https://gateway2-stg.tcbpay.com/apis/sale.php
Production end point URL: https://gateway2.tcbpay.com/apis/{method}
Add Card API
This API is responsible to store Card information inside TCB Pay Vault
URL To Call: https://gateway2.tcbpay.com/apis/add-card-vault.php
Method of Form Submission: POST
proxynization library:
- Sandbox:
https://gateway2-stg.tcbpay.com/services/proxynization_api.js
- Production:
https://gateway2.tcbpay.com/services/proxynization_api.js
Example:
<script type="text/javascript" src="https://[server-name]/services/proxynization_api.js"></script>
Example:
<script type="text/javascript" >
function tcbpayClientCallback(responseCode, responseMessage, proxyNumber){
if(responseCode == "A01"){
document.getElementById('creditcard_number').value = proxyNumber;
document.getElementById("formID").submit();
} else{
alert(responseMessage);
return false;
}
}
</script>
- 3)Design your payment form and insert a proxynization call within the form's submit action.
- 3.1)The first parameter can either be the value of credit card number, or it can be the ID of the credit card number field. If the value of the parameter starts with a hashtag (#) symbol, the first parameter is assumed to be the ID of the credit card number field. If a hashtag is not present, the first parameter is assumed to be a credit card number.
- 3.2)The second parameter is the name of the callback function, that will be called when the proxynization call is completed.
Example:
<input type="button" value="submit" onClick="TCBPayProxynizationAPI.process('#creditcard_number','tcbpayClientCallback');" />
The table describes the request parameters for Add Card API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
creditcard_number | Credit Card Number | Y | 4111111111111111 |
expiry_month | Expiry Month of the Credit Card | Y | 06 |
expiry_year | Expiry Year of the Credit Card | Y | 2025 |
card_holder_name | Card holder name of the Credit Card | Y | Roberto Diaz |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and token. Response code is always 00 for successful API call.
Example:
<form name="" id="formID" action="https://gateway2.tcbpay.com/apis/add-card-vault.php" method="post">
<input type="text" name="username" value=" tcbpayusername"/>
<input type="text" name="api_key" value=" tcbpayapikey"/>
<input type="text" name="creditcard_number" id="creditcard_number" value="4111111111111111"/>
<input type="text" name="expiry_month" value="06"/>
<input type="text" name="expiry_year" value="2025"/>
<input type="text" name="card_holder_name" value="Roberto Diaz"/>
<br/>
<input type="button" value="submit" onClick="TCBPayProxynizationAPI.process('#creditcard_number','tcbpayClientCallback');" />
</form>
<script type="text/javascript" >
function tcbpayClientCallback(responseCode, responseMessage, proxyNumber){
if(responseCode == "A01"){
document.getElementById('creditcard_number').value = proxyNumber;
document.getElementById("formID").submit();
} else{
alert(responseMessage);
return false;
}
}
</script>
Sample Response :
{"response":{"code":"00","description":"Card is successfully added to vault","token":XXXXXXXXXXXXXXXXXXXXXXXXX}}
Card Details API:
This API is responsible to retrieve card details from Vault.
URL To Call: https://gateway2.tcbpay.com/apis/ get-card-details.php
Method of Form Submission: POST
The table describes the request parameters for Card Details API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
token | Unique token number, get it during creating new card vault | Y | XXXXXXXXXXXXXXXXXXXXXXXXX |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and details. Response code is always 00 for successful API call.
Example:
<form name="" id="formID" action="https://gateway2.tcbpay.com/apis/get-card-details.php" method="post">
<input type="text" name="username" value=" tcbpayusername"/>
<input type="text" name="api_key" value=" tcbpayapikey"/>
<input type="text" name="token" value="XXXXXXXXXXXXXXXXXXXXXXXXX"/>
<br/>
<input type="submit" value="submit"/>
</form>
Sample Response :
{ "response": { "code": "00", "description": "success", "details": { "token": "XXXXXXXXXXXXXXXXXXXXXXXXX", "card_holder_name": "Test card holder name", "creditcard_number": "400551******0013", "expiry_month": "06", "expiry_year": "2025" } } }
Delete Card API:
This API is responsible to delete secure card details from Vault.
URL To Call: https://gateway2.tcbpay.com/apis/ delete-card-vault.php
Method of Form Submission : POST
The table describes the request parameters for Delete Card API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
token | Unique token number, get it during creating new card vault | Y | XXXXXXXXXXXXXXXXXXXXXXXXX |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and token. Response code is always 00 for successful API call.
Example:
<form name="" action="https://gateway2.tcbpay.com/apis/delete-card-vault.php" method="post">
<input type="text" name="username" value=" tcbpayusername"/>
<input type="text" name="api_key" value=" tcbpayapikey"/>
<input type="text" name="token" value=""/>
<br/>
<input type="submit" value="submit"/>
</form>
Sample Response :
{"response":{"code":"00","description":"Card Vault is successfully deleted","token":"XXXXXXXXXXXXXXXXXXXXXXXXX"}}
Sale API
This API is responsible to create a new payment transaction.
URL To Call: https://gateway2.tcbpay.com/apis/sale.php
Method of Form Submission: POST
The table describes the request parameters for Sale API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
card_token | Get token during Add Card vault API. | Y | XXXXXXXXXXXXXXXXXXXXXXXXX |
cvv | CVV of the Credit Card | Y | 123 |
amount | Amount to be charged | Y | 133.24 |
currency | Currency of Transaction (Allowed currencies will be determined during the time of merchant registration.) | Y | USD,EUR,GBP,CAD,AUD,NZD, AED,DKK,MXN,SEK,CHF |
company_name | Company Name of the customer | N | - |
first_name | First name of Account Holder | Y | Roberto |
last_name | Last name of Account Holder | Y | Diaz |
adress | Address of the customer | N | 4446 Green Avenue, Suite 56 |
city | City of the customer | N | Los Angeles |
state | State of the customer | N | CA |
country_code | Country of the customer(ISO alpha-2) | Y | US, CN |
zip_code | Zipcode of the customer | Y | 94085 |
phone_number | Phone Number of the customer | N | 408-345-2323 |
Email ID of the customer | Y | test@test.com | |
email_receipt | Send transaction details to specified email | N | Y or N (default value N) Y- Send email N- Not send |
client_ip | Client ip address | N | 127.0.0.1 |
custom_field_1 | N | additional parameter 1 | |
custom_filed_2 | N | additional parameter 2 | |
source | C | source=SHOPIFY if using Shopify otherwise it is not required |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and transaction_id, total_amount, convenience_fee. Response code is always 00 for successful API call.
Example:
<form name="" id="formID" action="https://gateway2.tcbpay.com/apis/sale.php" method="post">
<input type="text" name="username" value=" tcbpayusername"/>
<input type="text" name="api_key" value=" tcbpayapikey"/>
<input type="text" name="card_token" id="card_token" value="XXXXXXXXXXXXXXXXXXXXXXXXX"/>
<input type="text" name="cvv" value="123"/>
<input type="text" name="amount" value="14.5"/>
<input type="text" name="currency" value="USD"/>
<input type="text" name="company_name" value="TCB Pay"/>
<input type="text" name="first_name" value="Roberto"/>
<input type="text" name="last_name" value="Diaz"/>
<input type="text" name="address" value="4446 Green Avenue, Suite 56"/>
<input type="text" name="city" value="Los Angeles"/>
<input type="text" name="state" value="CA"/>
<input type="text" name="country_code" value="US"/>
<input type="text" name="zip_code" value="11111"/>
<input type="text" name="phone_number" value="323-323-3223"/>
<input type="text" name="client_ip" value="127.0.0.1"/>
<input type="text" name="email" value="abcdef@mail.com"/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="button" value="submit" />
</form>
Sample Response :
{"response":{"code":"00","description":" Transaction Entry Success","transaction_id":102," total_amount":15.7," convenience_fee":1.2}}
Authorize API:
This API is responsible to perform pre-authorization payment
URL To Call: https://gateway2.tcbpay.com/apis/ authorize.php
Method of Form Submission: POST
The table describes the request parameters for Authorize API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
card_token | Get token during Add Card vault API. | C | XXXXXXXXXXXXXXXXXXXXXXXXX |
cvv | CVV of the Credit Card | Y | 123 |
amount | Amount to be charged | Y | 133.24 |
currency | Currency of Transaction (Allowed currencies will be determined during the time of merchant registration.) | Y | USD,EUR,GBP,CAD,AUD,NZD, AED,DKK,MXN,SEK,CHF |
company_name | Company Name of the customer | N | - |
first_name | First name of Account Holder | Y | Roberto |
last_name | Last name of Account Holder | Y | Diaz |
adress | Address of the customer | N | 4446 Green Avenue, Suite 56 |
city | City of the customer | N | Los Angeles |
state | State of the customer | N | CA |
country_code | Country of the customer(ISO alpha-2) | Y | US, CN |
zip_code | Zipcode of the customer | Y | 94085 |
phone_number | Phone Number of the customer | N | 408-345-2323 |
Email ID of the customer | Y | test@test.com | |
e-mail receipt | Send transaction details to specified email | N | Y or N (default value N) Y- Send email N- Not send |
client_ip | Client ip address | N | 127.0.0.1 |
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and description.For Successful transactions, three elements are returned. They are code, description and transaction_id. Response code is always 00 for successful API call.
Example:
<form name="" id="formID" action="https://gateway2.tcbpay.com/apis/authorize.php" method="post">
<input type="text" name="username" value=" tcbpayusername"/>
<input type="text" name="api_key" value=" tcbpayapikey"/>
<input type="text" name="card_token" id="card_token" value="XXXXXXXXXXXXXXXXXXXXXXXXX"/>
<input type="text" name="cvv" value="123"/>
<input type="text" name="amount" value="14.5"/>
<input type="text" name="currency" value="USD"/>
<input type="text" name="company_name" value="TCB Pay"/>
<input type="text" name="first_name" value="Roberto"/>
<input type="text" name="last_name" value="Diaz"/>
<input type="text" name="address" value="4446 Green Avenue, Suite 56"/>
<input type="text" name="city" value="Los Angeles"/>
<input type="text" name="state" value="CA"/>
<input type="text" name="country_code" value="US"/>
<input type="text" name="zip_code" value="11111"/>
<input type="text" name="phone_number" value="323-323-3223"/>
<input type="text" name="email" value="abcdef@mail.com"/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="button" value="submit" />
</form>
Sample Response :
{"response":{"code":"01","description":" Merchant Information is Missing"}}
Response Codes:
Code | Description |
---|---|
01 | username is missing or invalid |
02 | Credit card is missing or invalid |
03 | Expary Month missing or invalid |
04 | Expary Year missing or invalid |
05 | Expiry Date is invalid |
06 | CVV missing or invalid |
07 | Card Holder Name missing or Credit Card Number missing |
08 | Token missing |
09 | api_key is missing or invalid |
21 | Slang word not allowed |
23 | Token does not exist |
UN | Unknown error, Please contact to administrator |
F | Your transaction is declined |
00 | Transaction Entry Success |
Sandbox:
Sandbox end point URL: https://gateway2-stg.tcbpay.com/apis/{method}
Example: https://gateway2-stg.tcbpay.com/apis/add-card-vault.php
Test Credit Card's Details:
Card Number | CVV |
---|---|
4005510000000013 | 123 |
4111111111111111 | 111 |
4012001037141112 | 083 |
5111111111111111 | 123 |
ACH
Sandbox end point URL: https://gateway2-stg.tcbpay.com/apis/{method}
Example: https://gateway2-stg.tcbpay.com/apis/sale.php
Production end point URL: https://gateway2.tcbpay.com/apis/{method}
Sale API
This API is responsible to create a new payment transaction. API is compatible of both encrypted and plain credit card method of transactions.
URL To Call: https://gateway2.tcbpay.com/apis/ach_sale.php
Method of Form Submission: POST
The table describes the request parameters for Sale API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
password | TCB Pay Gateway Password | Y | TCB Pay Gateway Password |
currency | Currency of Transaction | Y | USD |
account_number | Account Number of the customer | Y | 201534353553 |
routing_number | Routing Number of the customer | Y | 124343435 |
bank_name | Bank name of check | Y | Bank of America |
amount | Amount of the check | Y | 133.24 |
account_type | Account Type of the customer | Y | CHECKING, SAVINGS |
first_name | First name of Account Holder | N | Roberto |
last_name | Last name of Account Holder | N | Diaz |
adress | Address of the customer | N | 4446 Green Avenue, Suite 56 |
city | City of the customer | N | Los Angeles |
state | State of the customer | N | CA |
country_code | Country of the customer | N | 209 (Follow Country List below) |
zip_code | Zipcode of the customer | N | 94085 |
phone_number | Phone Number of the customer | N | 408-345-2323 |
Email ID of the customer | N | test@test.com | |
custom_field_1 | Custom value 1 | N | - |
custom_filed_2 | Custom value 2 | N | - |
custom_filed_3 | Custom value 3 | N | - |
Response:
Response Type of the API Call is a JSON array. For Error, Elements are error_code and error_ description and for Successful transactions, Two Elements are returned. success_code, success_description. success_code is always 00.
Example:
<html lang="en">
<head>
<meta charset="UTF-8">
<title>TCB Pay ACH API Test</title>
</head>
<body>
<form name="" action="https://gateway2.tcbpay.com/apis/ach_sale.php" method="post">
<input type="text" name="username" value="tcbpayusername"/>
<input type="text" name="password" value="tcbpaypassword"/>
<input type="text" name="currency" value="USD"/>
<input type="text" name="account_number" value="201534"/>
<input type="text" name="routing_number" value="124343435"/>
<input type="text" name="bank_name" value="Bank of America"/>
<input type="text" name="amount" value="133.24"/>
<input type="text" name="account_type" value="personal"/>
<input type="text" name="first_name" value="Roberto"/>
<input type="text" name="last_name" value="Diaz"/>
<input type="text" name="address" value="4446 Green Avenue, Suite 56"/>
<input type="text" name="city" value="Los Angeles"/>
<input type="text" name="state" value="CA"/>
<input type="text" name="zip_code" value="94085"/>
<input type="text" name="country_code" value="209"/>
<input type="text" name="email" value="test@test.com"/>
<input type="text" name="phone_number" value="408-345-2323"/>
<br/>
<input type="submit" value="submit"/>
</form>
</body>
</html>
Sample Response :
{"response":{"error_code":"03","error_description":"Account Number is Missing or Invalid"}}
Report API:
This API is responsible to generate transaction reports.
URL To Call: https://gateway2.tcbpay.com/apis/merchant_check21_reporting.php
Method of Form Submission : POST
The table describes the request parameters for Report API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
password | TCB Pay Gateway Password | Y | TCB Pay Gateway Password |
start_date | From date | Y | YYYY-MM-DD |
end_date | To date | Y | YYYY-MM-DD |
Response:
Response Type of the API Call is a JSON array. For Error, Elements are error_code and error_ description and for Successful transactions, Two Elements are returned. success_code, transaction array. success_code is always 00.
Example :
<html lang="en">
<head>
<meta charset="UTF-8">
<title>TCB Pay ACH API Report Test</title>
</head>
<body>
<form name="" action="https://gateway2.tcbpay.com/apis/ merchant_check21_reporting.php"
method="post">
<input type="text" name="username" value="tcbpayusername"/>
<input type="text" name="password" value="tcbpaypassword"/>
<input type="text" name="start_date" value="2019-04-01"/>
<input type="text" name="end_date" value="2019-04-15"/>
<br/>
<input type="submit" value="submit"/>
</form>
</body>
</html>
Sample Response :
{"response":{"error_code":"19","error_description":" Transaction Start Date is missing or invalid"}}
Error Codes:
Error Code | Description |
---|---|
01 | Merchant Information is Missing |
02 | Transaction Currency is Missing |
03 | Account Number is missing or Invalid |
04 | Routing Number is missing or invalid |
05 | Check Number is missing or invalid |
06 | Invalid Amount |
07 | Account Type is Missing |
08 | Proper Zipcode is missing |
09 | Proper Customer Email Id is missing |
10 | Invalid Processor |
11 | Requested Currency is not allowed for this Merchant |
12 | Invalid Merchant Information |
13 | Invalid Country Code |
14 | Sale Volume exceeded for this Merchant |
15 | Monthly Volume exceeded for this Merchant |
16 | Transaction Limit exceeded for this Merchant |
17 | IP wise transaction limit exceeded for this Merchant |
18 | Bank Name is missing |
19 | Transaction Start Date is missing or invalid |
20 | Transaction End Date is missing or invalid |
A1 | Transaction Entry Failure |
Country List:
Country Code | Country Name |
---|---|
209 | United States |
Currency List:
Currency Code | Currency Name |
---|---|
USD | United Sates Dollar |
Alternative Payment
Sandbox end point URL: https://gateway2-stg.tcbpay.com/apis/{method}
Example: https://gateway2-stg.tcbpay.com/apis/banktransactions.php
Production end point URL: https://gateway2.tcbpay.com/apis/{method}
Payment API
This API is responsible to a payment request to generate a request token.
URL To Call: https://gateway2.tcbpay.com/apis/banktransactions.php
Method of Form Submission: POST
The table describes the request parameters for Payment API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
currency | Currency of Transaction | Y | USD |
amount | Amount of the check | Y | 4.00 |
first_name | First name of Account Holder | N | Roberto |
last_name | Last name of Account Holder | N | Diaz |
address | Address of the customer | N | 4446 Green Avenue, Suite 56 |
phone_number | Phone Number of the customer | N | 408-345-2323 |
Email ID of the customer | N | test@test.com | |
order_id | Order ID of the customer | N | 1234 |
return_url | After payment transaction user is redirected this url | Y | URL |
callback_url | URL to receive transaction details (like code, status, bank_name, transaction_id, order_id). | N | URL |
Response:
Response Type of the API Call is a JSON array. For Error, Elements are code and message and for Successful token creation, Three Elements are returned code, message, redirect_url. code is always 00. We can copy and paste this redirect_url link to another tab or browser for final payment transaction.
Example:
<html lang="en">
<head>
<meta charset="UTF-8">
<title>TCB Pay Alternative Payment API Test</title>
</head>
<body>
<form name="" action="https://gateway2.tcbpay.com/apis/banktransactions.php" method="post">
<input type="text" name="username" value="tcbpayusername"/>
<input type="text" name="api_key" value="tcbpayapikey"/>
<input type="text" name="currency" value="USD"/>
<input type="text" name="amount" value="4.00"/>
<input type="text" name="first_name" value="Roberto"/>
<input type="text" name="last_name" value="Diaz"/>
<input type="text" name="address" value="4446 Green Avenue, Suite 56"/>
<input type="text" name="phone_number" value="408-345-2323"/>
<input type="text" name="email" value="test@test.com"/>
<input type="text" name="order_id" value="1234"/>
<input type="text" name="return_url" value="https://xyz.com/yourpage"/>
<input type="text" name="callback_url" value="https://abc.com/yourpage"/>
<br/>
<input type="submit" value="submit"/>
</form>
</body>
</html>
Sample Response :
{"code":"00","message":"SUCCESS","redirect_url":"https://gateway2-stg.tcbpay.com/apis/bank_payment.php?id=xxxxxxxxxxxxxxxxxxxx"}
Payment report API:
This API is responsible to fetch payment details.
URL To Call: https://gateway2.tcbpay.com/apis/bankaccount_report.php
Method of Form Submission : POST
The table describes the request parameters for Payment report API
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | TCB Pay Gateway Username | Y | TCB Pay Gateway Username |
api_key | TCB Pay Gateway API Key | Y | TCB Pay Gateway API Key |
start_date | Start Date of transaction (Start Date and End Date or Transaction ID) | Y | YYYY-MM-DD |
end_date | End Date of transaction (Start Date and End Date or Transaction ID) | Y | YYYY-MM-DD |
transaction_id | Unique transaction id generate by gateway (Start Date and End Date or Transaction ID) | Y | 1234 |
Response:
Response Type of the API Call is a JSON array. For Error, Elements are error_code and error_description and for Successful transactions, Three Elements are returned. success_code, description, transaction array. success_code is always 00.
Example :
<html lang="en">
<head>
<meta charset="UTF-8">
<title>TCB Pay ACH API Report Test</title>
</head>
<body>
<form name="" action="https://gateway2.tcbpay.com/apis/bankaccount_report.php"
method="post">
<input type="text" name="username" value="tcbpayusername"/>
<input type="text" name="api_key" value="tcbpayapikey"/>
<input type="text" name="start_date" value="2019-04-01"/>
<input type="text" name="end_date" value="2019-04-15"/>
<br/>
<input type="submit" value="submit"/>
</form>
</body>
</html>
Sample Response :
{"response":{"code":"23","description":"Either enter Start Date and End Date or Transaction ID"}}
Error Codes:
Error Code | Description |
---|---|
01 | username is missing or invalid |
09 | api_key is missing or invalid |
23 | Either enter Start Date and End Date or Transaction ID |
Sandbox:
Sandbox end point URL: https://gateway2-stg.tcbpay.com/apis/banktransactions.php
Note:
You will get redirect url after calling this api. Then redirect to that url and continue payment process. Bank name: Bank of America User ID: thansen59 Password and OTP: Any string value
Merchant Onboarding
Sandbox end point URL: https://app-dev.tcbpay.com/api/{method}
Example: https://app-dev.tcbpay.com/api/onboarding
Production end point URL: https://app.tcbpay.com/api/{method}
Onboarding API
This API is responsible to create a new application.
URL To Call: https://app.tcbpay.com/api/onboarding
Method of Form Submission: POST
The table describes the request parameters for Onboarding API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | Merchant App Username | Y | Merchant App Username |
password | Merchant App Password | Y | Merchant App Password |
mcc_code | SIC Code / MCC Code (Sub-Merchant Category Code) | Y | 1711 |
source_code | From Where you get to know about Merchant App | Y | For Friend/ Colleague use friend_colleague, For Search Engine use search_engine, For Social Media use social_media, For Other use other |
source_msg | If any one select "Friend/ Colleague" OR "Other" then this one is require | C | John Paul/ From Any Other Site |
country_code | Country of the customer(ISO 3) | Y | USA,AIA,IND,CAN |
principal_name | Principal Name | Y | John Paul |
principal_title | Principal Title | Y | Mr, CEO, MD |
bank_disclousure_date | Merchant Date | Y | YYYY-MM-DD |
legal_name | Business Legal | Y | ABCDEFGH |
irs_tax_name | Irs Tax Name | Y | Irs Tax Name |
street_number | Street number of the Business Address | N | 777 |
address | Business Address | Y | 777 Brockton Avenue |
address_2 | Business Address 2 | N | Brockton |
state | State | Y | MA |
city | City | Y | Abington |
zip_code | Zip Code | Y | 02351 |
land_telephone | Business Land phone Number | Y | 4567891120 |
land_telephone_iso2 | Phone number iso extention | N | +1 |
ein_no | EIN ID | Y | 654897123 (Should have 9 digits) |
started_date | Business Start Date | Y | YYYY-MM-DD |
state_filling | State of Filing | Y | MA |
business_type | Type of Business Owning | Y | AutoRental, ECommerce, Lodging, MOTO, Restaurant, Retail |
is_contact_info_same_as_business_info | Is contact info same as business info | N | Default Y, If N then contact fields should be required |
contact_name | Contact name | Required if is_contact_info_same_as_business_info value N | John Paul |
contact_title | Contact title | Required if is_contact_info_same_as_business_info value N | CEO, Mr |
contact_phone | Contact phone | Required if is_contact_info_same_as_business_info value N | 1800000000 |
contact_phone_iso2 | Contact phone iso extention | Required if is_contact_info_same_as_business_info value N | +1 |
contact_email | Contact email | Required if is_contact_info_same_as_business_info value N | 1234@gmail.com |
postal_code_extension | Zip Code extention | N | 91 |
dba_name | DBA Name | Y | ABCDEFGH |
street_number | Street number of DBA Address | Y | 777 |
address | DBA Address | Y | 777 Brockton Avenue |
address1 | DBA Address 1 | N | Brockton |
city | City | Y | Abington |
state | State | Y | MA |
zip_code | Zip Code | Y | 02351 |
phone | Phone Number | Y | 1234567890 |
business_website | Business website | Y | www.abc.com |
dba_business_email | Business Email ID | Y | 1234@gmail.com |
add_terminals | Add Terminal | N | Y For Yes, N for No |
mail_monthly_merchant_to | Mail Monthly merchant to | N | L-legal,D-dba |
ownership_type | Ownership Type | Y | "PublicCorporation", "PrivateCorporation", "SECRegulatedCorporation", "Government", "SoleProprietorship", "LLC", "Partnership", "NonProfit", "FinancialInstitution", "Trust" |
zone | Customer Service Number | N | 1 For Business district, 2 for Industrial, 3 for Residential |
location | Location | N | 1 for Mall, 2 for Office, 3 for Home, 4 for Shopping area, 5 for Mixed, 6 for Apartment, 7 for Isolated |
approx_square_footage | Approx Square Footage | N | 2000 |
is_all_product_delivered_immediately | All product delivered Immediately | N | Yes, No |
is_dba | Is DBA | N | Y: Yes, N: No |
dda_type | DDA Type | Y | Checking, Savings |
ach_type | ACH Type | C, Required if DDA Type is Checking | CommercialChecking, PrivateChecking |
routing_no | Bank Routing Number | Y | 546435745 |
account_no | Bank Account Number | Y | 123456789456123 |
batch_close_method | Batch Close Method | N | TimeInitiated, MerchantInitiated |
batch_close_time | Batch Close Time | N | 20:00:00 |
check_for_duplicate_transactions | Check For Duplicate Transactions | N | Yes, No |
enable_commercial_card_bin_query | Enable Commercial Card Bin Query | N | Yes, No |
swipe_per | Swipe Percentage | Y | If a CNP submission as per MCC selection, default swiped to 0 |
eco_per | Eco Percentage | Y | -- |
moto_per | Moto Percentage | Y | -- |
visa_mc_discover_monthly_volume | VISA/DISC./MASTERCARD Monthly Volume $ | Y | 5000 |
visa_mc_discover_avg_ticket | VISA/DISC./MASTERCARD Average Ticket $ | Y | 5000 |
visa_mc_discover_high_ticket | High Ticket $ | Y | 10000000 |
visa_mc_discover_minimum_ticket | Minimum Ticket $ | N | 1000 |
amex_monthly_volume | AMEX Monthly Volume $ | Y | 5000 |
amex_avg_ticket | AMEX Average Ticket $ | Y | 100000 |
amex_high_ticket | High Ticket $ | N | 1000 |
amex_minimum_ticket | Minimum Ticket $ | N | 500 |
card_charge_delay_id | Card Charge Delay | Y | 1 For Same Day, 2 for 1-5 Days, 3 for 6-15 days, 4 for 16-30 days, 5 for over Over 30 Days |
type | Owner Type | C |
If ownership type is sole proprietorship: 1. Beneficial Owner1 with firstName, lastName, addressLine1, city, state, country, postalCode, and DOB are mandatory. 2. Other owner attributes are optional. (NOTE: We need to collect dob and SSN (as FederalTaxId) for underwriting the sub-merchant, even though sole proprietorship is exempt.) 3. No other ownership type can be added. 4. A sole proprietorship's sole owner cannot be deleted. or If ownership type is LLC or Partnership or PrivateCorporation or NonProfit: 1. Control Owner information is Required 2. Beneficial Owner information is Required. When provided, firstName, lastName, addressLine1, city, state, country, and postalCode are mandatory. 2. Beneficial Owner SSN, DOB, and other attributes are optional. 3. They can add up to 10 additional Beneficial Owners (in addition to Control Owner). When provided, firstName, lastName, addressLine1, city, state, country, and postcalCode are mandatory. "ControlOwner", "BeneficialOwner1", "BeneficialOwner2", "BeneficialOwner3", "BeneficialOwner4", "BeneficialOwner5", "BeneficialOwner6", "BeneficialOwner7", "BeneficialOwner8", "BeneficialOwner9", "BeneficialOwner10"or: 1. Control Owner information is optional. When provided, firstName, lastName, addressLine1, city, state, country, and postalCode are mandatory. 2. Control Owner SSN, DOB, and other attributes are optional. 3. They can add up to 10 additional Beneficial Owners (in addition to Control Owner). When provided, firstName, lastName, addressLine1, city, state, country, and postcalCode are mandatory. "ControlOwner", "BeneficialOwner1", "BeneficialOwner2", "BeneficialOwner3", "BeneficialOwner4", "BeneficialOwner5", "BeneficialOwner6", "BeneficialOwner7", "BeneficialOwner8", "BeneficialOwner9", "BeneficialOwner10" |
title | Owner Title | Y | Owner, Co-owner, President, Legal Contact, Secretary/Treasurer, Partner, General Manager, Administrator, Vice President, Director, CEO, Corporate Office Title, Principal, CFO, COO |
Email ID | Y | 1234@gmail.com | |
first_name | First Name | Y | John |
middle_initial | Middle Initial | N | |
last_name | Last Name | Y | Paul |
date_of_birth | Birth Date | Y | YYYY-MM-DD |
street_number | Street Number | N | 777 |
address | Address | Y | 777 Brockton Avenue |
address1 | Address 1 | N | Brockton |
city | City | Y | Abington |
state | State | Y | MA |
zip_code | Zip Code | Y | 02351 |
postal_code_extension | Postal Code Extention | N | |
home_telephone | Home Telephone Number | Y | 1234567890 |
home_telephone_ext | Home Telephone Number Extention | N | 1234567890 |
fax_number | FAX Number | N | 1234567890 |
driving_licance_no | Driver Licence No. | Y | 786fg6587g |
driving_licance_state | DL issued state | N | NV |
driving_licance_expiration_date | DL expiration date | N | 10-19-2018 |
driving_licance_issued_city | DL issued city | N | |
driving_licance_issued_country | DL issued country | N | |
driving_licance_date_issued | DL date issued | N | 10-19-2018 |
ssn | SSN Number | Y | ASN1234560 |
has_significant_managerial_control | Has significant managerial control | N | Yes, No |
first_gurrantor_name | first guarantor Name | Y | John Paul |
first_gurrantor_title | first guarantor Title | Y | CEO |
first_gurrantor_date | first guarantor Date | Y | YYYY-MM-DD |
second_gurrantor_name | Second guarantor Name | N | John Paul |
second_gurrantor_title | Second guarantor Title | N | CEO |
second_gurrantor_date | Second guarantor Date | N | YYYY-MM-DD |
business_per_sale | What percentage of sales are business (%) | Y | 25 |
individual_per_sale | What percentage of sales are Individuals (%) | Y | 75 |
customer_base_usa | Ecommerce merchants - % of customer base USA | Y | 30 |
customer_base_ue | Ecommerce merchants - % of customer base EU (Europe) | Y | 20 |
customer_base_la | Ecommerce merchants - % of customer base LA (Latin America) | Y | 20 |
customer_base_asia | Ecommerce merchants - % of customer base Asia | Y | 20 |
customer_base_othr | Ecommerce merchants - % of customer base OTHER country | Y | 10 |
specify_customer_base_othr | Ecommerce merchants - % of customer base OTHER country | C | If select customer base other country then need to specify |
cardcharge_on_orderday | CARDS ARE CHARGED ON THE Day Of Order | N | Other |
cardcharge_on_other_specify | CARDS ARE CHARGED ON THE Other | C, If selct card are charged on other then need to specify | |
time_to_product_shipped | When the product will shipped? | C, If selct card are charged on other then need to specify | 15 Days |
deliver_digital_content | Do you deliver digital content? | N | Yes or NO |
list_of_url_login | List all URLs | C, If you deliver digital content | google.com, facebook.com |
deliver_phisical_product | Do you deliver a physical product? | N | Yes or NO |
who_ship_product | Who will Ship The Product | N | |
product_delivery_7days | Product Delivery 7days | Y | 25% |
product_delivery_8_14days | Product Delivery in 8 to 14days | Y | 25% |
product_delivery_15_30days | Product Delivery 15 to 30 Days | Y | 25% |
product_delivery_31days | Product Delivery 31days | Y | 25% |
require_deposit_for_future_delivery | Deposit For Future Delivery | N | Yes Or NO |
percent_of_sale_require | Percent Of Sale | N | 10 |
flat_fee_require | Flat Fee | N | 10 |
final_payment_due_before_fulfillment | Final Payment Due Before Fulfillment | N | Yes Or No |
number_of_day | Number Of Day | N | |
auto_negetive_billing_option | Auto Negetive Billing Option | N | Yes Or No |
product_guarantee_warranty | Product Guarantee Warranty | N | Yes Or No |
guarantee_warranty_is | Guarantee Warranty Is | N | |
refund_policy | Refund Policy | N | Yes Or No |
return_policy_display_written_available | Return Policy Display Written Available | N | Yes Or No |
explain_return_policy_display_written_available | Explain Return Policy Display Written Available | C, Required If Yes return policy written available | |
business_of_recurring_billing | Business Of Recurring Billing | N | Yes Or No |
business_of_recurring_billing_frequency | Business Of Recurring Billing Frequency | N | 5 |
business_of_recurring_billing_frequency_specify | Business Of Recurring Billing Frequency Specify | C | If yes then specify |
card_payment_info_enter_into_system | Card Payment Info Enter Into System | N | Yes Or No |
card_payment_info_enter_into_system_specify | Card Payment Info Enter Into System Specify | C | If select yes then need to specify card payment info enter into system |
payment_info_enter_via_internet | Payment Info Enter Via Internet | N | Yes Or No |
payment_channel_encrypt_by_ssl | Payment Channel Encrypt By Ssl | Y | Yes Or No |
process_seasonally | Process Seasonally | N | |
processing_month | Process Month | N | "jan","feb","nov" |
highest_monthly_sale | Highest monthly sale | N | "jan","feb","nov" |
peak_month | Peak Month | N | "jan","feb","nov" |
business_require_special_licence | Business Require Special Licence | N | Yes Or No |
licence_type | Licence Type | N | |
own_product_inventory | Own Product Inventory | N | Yes Or No |
is_business_located_your_location | Is Your Business Located Your Location? | N | Yes Or No |
store_address | Store Address | N | 777 Free school street |
reseller_agreement | Reseller agreement | N | Yes, No |
product_stored_shipped_from | Product Stored Shipped From | Y | Ohio |
fulfillment_center_name | Fulfillment Center Name | N | ABCD |
fulfillment_contact_name | Fulfillment Contact Name | N | John Paul |
fulfillment_contact_phone | Fulfillment Contact Phone | N | 1234567890 |
fulfillment_contact_email | Fulfillment Contact Email | N | abcd@website.com |
fulfillment_contact_address | Fulfillment Contact Address | N | 777 Brockton Avenue |
fulfillment_contact_city | Fulfillment Contact City | N | Abington |
fulfillment_contact_state | Fulfillment Contact State | N | MA |
fulfillment_contact_zip | Fulfillment Contact Zip | N | 33606 |
method_of_delivery | Method Of Delivery | Y | 1 for US Postal, 2 for Fedex, 3 for UPS, 4 for Courier, other |
specify_other_method | Specify Other Method | C | If you select other method then you need to specify |
display_receipt_request | Display Receipt Request | N | |
trade_company_name | Trade Company Name | N | Paul Com |
trade_contact_name | Trade Contact Name | N | John Paul |
trade_contact_phone | Trade Contact Phone | N | 1234567890 |
trade_contact_title | Trade Contact Title | N | Mr |
trade_contact_address | Trade Contact Address | N | 777 Brockton Avenue |
trade_contact_city | Trade Contact City | N | Abington |
trade_contact_state | Trade Contact State | N | 1234567890 |
trade_contact_zip | Trade Contact Zip code | N | 33606 |
pci_store_credit_card | Is pci store credit card | N | Y: Yes, N: No |
pci_third_party_detail_processor_detail | Pci third party detail processor detail | N | |
pci_third_party_detail_processor_version | Pci third party detail processor version | N | |
is_been_sanctioned_a_card_scheme_or_acquirer | Is been sanctioned a card scheme or acquirer | N | Y: Yes, N: No |
is_ever_defaulted_on_a_debt_or_obligation | Is ever defaulted on a debt or obligation | N | Y: Yes, N: No |
is_ever_been_terminated_by_an_acquirer_or_processor | Is ever been terminated by an acquirer or processor | N | Y: Yes, N: No |
is_ever_been_involved_in_a_bankruptcy_proceeding | Is ever been involved in a bankruptcy proceeding | N | Y: Yes, N: No |
explain_processing | Explain Processing | C, Required if Yes above any fields | test |
type | Accepted Card Type | Y | MasterCard, Visa Required AmericanExpress, Discover Optional |
attributes | Accepted Card attributes | C | Discover Attribute 1 (mandatory) name - Acquired value - Yes or No Attribute 2 (Include if and only if Acquired = No) name - AccountNumber value - the account number associated with the card AmericanExpress Attribute 1 (mandatory) name - AmexProgram values - ESA or OptBlue Attribute 2 (Include if and only if AmexProgram = ESA) name - AccountNumber value - the account number associated with the card Attribute 3 (Optionally included if AmexProgram = OptBlue. Defaults to No.) name - ReceiveOptBlueMarketing value - Yes or No |
The table describes the MCC Name.
MCC Name | MCC Code |
---|---|
Air Conditioning, heating and Plumbing Contractors | 1711 |
Insulation, Masonry, plastering, Stonework and Tile Setting Contractors (Retail) | 1740 |
Roof and Siding, Sheet Metal Work Contractors (Retail) | 1761 |
Contractors, Special Trade - not elsewhere classified (Retail) | 1799 |
Sanitation, Polishing, and Specialty Cleaning Preparations (Retail) | 2842 |
Chemicals and Allied Products, not elsewhere classified (Retail) | 5169 |
Miscellaneous Food Stores-Convenience Stores, Specialty Markets (Retail) | 5499 |
Automotive Tire Stores (Retail) | 5532 |
Automotive Parts, Accessories Stores (Retail) | 5533 |
Floor Coverings Stores (Retail) | 5713 |
Music Stores, Musical Instruments, Pianos, Sheet Music (Retail) | 5733 |
Caterers (Retail) | 5811 |
Eating Places, Restaurants (Retail) | 5812 |
Bars, Cocktail Lounges, Drinking Places (Alcoholic Beverages) (Retail) | 5813 |
Fast Food Restaurants (Retail) | 5814 |
Package Stores, Beer, Wine, and Liquor (Retail) | 5921 |
Miscellaneous and Specialty retail Stores (Retail) | 5999 |
Lodging - Hotels, Motels, Resorts - not elsewhere classified (Retail) | 7011 |
Counseling Services - Debt, Marriage, and Personal (Retail) | 7277 |
Automotive Body Repair Shops (Retail) | 7531 |
Motion Picture Theaters (Retail) | 7832 |
Video Amusement Game Supplies (Retail) | 7993 |
Amusement Parks, Carnivals, Circuses, Fortune Tellers (CNP) | 7996 |
Recreation Services - not elsewhere classified (Retail) | 7999 |
Doctors and Physicians - Not Elsewhere Classified (Regular doctors offices) | 8011 |
Doctors and Physicians - Not Elsewhere Classified (CBD) | 8011 |
Counseling Services - Debt, Marriage, and Personal (ECOM) | 7277 |
Amusement Parks, Carnivals, Circuses, Fortune Tellers (Retail) | 7996 |
Bars, Cocktail Lounges, Drinking Places (Alcoholic Beverages) (CNP) | 5813 |
Automotive Tire Stores (CNP) | 5532 |
Miscellaneous Food Stores-Convenience Stores, Specialty Markets (CNP) | 5499 |
Insulation, Masonry, plastering, Stonework and Tile Setting Contractors (CNP) | 1740 |
Lodging - Hotels, Motels, Resorts - not elsewhere classified (CNP) | 7011 |
Motion Picture Theaters (CNP) | 7832 |
Eating Places, Restaurants (CNP) | 5812 |
Automotive Parts, Accessories Stores (CNP) | 5533 |
Roof and Siding, Sheet Metal Work Contractors (CNP) | 1761 |
Automotive Body Repair Shops (CNP) | 7531 |
Package Stores, Beer, Wine, and Liquor (CNP) | 5921 |
Fast Food Restaurants (CNP) | 5814 |
Sanitation, Polishing, and Specialty Cleaning Preparations (CNP) | 2842 |
Caterers (CNP) | 5811 |
Contractors, Special Trade - not elsewhere classified (CNP) | 1799 |
Music Stores, Musical Instruments, Pianos, Sheet Music (CNP) | 5733 |
Floor Coverings Stores (CNP) | 5713 |
Recreation Services - not elsewhere classified (CNP) | 7999 |
Miscellaneous and Specialty retail Stores (CNP) | 5999 |
Video Amusement Game Supplies (CNP) | 7993 |
Chemicals and Allied Products, not elsewhere classified (CNP) | 5169 |
Miscellaneous and Specialty Retail Shops (Retail) | 5999 |
Miscellaneous and Specialty Retail Shops (CNP) | 5999 |
Doctors and Physicians - Not Elsewhere Classified (Regular doctors offices) (CNP) | 8011 |
The table describes the Source.
Source Details | Source Code |
---|---|
Friend/ Colleague | friend_colleague |
Search Engine | search_engine |
Social Media | social_media |
Other | other |
HEADER PARAMETERS:
Content-Type: application/json
REQUEST BODY SCHEMA:
application/json
Response:
Response of the API Call is a JSON array. For Error,Two elements are returned. They are code and msg.For Successful transactions, three elements are returned. They are code, msg and application_id. Response code is always 00 for successful API call.
Example:
$requestString=' {
"username":"APP_USERNAME",
"password":"APP_PASSWORD",
"general": {
"mcc_code":"6318",
"source_code":"social_media",
"source_msg":"",
"country_code":"USA"
},
"bankDiscloser": {
"principal_name":"Sunanda Roy",
"principal_title":"CEO",
"bank_disclousure_date":"2021-10-10"
},
"businessInfo": {
"legal_name":"new tcb 22nd Feb",
"irs_tax_name":"test",
"street_number":"777",
"address": "Brockton Avenue",
"address_2":"",
"state":"MA",
"city":"Abington",
"zip_code":"02351",
"land_telephone":"4567891120",
"land_telephone_iso2":"91",
"ein_no": "123445589",
"started_date": "2010-10-10",
"state_filling":"CA",
"business_type": "AutoRental",
"is_contact_info_same_as_business_info":"Y",
"contact_phone":"4567891120",
"contact_phone_iso2":"91",
"contact_email":"abcdef@website.com",
"contact_name":"Subrata Roy",
"contact_title":"Mr",
"postal_code_extension":"1230"
},
"dbaInfo": {
"chain_code":"03846S",
"dba_name":"test dba 22nd Feb",
"street_number":"700",
"address":"Brockton Avenue",
"address1":"",
"city":"Abington",
"state":"MA",
"zip_code":"02351",
"phone":"5555556666",
"business_website":"tcbpay.com",
"dba_business_email":"abcdf@business.com",
"customer_service_no":"5555556666",
"customer_service_no_iso2":"",
"billing_descriptor":"tes*tDb*a",
"add_terminals":"Y",
"mail_monthly_merchant_to":"L",
"ownership_type":"Trust"
},
"siteSurveyInfo": {
"zone":"1",
"location":"2",
"approx_square_footage":"2000",
"is_all_product_delivered_immediately":"No"
},
"bankAccount": {
"is_dba":"Y",
"dda_type":"Checking",
"ach_type":"CommercialChecking",
"routing_no":"021000021",
"account_no":"123456789456123",
"debit_account_merchant_dba_or_leagal":"Y",
"batch_close_method":"TimeInitiated",
"batch_close_time":"20:00:00",
"check_for_duplicate_transactions":"Yes",
"enable_commercial_card_bin_query":"No",
"validate_bank_account":"Y"
},
"salesProfile": {
"swipe_per":"0",
"eco_per":"80",
"moto_per":"20",
"visa_mc_discover_monthly_volume":"5000",
"visa_mc_discover_avg_ticket":"10000",
"visa_mc_discover_high_ticket":"10000000",
"visa_mc_discover_minimum_ticket":"1000",
"amex_monthly_volume":"5000",
"amex_avg_ticket":"10000",
"amex_high_ticket":"1000",
"amex_minimum_ticket":"1000",
"card_charge_delay_id":"100"
},
"owners": [
{
"type":"BeneficialOwner1",
"title":"Owner",
"email":"abcdf@website.com",
"ownership_per":"50",
"first_name":"Subrata",
"middle_initial":"",
"last_name":"Roy",
"date_of_birth":"2000-10-19",
"street_number":"775",
"address":"Brockton Avenue",
"address1":"",
"city":"Abington",
"state":"MA",
"zip_code":"02351",
"home_telephone":"5555556666",
"home_telephone_ext":"91",
"fax_number":"",
"country":"USA",
"postal_code_extension":"",
"driving_licance_issued_city":"",
"driving_licance_issued_country":"",
"driving_licance_date_issued":"2018-10-19",
"driving_licance_expiration_date":"2028-10-19",
"ssn":"999999999",
"driving_licance_no":"786fg6587g",
"driving_licance_state":"MA",
"has_significant_managerial_control":1
},
{
"type":"BeneficialOwner2",
"title":"Co-Owner",
"email":"12345@website.com",
"ownership_per":"50",
"first_name":"Subrata",
"middle_initial":"",
"last_name":"Roy",
"date_of_birth":"2000-10-19",
"street_number":"775",
"address":"Brockton Avenue",
"address1":"",
"city":"Abington",
"state":"MA",
"zip_code":"02351",
"home_telephone":"5555556666",
"home_telephone_ext":"91",
"fax_number":"",
"country":"USA",
"postal_code_extension":"",
"driving_licance_issued_city":"",
"driving_licance_issued_country":"",
"driving_licance_date_issued":"2018-10-19",
"driving_licance_expiration_date":"2028-10-19",
"ssn":"999999999",
"driving_licance_no":"786fg6587g",
"driving_licance_state":"MA",
"has_significant_managerial_control":1
}
],
"personalGuaranty": {
"first_gurrantor_name":"Subrata Roy",
"first_gurrantor_title":"MR",
"first_gurrantor_date":"2021-10-07",
"second_gurrantor_name":"Sanjay Roy",
"second_gurrantor_title":"MR",
"second_gurrantor_date":"2021-10-07"
},
"schedulea": {
"is_next_day_funding_requested":"N",
"exiting_ebt_item_no":"123456",
"existing_amex_ac_no":"5649875465"
},
"questionnaire": {
"business_per_sale":"60",
"individual_per_sale":"40",
"method_of_marketing":[
"1","2","7"
],
"customer_base_usa":"40",
"customer_base_ue":"20",
"customer_base_la":"20",
"customer_base_asia":"10",
"customer_base_othr":"10",
"specify_customer_base_othr":"India",
"cardcharge_on_orderday":"other",
"cardcharge_on_other_specify":"other",
"time_to_product_shipped":"30 Days",
"deliver_digital_content":"Yes",
"list_of_url_login":[
"google.com",
"facebook.com"
],
"deliver_phisical_product":"No",
"who_ship_product":"I dont know",
"product_delivery_7days":"30",
"product_delivery_8_14days":"20",
"product_delivery_15_30days":"10",
"product_delivery_31days":"40",
"require_deposit_for_future_delivery":"No",
"percent_of_sale_require":"10",
"flat_fee_require":"10",
"final_payment_due_before_fulfillment":"No",
"number_of_day":"",
"auto_negetive_billing_option":"No",
"product_guarantee_warranty":"No",
"guarantee_warranty_is":"",
"refund_policy":"No",
"return_policy_display_written_available":"No",
"explain_return_policy_display_written_available":"",
"business_of_recurring_billing":"No",
"business_of_recurring_billing_frequency":"5",
"business_of_recurring_billing_frequency_specify":"",
"card_payment_info_enter_into_system":"No",
"card_payment_info_enter_into_system_specify":"",
"payment_info_enter_via_internet":"No",
"payment_channel_encrypt_by_ssl":"No",
"process_seasonally":"No",
"processing_month":[
"jan","feb","nov"
],
"highest_monthly_sale":[
"jan","feb","nov"
],
"peak_month":[
"jan","feb","nov"
],
"business_require_special_licence":"No",
"licence_type":"",
"own_product_inventory":"No",
"is_business_located_your_location":"No",
"store_address":"Kolkata",
"reseller_agreement":"No",
"product_stored_shipped_from":"Kolkata",
"fulfillment_center_name":"abc",
"fulfillment_contact_name":"Sankar Roy",
"fulfillment_contact_phone":"9999999999",
"fulfillment_contact_email":"aabbccdd@mail.com",
"fulfillment_contact_address":"Kolkata",
"fulfillment_contact_city":"India",
"fulfillment_contact_state":"WB",
"fulfillment_contact_zip":"700131",
"method_of_delivery":"2",
"specify_other_method":"",
"display_receipt_request":"",
"trade_company_name":"SROY",
"trade_contact_name":"ss",
"trade_contact_phone":"879465130",
"trade_contact_title":"Mr",
"trade_contact_address":"7770 Brockton",
"trade_contact_city":"Abington",
"trade_contact_state":"MA",
"trade_contact_zip":"84564"
},
"paymentsApplicationCompliance": {
"pci_store_credit_card":"Y",
"pci_third_party_detail_processor_detail":"",
"pci_third_party_detail_processor_version":""
},
"processingHistory": {
"is_been_sanctioned_a_card_scheme_or_acquirer":"N",
"is_ever_defaulted_on_a_debt_or_obligation":"N",
"is_ever_been_terminated_by_an_acquirer_or_processor":"N",
"is_ever_been_involved_in_a_bankruptcy_proceeding":"Y",
"explain_processing":"test"
},
"acceptedCard": [
{
"type": "MasterCard"
},
{
"type": "Visa"
},
{
"type": "AmericanExpress",
"attributes": [
{
"name": "AmexProgram",
"value": "ESA"
},
{
"name": "AccountNumber",
"value": "123456789"
}
]
}
]
}';
$headers = array( "Content-type: application/json" );
$serverUrl = 'https://app.tcbpay.com/api/onboarding';
$ch=curl_init();
curl_setopt($ch, CURLOPT_URL, $serverUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $requestString);
$result = curl_exec($ch);
curl_close($ch);
Sample Response :
{"response":{ "application_id": "XXXXXXXXXXXXXXXX", "msg": "Successfull", "code": "00" }
Success Code: 00
Success Message: Successfull
File Upload
This API will Upload Files.
URL To Call: https://app.tcbpay.com/api/onboardingFileUpload
Method of Form Submission: POST
The table describes the request parameters for File Upload.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | Merchant App Username | Y | Merchant App Username |
password | Merchant App Password | Y | Merchant App Password |
application_id | The Application ID From Onbaording | Y | XXXXXXXXXXXXXX |
file_url | The URL of upload files | Y | https://app.tcbpay.com/assets/app_pdf/abcdefghijk.pdf |
document_type | Type of document need to upload | Y | DriverLicence, CorporateDocuments, BusinessUtilityBill |
HEADER PARAMETERS:
Content-Type: application/json
REQUEST BODY SCHEMA:
application/json
Example:
{
"username":"YOUR USERNAME",
"password":"YOUR PASSWORD",
"application_id":"XXXXXXXXXX",
"file_url":"https://app.tcbpay.com/assets/app_pdf/TCBPay_PayFac_Merchant_Application.pdf",
"document_type":"driverLicence"
}
Sample Response :
{"response":{ "msg": "success", "code": "00" }
Success Code: 00
Success Message: success
Submit Application
This API will Submit The Application.
URL To Call: https://app.tcbpay.com/api/onboardingSubmit
Method of Form Submission: POST
The table describes the request parameters to perform this API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | Merchant App Username | Y | Merchant App Username |
password | Merchant App Password | Y | Merchant App Password |
application_id | The Application ID From Onbaording | Y | XXXXXXXXXXXXXX |
HEADER PARAMETERS:
Content-Type: application/json
REQUEST BODY SCHEMA:
application/json
Example:
{
"username":"YOUR USERNAME",
"password":"YOUR PASSWORD",
"application_id":"XXXXXXXXXX"
}
Sample Response :
{"response":{ "msg": "Application Submitted successfully", "code": "00", "doc_url": "https://app.tcbpay.com/merchant_portal/download_view/1e438be7a8828fa5f6febeb024e64793" }
Success Code: 00
Success Message: Application Submitted successfully
Document URL: https://app.tcbpay.com/merchant_portal/download_view/1e438be7a8828fa5f6febeb024e64793
Status OF Application
This will Change Status OF Application.
URL To Call: https://app.tcbpay.com/api/onboardingStatus
Method of Form Submission: POST
The table describes the request parameters for this API.
Variable Name | Description | Required | Expected Values |
---|---|---|---|
username | Merchant App Username | Y | Merchant App Username |
password | Merchant App Password | Y | Merchant App Password |
application_id | The Application ID From Onbaording | Y | XXXXXXXXXXXXXX |
HEADER PARAMETERS:
Content-Type: application/json
REQUEST BODY SCHEMA:
application/json
Example:
{
"username":"YOUR USERNAME",
"password":"YOUR PASSWORD",
"application_id":"XXXXXXXXXX"
}
Sample Response :
{"response":{ "status_reason": null, "status_title": "Filled Up Forms" }
Success Code: 00
Success Message: Successfull
WooCommerce Plugin
Version 1.0
Requires WordPress Version : 5.0 or higher
Compatible up to : 5.2.3
Woocommerce plugin version : 3.6.3 higher
Compatible up to : 3.7.0
This plugin allows you to use TCB Payment gateway for your Woo-commerce site, as an additional payment options.
Installation:
There are two methods of it.
A. Place the unzipped plugin into wp-content/plugins folder inside your wordpress site
B. from Wordpress Admin go to Plugins – Add New. Click on Upload Plugin, browse the zip version of TCB Pay plugin folder.
Manage:
After successful installation of the plugin, you have to activate the TCBPay plugin from Plugins Installed Plugins.
Once the TCBPay plugin is activated, you can manage the plugin settings from Woo-commerce Settings Payments TCBPay.
Click on Manage. On the manage screen you can set the following values
Title : Name what you wish to appear on your cart page as payment option.
Description : If you wish to specify any note for the plugins for your customers.
Username : This is the username provided by TCBPay when you signed up for an account.
API Key : This is the API Key provided by TCBPay when you signed up for an account.
Keep the Enable test mode checked, if you want to run the Plugin in test environment.


Download the wordpress plugin package as zip Click here
PrestaShop Module
Version 1.0
Prestashop Version : 1.7.0 or higher
Compatible up to : 1.7.5
This plugin allows you to use TCB Pay payment gateway for your PrestaShop.
Installation:
Navigate to the Modules menu and click on the Module manager button. You would be redirected to the Modules management screen. Click on the Upload a module button to proceed with the installation. A new pop-up would appear. You may either drop the module's .zip file in that pop-up or use the select file link to browse for that module.
Manage:
A new pop-up with Module Installed! message would appear and that's it! Your module is installed now. You may click on the Configure button to edit the newly installed module's options
In the configure screen you can set the following values
Enabled: If Yes then this payment method appear in your cart page as payment option.
Test Mode: If Yes account turned into debug mode
Merchant Username : This is the username provided by Tcb pay when you signed up for an account.
API Key: This is the API Key provided by Tcb pay when you signed up for an account.
Credit Card Type: Choose card type from dropdown
Use CVV: Choose Yes to use CVV


Download the PrestaShop extension package as zip. Click here
Shopify Module
Magento Module
Version 1.0
Magento Version : 2.0 or higher
Compatible up to : 2.1.*
This plugin allows you to use TCBPay payment gateway for your Magento, as an additional payment options.
Installation:
Create a folder name code under magento root directory/app. Place the un zipped module folder under this newly created code folder. Now run the following command from magento root derectory :
- php bin/magento setup:upgrade
- php bin/magento setup:static-content:deploy if store is in production mode
- php bin/magento cache:clean
Manage:
After successful installation of the plugin, you have to enable and manage setting the TCBPay payment gateway from
STORESCONFIGURATIONSALESPayment MethodsTCBPay Payment Gateway
In the manage screen you can set the following values
Enabled: If Yes then this payment method appear in your cart page as payment option.
Title: Name what you wish to appear in your cart page as payment option.
Merchant Username : This is the username provided by Tcbpay when you signed up for an account.
API Key: This is the API Key provided by Tcbpay when you signed up for an account.

Download the megento extension package as zip. Click here
Opencart Module
Version 1.0.0
Opencart Version : 3.0 or higher
Compatible up to : 3.1.*
This plugin allows you to use TCBPay payment gateway for your Opencart, as an additional payment options.
Installation:
There are two methods of it.
A. Unzip the opencart plug-in folder there will be 3 folder admin,catalog,system then upload 3 folders inside the opencart project folder.
B. Login into opencart admin module then goto Extension Installer option – select the plug-in zip and upload it then goto Extensions option and select payment option from extension type we will find we will find TCB Pay and then install by clicking install button.
Manage:
After successful installation of the plugin, you have to enable and manage setting the TCBPay payment gateway from
Extensions ExtensionsPayment MethodsTCBPay Payment GatewayClick on Edit.
In the manage screen you can set the following values
Merchant Username : This is the username provided by Tcbpay when you signed up for an account.
API Key: This is the API Key provided by Tcbpay when you signed up for an account.
Credit Card Types: Select your accepted card.
Test Mode: If we select yes then we get sandbox if no then production.
Status: We must set it enable.


Download the opencart extension package as zip. Click here
osCommerce Module
Version 1.0.0
Opencart Version : 2.3 or higher
Compatible up to : 2.3.*
This plugin allows you to use TCBPay payment gateway for your Opencart, as an additional payment options.
Installation:
1. Copy all new files with your catalog. It won't rewrite any of your files. Just copy & paste on top.
2. In the admin side of your web site go to Modules - Payment and install the new TCB Pay payment.
Edit the payment put credentials and setup with your own settings.
3.Modify the following files as per the following instructions.
1.Installation Instructions:
A:
Find around line 139 in catalog/checkout_process.php file
$customer_notification = (SEND_EMAILS == 'true') ? '1' : '0';
Add Bellow Code above this "$customer_notification = (SEND_EMAILS == 'true') ? '1' : '0';" line:
$order_comment = $order->info['comments'];
if ($tcbpay_transaction_id) {
$order_comment .= "\nTransaction Id: $tcbpay_transaction_id";
}
B:
Find bellow code around line 144 :
'comments' => $order->info['comments']
Replace With
'comments' => $order_comment
C:
Find around line 36 in admin/modules.php:
while (list($key, $value) = each($HTTP_POST_VARS['configuration'])) {
Add The code bellow the line:
if (is_array($value)) $value = implode(',', $value);
D:
add the following code at end of the admin/includes/functions/general.php file.
function tep_cfg_pull_down_tcbpay_cctypes($cctypes, $key = '') {
$name = 'configuration[' . $key . '][]';
$cctypes_array = array(
array(
'id' => 'AE',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_AMERICAN_EXPRESS
), array(
'id' => 'VI',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_VISA
), array(
'id' => 'MC',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_MASTERCARD
), array(
'id' => 'DI',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_DISCOVER
), array(
'id' => 'JCB',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_JCB
), array(
'id' => 'OT',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_OTHER
)
);
return tep_draw_multi_select_menu($name, $cctypes_array, $cctypes);
}
E:
add the following code at end of the admin/includes/functions/general.php file.
function tep_draw_multi_select_menu($name, $values, $default = array(), $parameters = '', $required = false) {
global $HTTP_GET_VARS, $HTTP_POST_VARS;
$field = <select multiple name="' . tep_output_string($name) . '"';
if (tep_not_null($parameters)) $field .= ' ' . $parameters;
$field .= >
if (empty($default) && (isset($HTTP_GET_VARS[$name]) || isset($HTTP_POST_VARS[$name]))) {
if (isset($HTTP_GET_VARS[$name])) {
$default = $HTTP_GET_VARS[$name];
} elseif (isset($HTTP_POST_VARS[$name])) {
$default = $HTTP_POST_VARS[$name];
}
}
if (!is_array($default)) $default = explode(',', $default);
for ($i=0, $n=sizeof($values); $i<$n; $i++) {
$field .= <option value="' . tep_output_string($values[$i]['id']) . '"';
if (in_array($values[$i]['id'], $default)) {
$field .= ' selected="selected"';
}
$field .= > . tep_output_string($values[$i]['text'], array('"' => '"', '\'' => ''', '<' => '<', '>' => '>')) . <option>;
}
$field .= <select>;
if ($required == true) $field .= TEXT_FIELD_REQUIRED;
return $field;
Manage:
In the manage screen you can set the following values
Username : This is the username provided by Tcbpay when you signed up for an account.
API Key: This is the API Key provided by Tcbpay when you signed up for an account.
Credit Card Types: Select your accepted card.
Test Mode: If true TCB Test Pay Enable If false TCB test Pay disable.

Download the osCommerce extension package as zip. Click here
Zen Cart Module
Version 1.0.0
Zen Cart Version : 1.5 or higher
Compatible up to : 1.5.*
This plugin allows you to use TCBPay payment gateway for your Zen Cart, as an additional payment options.
Installation:
1. Copy all new files within your catalog. It won't rewrite any of your files. Just copy & paste on top.
2.Modify the following files as per the following instructions.
1.Installation Instructions:
A:
Find admin/includes/functions/general.php file
Add Bellow Code At The End
function zen_cfg_pull_down_tcbpay_cctypes($cctypes, $key = '') {
$name = 'configuration[' . $key . '][]';
$cctypes_array = array(
array(
'id' => 'AE',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_AMERICAN_EXPRESS
), array(
'id' => 'VI',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_VISA
), array(
'id' => 'MC',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_MASTERCARD
), array(
'id' => 'DI',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_DISCOVER
), array(
'id' => 'JCB',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_JCB
), array(
'id' => 'OT',
'text' => MODULE_PAYMENT_TCBPAY_TEXT_OTHER
)
);
return zen_draw_multi_select_menu($name, $cctypes_array, $cctypes);
}
B:
Find admin/includes/functions/html_output.php file
Add Bellow Code At The End
function zen_draw_multi_select_menu($name, $values, $default = array(), $parameters = '', $required = false) {
$field = '<select multiple rel="dropdown" name="'.zen_output_string($name).'"';
if (zen_not_null($parameters)) {
$field .= ' ' . $parameters;
}
$field .= '>' . "\n";
if (empty($default) && isset($GLOBALS[$name])) {
$default = $GLOBALS[$name];
}
if (!is_array($default)) $default = explode(',', $default);
foreach($default as $dval) {
$default[] = trim($dval);
}
foreach ($values as $value) {
$field .= '<option value="' . zen_output_string($value['id']) . '"';
if (in_array($value['id'], $default)) {
$field .= ' selected="selected"';
}
$field .= '>' . zen_output_string($value['text'], array('"' => '"', '\'' => ''', '<' => '<', '>' => '>')) . 'option>' . "\n";
}
$field .= 'select>' . "\n";
if ($required == true) {
$field .= TEXT_FIELD_REQUIRED;
}
return $field;
}
3. In the admin side of your web site go to Modules - Payment and install the new TCB Pay payment. Edit the payment put credentials and setup with your own settings.
Manage:
In the manage screen you can set the following values
Username : This is the username provided by Tcbpay when you signed up for an account.
API Key: This is the API Key provided by Tcbpay when you signed up for an account.
Credit Card Types: Select your accepted card.
Test Mode: If true TCB Test Pay Enable If false TCB test Pay disable.

Download the Zen Cart extension package as zip. Click here
X-Cart Module
Version 1.0.0
X-Cart Version : 5.4.1.31 or higher
Compatible up to : 5.4.*
This plugin allows you to use TCBPay payment gateway for your X-Cart, as an additional payment options.
Installation:
1. Open X-Cart admin panel, And login with correct credential.
2.Please Click on Apps and then click on My Apps from left side menu.
3. Than click on Upload Addon from top right corner and then upload TCBPay module zip.
4. After successful upload click on Store Setup and then Pyement Method from left side menu.
5. Put credentials and setup with your own settings
Manage:
In the manage screen you can set the following values
Merchant Username : This is the username provided by Tcbpay when you signed up for an account.
API Key: This is the API Key provided by Tcbpay when you signed up for an account.
Credit Card Types: Select your accepted card.
Test Mode: If true TCB Test Pay Enable If false TCB test Pay disable.
Use CVV: If true CVV should Enable If false TCB Pay CVV disable.

Download the X-Cart extension package as tgz. Click here