Bringing business and technology together

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

                                
                                <script type="text/javascript" src="https://[server-name]/services/proxynization_api.js"></script>
                                
                              

                                
                                <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.

                                
                                <input type="button" value="submit"  onClick="TCBPayProxynizationAPI.process('#creditcard_number','tcbpayClientCallback');" />
                                
                              

The table describes the request parameters for Add Card API.

                                  
                                  <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>
                                  
                                

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.

                                  
                                  <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>
                                  
                                

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.

                                  
                                  <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>
                                  
                                

Response Codes:

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:

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.

                                  
                                  <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>
                                  
                                

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.

                                  
                                  <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>
                                  
                                

Country List:

Currency List:

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.

                                  
                                  <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>
                                  
                                

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

                                  
                                  <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>
                                  
                                

Sandbox:

Sandbox end point URL: https://gateway2-stg.tcbpay.com/apis/banktransactions.php

Note:

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

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

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

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

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:

                                
                                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";
                  }
                                
                              

                                
                                Find bellow code around line 144 :  
                                'comments' => $order->info['comments']
                                Replace With
                                'comments' => $order_comment
                                
                              

                                
                                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);
                                
                              

                                
                                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);
                  }
                                
                              

                                
                                 
                                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

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:

                                
                                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);
                                }
                                
                              

                                
                                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;
                                }
                                
                              

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

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

Version 2.4.0

TCB Pay is a secure and simple way to process credit card transaction from your android phone. Just sign in with your gateway credentials and you can be processing payments in seconds.

Version 3.0.0

TCB Pay is a secure and simple way to process credit card transaction from your android phone. Just sign in with your gateway credentials and you can be processing payments in seconds.