Merchant Service Depot Developer Hub

https://www.merchantservicedepot.com/developers/
Admin
Merchant Service Depot provides payment processing APIs, integrations with eCommerce platforms, and...
Tokens:20,397
Snippets:67
Trust Score:6
Update:10 months ago
Show doc for...
Tokens:
Raw
### Magento Installation and Setup Commands

Source: https://www.merchantservicedepot.com/developers/index

Commands required to install and configure the MSD payment gateway extension in Magento. This includes upgrading the setup, deploying static content, and cleaning the cache. Ensure to run these from the Magento root directory.

```bash
php bin/magento setup:upgrade
php bin/magento setup:static-content:deploy
php bin/magento cache:clean
```

--------------------------------

### Apple Pay Integration - Setup

Source: https://www.merchantservicedepot.com/developers/credit-card

Instructions for setting up Apple Pay, including domain verification and script inclusion.

```APIDOC
## Domain Verification

MSD will provide an `apple-developer-merchantid-domain-association.txt` file. This file must be uploaded to a folder named `/.well-known/` at the document root of your web server to verify the domain.

## Include applePay.js Script

Copy and paste the following lines to your HTML page to enable Apple Pay functionality:

### Request Example
```html
<script type="text/javascript" src="https://[server-name]/services/applePay.js"></script>
```
```

--------------------------------

### Capture API Form Example

Source: https://www.merchantservicedepot.com/developers/credit-card

This HTML form illustrates how to initiate a capture transaction using the Capture API. It requires the transaction ID, amount, and optionally an email receipt preference.

```html
<form name="" action="https://portal.merchantservicedepot.com/apis/capture.php" method="post">
    <input type="text" name="username" value=" msdusername"/>
    <input type="text" name="api_key" value=" msdapikey"/>
    <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>
```

--------------------------------

### Authorize API Form Example

Source: https://www.merchantservicedepot.com/developers/credit-card

This HTML form demonstrates how to use the Authorize API to process a credit card transaction. It includes fields for essential payment details and a JavaScript callback for handling responses.

```html
<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="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="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="abcdef@mail.com"/>
  <input type="checkbox" name="email_receipt"  value="Y"/>
  <br/>
  <input type="button" value="submit" onClick="MSDProxynizationAPI.process('#creditcard_number','msdClientCallback');" />
</form>
<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>
```

--------------------------------

### Authorize API Form Example (HTML)

Source: https://www.merchantservicedepot.com/developers/credit-card

An HTML form demonstrating how to submit data to the Authorize API. It includes input fields for user credentials, credit card details, and transaction amount. The form utilizes a JavaScript callback function for processing the credit card number through a proxy.

```html
<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="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="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="abcdef@mail.com"/>
  <input type="checkbox" name="email_receipt"  value="Y"/>
  <br/>
  <input type="button" value="submit" onClick="MSDProxynizationAPI.process('#creditcard_number','msdClientCallback');" />
</form>

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

--------------------------------

### Unreferenced Refund Form and Callback Handling (HTML, JavaScript)

Source: https://www.merchantservicedepot.com/developers/credit-card

This example shows a complete HTML form for performing an unreferenced refund and the associated JavaScript callback function. The form includes fields for transaction details and authentication. The `MSDClientCallback` function handles the API response, either submitting the refund with the proxynized card number or displaying an error message.

```html
<form name="" id="formID" action="https://portal.merchantservicedepot.com/apis/unreference_refund.php" method="post">
    <input type="text" name="username" value="msdusername"/>
    <input type="text" name="api_key" value="msdapikey"/>
    <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="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="abcdef@mail.com"/>
    <input type="checkbox" name="email_receipt"  value="Y"/>
    <br/>
    <input type="button" value="submit" onClick="MSDProxynizationAPI.process('#creditcard_number','msdClientCallback');" />
