Developer Hub
Add Card
Card Details
Delete Card
sale
authorize
Response Codes
Vault
Add Card
Card Details
Delete Card
sale
authorize
Response Codes
Vault API
Sandbox endpoint URL:
https://gateway2-stg.merchantservicedepot.com/apis/{method}
Example:
https://gateway2-stg.merchantservicedepot.com/apis/add-card-vault.php
Production endpoint URL:
https://portal.merchantservicedepot.com/apis/{method}
Add Card
Add Card API
This API is responsible to store Card information inside MSD Vault.
URL to call
https://gateway2-stg.merchantservicedepot.com/apis/add-card-vault.php
Method of form submission
POST
Proxynization APIs
POST
Sandbox
https://gateway2-stg.merchantservicedepot.com/services/proxynization_api.js
Production
https://portal.merchantservicedepot.com/services/proxynization_api.js
- Include proxynization_api.js script file. Please copy the following lines and paste them to your HTML page to enable the proxynization functionality within your application.
Example
<script type="text/javascript" src="https://[server-name]/services/proxynization_api.js"></script>
2. Implement the callback function. The callback function will be invoked once the proxynization response is returned from our system. We make a function call which invokes the pre-defined callback function, and the proxynization response is used as an argument.
Example
<script type="text/javascript" >
function MSDClientCallback(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 the credit card number or 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 absent, the first parameter is assumed to be a credit card number.
3.2 The second parameter is the name of the callback function, which will be called when the proxynization call is completed.
Example
<input type="button" value="submit" onClick="MSDProxynizationAPI.process('#creditcard_number','msdClientCallback');" />
This 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's name of the Credit Card | Y | Roberto Diaz |
Example
Card Details
Card Details API
This API is responsible to retrieve card details from Vault.
URL to call
https://gateway2-stg.merchantservicedepot.com/apis/get-card-details.php
Method of form submission
POST
This 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 a new card vault | Y | XXXXXXXXXXXXXXXXXXXXXXXXX |
Example
<form name="" id="formID" action="https://portal.merchantservicedepot.com/apis/get-card-details.php" method="post">
<input type="text" name="username" value=" msdusername"/>
<input type="text" name="api_key" value=" msdapikey"/>
<input type="text" name="token" value="XXXXXXXXXXXXXXXXXXXXXXXXX"/>
<br/>
<input type="submit" value="submit"/>
</form>
Response
The response of the API Call is a JSON array. For Error, two elements are returned, code and description. For Successful transactions, three elements are returned, code, description details. The response code is always 00 for a successful API call.
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
Delete Card API
This API is responsible to delete secure card details from Vault.
URL to call
https://gateway2-stg.merchantservicedepot.com/apis/delete-card-vault.php
Method of form submission
POST
This 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 a new card vault | Y | XXXXXXXXXXXXXXXXXXXXXXXXX |
Example
<form name="" action="https://portal.merchantservicedepot.com/apis/delete-card-vault.php" method="post">
<input type="text" name="username" value=" msdusername"/>
<input type="text" name="api_key" value=" msdapikey"/>
<input type="text" name="token" value=""/>
<br/>
<input type="submit" value="submit"/>
</form>
Response
The response of the API Call is a JSON array. For Error, two elements are returned, code and description. For Successful transactions, three elements are returned, code, description token. The response code is always 00 for a successful API call.
Sample Response
{"response":{"code":"00","description":"Card Vault is successfully deleted","token":"XXXXXXXXXXXXXXXXXXXXXXXXX"}}
Sale
Sale API
This API is responsible for creating new payment transactions.
URL to call
https://gateway2-stg.merchantservicedepot.com/apis/sale.php
Method of form submission
POST
This 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 a 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 boarding). | 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 |
| address | 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 | Zip code of the customer | Y | 94085 |
| phone_number | Phone Number of the customer | N | 408-345-2323 |
| Email ID of the customer | Y | [email protected] | |
| email_receipt | Send transaction details to a 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 | |
| reference_id | Transaction reference id | N | Reference ID should be unique |
Example
<form name="" id="formID" action="https://portal.merchantservicedepot.com/apis/sale.php" method="post">
<input type="text" name="username" value=" msdusername"/>
<input type="text" name="api_key" value=" msdapikey"/>
<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="MSD"/>
<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="[email protected]"/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="button" value="submit" />
</form>
Response
The response of the API Call is a JSON array. For Error, two elements are returned, code and description. For Successful transactions, three elements are returned, code, description, and array of transactions. The response code is always 00 for a successful API call.
Sample Response
{"response":{"code":"00","description":" Transaction Entry Success","transaction_id":102," total_amount":15.7," convenience_fee":1.2}}
Authorize
Authorize API
This API is responsible to perform pre-authorization payment.
URL to call
https://gateway2-stg.merchantservicedepot.com/apis/authorize.php
Method of form submission
POST
This 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 a 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 boarding). | 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 |
| address | 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 | Zip code of the customer | Y | 94085 |
| phone_number | Phone Number of the customer | N | 408-345-2323 |
| Email ID of the customer | Y | [email protected] | |
| e-mail receipt | Send transaction details to a 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 |
| reference_id | Transaction reference id | N | Reference ID should be unique |
Example
<form name="" id="formID" action="https://portal.merchantservicedepot.com/apis/authorize.php" method="post">
<input type="text" name="username" value=" msdusername"/>
<input type="text" name="api_key" value=" msdapikey"/>
<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="MSD"/>
<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="[email protected]"/>
<input type="checkbox" name="email_receipt" value="Y"/>
<br/>
<input type="button" value="submit" />
</form>
Response
The response of the API Call is a JSON array. For Error, two elements are returned, code and description. For Successful transactions, three elements are returned, code, description, and transaction_id. The response code for a successful API call is always 00.
Sample Response
{"response":{"code":"01","description":" Merchant Information is Missing"}}
Response Codes
Add Plan
| Code | Description |
|---|---|
| 01 | Username is missing or invalid |
| 02 | Credit Card is missing or invalid |
| 03 | Expiry Month missing or invalid |
| 04 | Expiry Year missing or invalid |
| 05 | Expiry Date is invalid |
| 06 | CVV missing or invalid |
| 07 | Card holder's Name missing or Credit Card Number missing |
| 08 | Token Missing |
| 09 | API Key is missing or invalid |
| 21 | Message contains words that have been identified as profanity and this message has been blocked due to company policy. Please try again. |
| 23 | Token does not exist |
| 26 | Potential duplicate transaction |
| UN | Unknown error, please contact an administrator |
| F | Your transaction is declined |
| 00 | Transaction entry is successful |