</form>
<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>
```

--------------------------------

### Report API: Generate Transaction Report

Source: https://www.merchantservicedepot.com/developers/credit-card

This API is designed to generate transaction reports. It requires authentication and specifies a date range (start and end dates). Optional parameters allow filtering by transaction type, status, ID, and pagination.

```html
<form name="" action="https://portal.merchantservicedepot.com/apis/report.php" method="post">
    <input type="text" name="username" value="msdusername"/>
    <input type="text" name="api_key" value="msdapikey"/>
    <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>
```

--------------------------------

### Authorize API Sample Response

Source: https://www.merchantservicedepot.com/developers/credit-card

This JSON object represents a sample response from the Authorize API. It includes a 'response' object with 'code' and 'description' fields, indicating the outcome of the transaction.

```json
{"response":{"code":"01","description":" Merchant Information is Missing"}}
```

--------------------------------

### Sample API Success Response (JSON)

Source: https://www.merchantservicedepot.com/developers/credit-card

This is a sample JSON response structure for a successful transaction with the Merchant Service Depot API. It includes a response code, transaction ID, amount, and a descriptive message.

```json
{"response":{"code":"00", "transaction_id":102, "amount":4.5, "description":" Your transaction is approved."}}
```

--------------------------------

### Proxynization API JavaScript Integration (Sandbox)

Source: https://www.merchantservicedepot.com/developers/credit-card

This snippet demonstrates how to integrate the Proxynization API using JavaScript. It involves including the script file, defining a callback function to handle responses, and calling the processing function within a form's submit action.

```html
<script type="text/javascript" src="https://gateway2-stg.merchantservicedepot.com/services/proxynization_api.js"></script>
<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>

<form id="formID">
  <input type="text" id="creditcard_number" name="creditcard_number">
  <input type="button" value="submit" onClick="MSDProxynizationAPI.process('#creditcard_number','MSDClientCallback');" />
</form>
```

--------------------------------

### Display Apple Pay Button and Handle Payment

Source: https://www.merchantservicedepot.com/developers/credit-card

This snippet demonstrates how to display an Apple Pay button using HTML and CSS, and how to trigger the payment process via JavaScript. It includes the structure for the button and the JavaScript functions to initiate the payment request and handle the response.

```css
/* CSS */
#applePay {  
    width: 150px;  
    height: 50px;  
    display: none;   
    border-radius: 5px;    
    margin-left: auto;
    margin-right: auto;
    margin-top: 20px;
    background-image: -webkit-named-image(apple-pay-logo-white); 
    background-position: 50% 50%;
    background-color: black;
    background-size: 60%; 
    background-repeat: no-repeat;  
}
```

```html
/* HTML */
<button type="button" id="applePay" onclick="callPayment()"></button>
```

```javascript
<script type="text/javascript" >
  function callPayment()
  {
      var amount=document.getElementById("amount").value;
      var currency=document.getElementById("currency").value;
      var app_key="b0cf87c7e314af8638ce34732f1f7d24";
      var business_name="Test shop";

      msdApplePay.paymentRequest(app_key,business_name,amount,currency);
  }

  msdApplePay.paymentResponse=function(responseStatus,responseText){
      if(responseStatus=="S")
      {
          document.getElementById('signature_token').value = responseText;
          document.getElementById("formID").submit();
      }else{
          alert(responseText);
      }
  }

</script>
```

--------------------------------

### Proxynization API JavaScript Integration (Production)

Source: https://www.merchantservicedepot.com/developers/credit-card

This snippet demonstrates how to integrate the Proxynization API using JavaScript in a production environment. It involves including the script file, defining a callback function to handle responses, and calling the processing function within a form's submit action.

```html
<script type="text/javascript" src="https://portal.merchantservicedepot.com/services/proxynization_api.js"></script>
<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>

<form id="formID">
  <input type="text" id="creditcard_number" name="creditcard_number">
  <input type="button" value="submit" onClick="MSDProxynizationAPI.process('#creditcard_number','MSDClientCallback');" />
</form>
```

--------------------------------

### Apple Pay Integration - Request and Response Functions

Source: https://www.merchantservicedepot.com/developers/credit-card

Details on implementing the `msdApplePay.paymentRequest` and `msdApplePay.paymentResponse` functions for handling Apple Pay transactions.

```APIDOC
## Implement Request and Response Functions

### `msdApplePay.paymentRequest(app_key, business_name, amount, currency)`

This function is called when the Apple Pay button is clicked. It initiates the payment request.

**Parameters:**
- `app_key` (string) - Required - MD5 hash of MSD Gateway Username and 16-digit Secret key.
- `business_name` (string) - Required - The name to display in the Apple Pay window.
- `amount` (number) - Required - The amount to be charged.
- `currency` (string) - Required - The currency of the transaction (e.g., "USD").

### `msdApplePay.paymentResponse(responseStatus, responseText)`

This function is invoked once the Apple Pay response is returned from the system.

**Parameters:**
- `responseStatus` (string) - Indicates success ('S') or failure.
- `responseText` (string) - Contains details of the response, used as input for the `apple_sale.php` API.

### Request Example
```javascript
function callPayment() {
    var amount = document.getElementById("amount").value;
    var currency = document.getElementById("currency").value;
    var app_key = "b0cf87c7e314af8638ce34732f1f7d24"; // Example app_key
    var business_name = "Test shop";

    msdApplePay.paymentRequest(app_key, business_name, amount, currency);
}

msdApplePay.paymentResponse = function(responseStatus, responseText) {
    if (responseStatus === "S") {
        document.getElementById('signature_token').value = responseText;
        document.getElementById("formID").submit();
    } else {
        alert(responseText);
    }
};
```
```

--------------------------------

### Proxynization APIs

Source: https://www.merchantservicedepot.com/developers/credit-card

These APIs facilitate data proxynization by including a script file and implementing a callback function to handle responses.

```APIDOC
## Proxynization API

### Description
This API provides a script to enable proxynization functionality within your application. It involves including a JavaScript file, implementing a callback function, and integrating a proxynization call into your payment form's submit action.

### Sandbox URL
https://gateway2-stg.merchantservicedepot.com/services/proxynization_api.js

### Production URL
https://portal.merchantservicedepot.com/services/proxynization_api.js

### Usage
1.  **Include the script file:**
    ```html
    <script type="text/javascript" src="https://[server-name]/services/proxynization_api.js"></script>
    ```

2.  **Implement the callback function:** This function is invoked when a proxynization response is returned.
    ```javascript
    function MSDClientCallback(responseCode, responseMessage, proxyNumber){
        if(responseCode == "A01"){
            document.getElementById('creditcard_number').value = proxyNumber;
            document.getElementById("formID").submit();
        } else{
        alert(responseMessage);
            return false;
        }
    }
    ```

3.  **Design your payment form and implement the proxynization call:**
    -   The first parameter can be the credit card number or the ID of the credit card number field (prefixed with '#').
    -   The second parameter is the name of the callback function.
    ```javascript
    // Example form submission with proxynization call
    document.getElementById("formID").addEventListener("submit", function(event) {
        event.preventDefault(); // Prevent default form submission
        var creditCardNumberField = "#creditcard_number"; // or the actual card number
        var callbackFunctionName = "MSDClientCallback";
        
        // Assuming a global function exists to initiate proxynization
        // The actual function name might vary based on the proxynization_api.js implementation
        if (typeof InitiateProxynization === 'function') {
            InitiateProxynization(creditCardNumberField, callbackFunctionName);
        } else {
            alert("Proxynization script not loaded properly.");
        }
    });
    ```
```

--------------------------------

### Credit Card Sale API Integration (Sandbox)

Source: https://www.merchantservicedepot.com/developers/credit-card

This API is used to create new payment transactions for encrypted and plain credit card methods. The sandbox endpoint is provided for testing purposes. The method of form submission is POST.

```html
<form action="https://gateway2-stg.merchantservicedepot.com/apis/sale.php" method="POST">
  <input type="text" name="credit_card_number" placeholder="Credit Card Number">
  <input type="text" name="expiry_date" placeholder="Expiry Date (MM/YY)">
  <input type="text" name="cvv" placeholder="CVV">
  <input type="text" name="amount" placeholder="Amount">
  <button type="submit">Process Sale</button>
</form>
```

--------------------------------

### Authorize API - Parameters

Source: https://www.merchantservicedepot.com/developers/credit-card

Describes the parameters required for the Authorize API, used after a successful Apple Pay payment response.

```APIDOC
## Authorize API Parameters

This API is used to authorize a transaction after receiving a successful response from Apple Pay.

### Parameters

| Variable Name   | Description                                         | Required | Expected Values                                                                                                                                                                                                                                                              |
|-----------------|-----------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `username`      | MSD Gateway Username                                | Y        | MSD Gateway Username                                                                                                                                                                                                                                                         |
| `api_key`       | MSD Gateway API Key                                 | Y        | MSD Gateway API Key                                                                                                                                                                                                                                                          |
| `signature_token` | Token obtained from `TCBPayApplePay.paymentResponse` | Y        | `{"identifyKey":"test","data":"test","ephemeralPublicKey":"test","publicKeyHash":"test","transactionId":"test","signature":"test","version":"EC_v1","displayName":"MasterCard 1111","network":"MasterCard","type":"credit"}` |
| `company_name`  | Company Name of the cardholder                      | N        | -                                                                                                                                                                                                                                                                            |
| `first_name`    | First name of the cardholder                        | Y        | Roberto                                                                                                                                                                                                                                                                      |
| `last_name`     | Last name of the cardholder                         | Y        | Diaz                                                                                                                                                                                                                                                                         |
| `address`       | Address of the cardholder                           | N        | 4446 Green Avenue, Suite 56                                                                                                                                                                                                                                                  |
| `city`          | City of the cardholder                              | N        | Los Angeles                                                                                                                                                                                                                                                                  |
| `state`         | State of the cardholder                             | N        | CA                                                                                                                                                                                                                                                                           |
| `country_code`  | Country of the cardholder (ISO alpha-2)             | Y        | US, CN                                                                                                                                                                                                                                                                       |
```

--------------------------------

### Apple Pay Integration - Button Display

Source: https://www.merchantservicedepot.com/developers/credit-card

How to display an Apple Pay button and style it using CSS.

```APIDOC
## Display an Apple Pay Button

Use the following CSS and HTML to display an Apple Pay button. You can customize the style and locale.

### Request Example
```html
<style>
#applePay {
    width: 150px;
    height: 50px;
    display: none;
    border-radius: 5px;
    margin-left: auto;
    margin-right: auto;
    margin-top: 20px;
    background-image: -webkit-named-image(apple-pay-logo-white);
    background-position: 50% 50%;
    background-color: black;
    background-size: 60%;
    background-repeat: no-repeat;
}
</style>

<button type="button" id="applePay" onclick="callPayment()"></button>
```
```

--------------------------------

### Include Proxynization API Script

Source: https://www.merchantservicedepot.com/developers/credit-card

HTML snippet to include the Proxynization API JavaScript file. This script enables proxynization functionality on the merchant's website. The 'server-name' should be replaced with the actual server domain.

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

--------------------------------

### Refund API: Process Refund Request

Source: https://www.merchantservicedepot.com/developers/credit-card

This API facilitates the refunding of an existing successful transaction. It requires authentication, the transaction ID, and the refund amount. An option to send an email receipt is also available.

```html
<form name="" action="https://portal.merchantservicedepot.com/apis/refund.php" method="post">
    <input type="text" name="username" value=" msdusername"/>
    <input type="text" name="api_key" value=" msdapikey"/>
    <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>
```

--------------------------------

### Process POST Configuration Arrays

Source: https://www.merchantservicedepot.com/developers/index

This PHP code snippet handles iterating through POST variables for configuration settings, specifically converting array values to comma-separated strings. It's often used when processing form submissions for module configurations.

```php
while (list($key, $value) = each($HTTP_POST_VARS['configuration'])) {
    if (is_array($value)) $value = implode(',', $value);
}
```

--------------------------------

### API Response Structure (JSON)

Source: https://www.merchantservicedepot.com/developers/credit-card

Demonstrates the JSON structure for API responses. It shows formats for both successful transactions and errors. Successful responses include transaction details, while error responses provide a code and description.

```json
{"response":{"code":"00","description":" Transaction Entry Success","transaction_id":102," total_amount":15.7," convenience_fee":1.2}}
```

```json
{"response":{"code":"00","description":"Transaction pending cardholder authentication","transaction_id":102,"redirect_url":"https://[server-name]/challenge_request.php?uid=xxxxxxxxx"}}
```

--------------------------------

### Proxynization Callback Function Implementation (JavaScript)

Source: https://www.merchantservicedepot.com/developers/credit-card

This JavaScript code defines the MSDClientCallback function, which is invoked when the proxynization response is returned. It handles success by populating the credit card number and submitting the form, or displays an error message upon failure.

```javascript
function MSDClientCallback(responseCode, responseMessage, proxyNumber){

    if(responseCode == "A01"){
        document.getElementById('creditcard_number').value = proxyNumber;
        document.getElementById("formID").submit();
    } else{
    alert(responseMessage);
        return false;
    }
}
```

--------------------------------

### Authorize API

Source: https://www.merchantservicedepot.com/developers/credit-card

This API performs pre-authorization payments and supports both encrypted and plain credit card transactions.

```APIDOC
## POST /authorize.php

### Description
This endpoint is used to perform pre-authorization of payments. It is compatible with both encrypted and plain credit card methods.

### Method
POST

### Endpoint
https://gateway2-stg.merchantservicedepot.com/apis/authorize.php (Staging)
https://portal.merchantservicedepot.com/apis/authorize.php (Production)

### Parameters
(Specific request parameters for this endpoint are not detailed in the provided text but would typically include card details, amount, currency, etc.)

### Request Example
```html
<form action="https://gateway2-stg.merchantservicedepot.com/apis/authorize.php" method="post">
  <!-- Include relevant payment details here -->
  <button type="submit">Authorize Payment</button>
</form>
```

### Response
(Specific response structure for this endpoint is not detailed in the provided text but would typically include transaction status, authorization codes, etc.)
```

--------------------------------

### Apple Pay Integration Form and Script

Source: https://www.merchantservicedepot.com/developers/credit-card

HTML form and JavaScript for initiating an Apple Pay transaction. The form collects user and transaction details, and the script uses the msdApplePay API to request payment and handle the response, submitting the form upon successful payment authorization.

```html
<form name="" id="formID" action="https://portal.merchantservicedepot.com/apis/apple_sale.php" method="post">
  <input type="text" name="username" value="msdusername"/>
  <input type="text" name="api_key" value="msdapikey"/>
  <input type="text" name="signature_token" id="signature_token" value="{"identifyKey":"test","data":"test","ephemeralPublicKey":"test","publicKeyHash":"test","transactionId":"test","signature":"test","version":"EC_v1","displayName":"MasterCard 1111","network":"MasterCard","type":"credit"}"/>
  <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="abcdef@mail.com"/>
  <input type="checkbox" name="email_receipt"  value="Y"/>
  <br/>
  <button type="button" id="applePay" onclick="callPayment()"></button> 
</form>
<script type="text/javascript" >
  function callPayment()
  {
    var amount=document.getElementById("amount").value;
    var currency=document.getElementById("currency").value;
    var app_key="b0cf87c7e314af8638ce34732f1f7d24";
    var business_name="Test shop";

    msdApplePay.paymentRequest(app_key,business_name,amount,currency);
  }

  msdApplePay.paymentResponse=function(responseStatus,responseText){
    if(responseStatus=="S")
    {
      document.getElementById('signature_token').value = responseText;
      document.getElementById("formID").submit();
    }else{
      alert(responseText);
    }
  }
</script>
```

--------------------------------

### Proxynization API

Source: https://www.merchantservicedepot.com/developers/credit-card

This API provides a JavaScript file to enable proxynization functionality, which handles sensitive card details before form submission.

```APIDOC
## Proxynization API Script

### Description
This API involves including a JavaScript file that facilitates secure handling of credit card information before it's submitted to the main payment gateway. It uses a callback function to return proxynized data.

### Script Inclusion
1. Include the proxynization_api.js script file in your HTML page.

### Request Example (Script Inclusion)
```html
<script type="text/javascript" src="https://[server-name]/services/proxynization_api.js"></script>
```

### Callback Function Implementation
2. Implement a callback function that will be invoked with the proxynization response.

### Example (Callback Function)
```javascript
function MSDClientCallback(responseCode, responseMessage, proxyNumber){
  if(responseCode == "A01"){
    document.getElementById('creditcard_number').value = proxyNumber;
    document.getElementById("formID").submit();
  } else{
    alert(responseMessage);
    return false;
  }
}
```

### Form Integration
3. Design your payment form and insert a proxynization call within the form's submit action.

#### Parameter Rules:
- The first parameter can be the credit card number itself or the ID of the credit card number field (prefixed with '#').
- The second parameter is the name of the callback function.

### Example (Form Integration)
```html
<input type="button" value="submit"  onClick="MSDProxynizationAPI.process('#creditcard_number','msdClientCallback');" />
```

### Endpoints
- **Sandbox:** `https://gateway2-stg.merchantservicedepot.com/services/proxynization_api.js`
- **Production:** `https://portal.merchantservicedepot.com/services/proxynization_api.js`
```

--------------------------------

### Apple Pay API

Source: https://www.merchantservicedepot.com/developers/credit-card

This API facilitates creating new payment transactions using Apple Pay. It involves a three-step process: calling JavaScript, displaying the Apple Pay button, and sending the response to the processing API.

```APIDOC
## Apple Pay API

### Description
This API is responsible for creating new payment transactions using Apple Pay. Integrating Apple Pay involves a three-step process: calling the JavaScript, displaying the Apple Pay button, and then sending the response to the processing API.

### Method
POST

### Endpoint
https://gateway2-stg.merchantservicedepot.com/apis/apple_sale.php

### Parameters
*Integration involves using provided JavaScript files (`applePaySandbox.js` for sandbox, and a production equivalent) and a form submission.
Specific parameters for the `apple_sale.php` endpoint are not detailed here but would typically include Apple Pay token and transaction details.

### Request Example
*This section would typically detail the request format, often involving a JSON payload containing the Apple Pay token and other transaction data.* 

### Response
*The response structure for Apple Pay transactions is not explicitly detailed in the provided text but would follow similar patterns to the Authorize API, indicating success or failure, and potentially including transaction IDs or redirect URLs for further authentication.

#### Success Response
* A successful response would typically include a transaction ID and confirmation of the payment.

#### Error Response
* An error response would include an error code and a descriptive message.

### Response Example (Success)
*Example response structure similar to the Authorize API, but specific to Apple Pay transactions.* 
```json
{
  "response": {
    "code": "00",
    "description": "Apple Pay Transaction Successful",
    "transaction_id": 54321
  }
}
```

### Response Example (Error)
```json
{
  "response": {
    "code": "E101",
    "description": "Apple Pay Payment Failed."
  }
}
```
```

--------------------------------

### Refund API

Source: https://www.merchantservicedepot.com/developers/credit-card

The Refund API allows you to refund an existing successful transaction. It requires authentication, the transaction ID, and the refund amount. An optional email receipt can be sent.

```APIDOC
## POST /apis/refund.php

### Description
This API is responsible for refunding an existing successful transaction.

### Method
POST

### Endpoint
https://gateway2-stg.merchantservicedepot.com/apis/refund.php

### Parameters
#### Request Body
- **username** (string) - Required - MSD Gateway Username
- **api_key** (string) - Required - MSD Gateway API Key
- **transaction_id** (string) - Required - Unique transaction ID generated by gateway
- **amount** (number) - Required - Amount to be charged, less than or equal to the original transaction amount
- **email_receipt** (string) - Optional - Send transaction details to the specified email. Expected values: Y or N (default value N).

### Request Example
```json
{
  "username": "msdusername",
  "api_key": "msdapikey",
  "transaction_id": "",
  "amount": 14.50,
  "email_receipt": "N"
}
```

### Response
#### Success Response (00)
- **code** (string) - Response code (00 for success)
- **description** (string) - Success message
- **transaction_id** (string) - The ID of the refunded transaction

#### Error Response
- **code** (string) - Error code
- **description** (string) - Error message

#### Response Example (Success)
```json
{
  "response": {
    "code": "00",
    "description": "Refund successful",
    "transaction_id": "123456789"
  }
}
```

#### Response Example (Error)
```json
{
  "response": {
    "code": "01",
    "description": "Merchant Information is Missing"
  }
}
```
```

--------------------------------

### Proxynization API Button Integration

Source: https://www.merchantservicedepot.com/developers/credit-card

HTML input button that triggers the Proxynization API processing. The 'onClick' event calls 'MSDProxynizationAPI.process', passing the credit card number field ID (prefixed with '#') and the callback function name.

```html
<input type="button" value="submit"  onClick="MSDProxynizationAPI.process('#creditcard_number','msdClientCallback');" />
```

--------------------------------

### Proxynization API Integration

Source: https://www.merchantservicedepot.com/developers/credit-card

Integrate the Proxynization API to securely handle credit card information within your forms. This involves including a script, implementing a callback function, and configuring your form's submit action.

```APIDOC
## Proxynization API Integration

### Description
This guide explains how to integrate the Proxynization API script into your HTML page to enable secure handling of credit card details. It involves including the script, defining a callback function to process the response, and modifying your form's submit action to call the proxynization function.

### Method
(N/A - This is a client-side JavaScript integration)

### Endpoint
Sandbox: `https://gateway2-stg.merchantservicedepot.com/services/proxynization_api.js`
Production: `https://portal.merchantservicedepot.com/services/proxynization_api.js`

### Parameters

#### Step 1: Include Script File
Paste the following line into your HTML page:
```html
<script type="text/javascript" src="https://[server-name]/services/proxynization_api.js"></script>
```
Replace `[server-name]` with the appropriate sandbox or production server name.

#### Step 2: Implement Callback Function
Define a JavaScript function that will be invoked with the proxynization response. This function receives `responseCode`, `responseMessage`, and `proxyNumber` as arguments.

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

#### Step 3: Design Payment Form and Implement Proxynization Call
In your form's submit action, call the `MSDProxynizationAPI.process()` function.

- The first parameter can be the credit card number value or the ID of the credit card number field (prefixed with '#').
- The second parameter is the name of your callback function.

**Example:**
```html
<input type="button" value="submit" onClick="MSDProxynizationAPI.process('#creditcard_number','MSDClientCallback');" />
```
```

--------------------------------

### Include Apple Pay JavaScript Library

Source: https://www.merchantservicedepot.com/developers/credit-card

Include the applePay.js script file in your HTML to enable Apple Pay functionality. This script is provided by Merchantservicedepot.

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

--------------------------------

### Proxynization Callback Function Implementation

Source: https://www.merchantservicedepot.com/developers/credit-card

JavaScript function to handle the response from the Proxynization API. It checks the response code; if successful ('A01'), it populates the credit card number field and submits the form. Otherwise, it displays an alert with the error message.

```javascript
function MSDClientCallback(responseCode, responseMessage, proxyNumber){

  if(responseCode == "A01"){
  document.getElementById('creditcard_number').value = proxyNumber;
  document.getElementById("formID").submit();
  } else{
  alert(responseMessage);
  return false;
  }
  }
```

--------------------------------

### Credit Card Sale API

Source: https://www.merchantservicedepot.com/developers/credit-card

This API is responsible for creating new payment transactions and is compatible with both encrypted and plain credit card methods.

```APIDOC
## POST /apis/sale.php

### Description
This API endpoint is used to create new payment transactions. It supports both encrypted and plain credit card transaction methods.

### Method
POST

### Endpoint
Sandbox: `https://gateway2-stg.merchantservicedepot.com/apis/sale.php`
Production: `https://portal.merchantservicedepot.com/apis/sale.php`

### Parameters

#### Request Body
(Specific request body parameters are not detailed in the provided text, but would typically include payment details like card number, expiry, amount, etc.)

### Request Example
(No specific request example provided in the text.)

### Response
#### Success Response (200)
(Specific success response fields are not detailed in the provided text, but would typically include transaction status and details.)

#### Response Example
(No specific response example provided in the text.)
```

--------------------------------

### Unreferenced Refund API

Source: https://www.merchantservicedepot.com/developers/credit-card

This API is responsible for creating new payment transactions. It is compatible with both encrypted and plain credit card methods.

```APIDOC
## POST /apis/unreference_refund.php

### Description
This endpoint is used to create new payment transactions using either encrypted or plain credit card details.

### Method
POST

### Endpoint
https://gateway2-stg.merchantservicedepot.com/apis/unreference_refund.php

### Request Body
This endpoint expects transaction details in the request body. Please refer to the sample response for expected fields and structure.

### Request Example
```json
{
    "card_number": "************1234",
    "expiry_date": "12/25",
    "amount": "100.00",
    "currency": "USD",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com"
}
```

### Response
#### Success Response (200)
- **response** (object) - Contains transaction details.
  - **code** (string) - "00" for success.
  - **description** (string) - Success message.
  - **no_of_transactions** (string) - Number of transactions.
  - **total_pages** (integer) - Total number of pages for transactions.
  - **current_page** (string) - Current page number.
  - **transactions** (array) - Array of transaction objects.

#### Error Response
- **response** (object) - Contains error details.
  - **code** (string) - Error code (e.g., "01", "02").
  - **description** (string) - Error message.

#### Response Example
```json
{
    "response": {
        "code": "00",
        "description": "success",
        "no_of_transactions": "450",
        "total_pages": 5,
        "current_page": "1",
        "transactions": [
            {
                "transaction_id": "100000000000001605",
                "parent_transaction_id": "",
                "transaction_type": "SALE",
                "transaction_source": "Moto",
                "initiated_by": "System User",
                "transaction_status": "SUCCESS",
                "decline_reason": "",
                "transaction_time": "2021-08-17 03:10:50",
                "time_zone": "America/Caracas",
                "gmt_time": "2021-08-17 07:10:50",
                "card_type": "MASTERCARD",
                "3d_secure_transaction": "NO",
                "credit_card_number": "************2205",
                "card_expiry_date": "12/2025",
                "auth_response_code": "Success",
                "avs_response_code": "Z",
                "avs_response": "Not Matched",
                "cvv_response_code": "M",
                "cvv_response": "Matched",
                "error_response": "Approved",
                "currency": "USD",
                "total_amount": "2",
                "amount": "2",
                "surcharge": "0",
                "tax": "0",
                "tip": "0",
                "first_name": "Tanmoy",
                "last_name": "Mondal",
                "company_name": "",
                "address_1": "802 E Frierson Ave",
                "address_2": "",
                "city": "TAMPA",
                "state": "FL",
                "zip_code": "33606",
                "email": "tanumondal@gmail.com",
                "phone_no": "",
                "subscription_id": "",
                "is_risk_hold": "NO",
                "IP": "192.168.0.93",
                "reference_id": ""
            }
        ]
    }
}
```
```
Tokens:
Raw