Shell Python Node.js Java PHP
« Go to main menu

Instant Activation APIs

POST Merchant/Activation

data = {
  "northMid": "323241562996",
  "merchantOrderId": "Joa1j"
}

endpoint = "/marketplace/v1/merchant/activation"

r = requests.post(url + endpoint, json=data, headers=headers)
print(r)

ENDPOINT="$URL/marketplace/v1/merchant/activation"
curl -X POST -H "date: $DATE" -H "Authorization: $HMAC_AUTH" -H "Content-Type:application/json" --data '{
  "northMid": "323241562996",
  "merchantOrderId": "Joa1j"
}' $ENDPOINT
var options = {
  method: 'POST',
  url: url + '/marketplace/v1/merchant/activation',
  headers: getAuthenticationHeaders(),
  body: {
    "northMid": "323241562996",
    "merchantOrderId": "Joa1j"
  },
  json: true
};

request(options, function (error, response, body) {
  if (error) throw new Error(error);
  console.log(response);
});
// Don't forget to add your HMAC Authorization Headers
try {
  String jsonString = "{\n" +
"    \"northMid\": \"323241562996\",\n" +
"    \"merchantOrderId\": \"Joa1j\"\n" +
"}";

  StringEntity payload = new StringEntity(jsonString);

  HttpResponse response = doPost("/marketplace/v1/merchant/activation", payload);
  int statusCode = response.getStatusLine().getStatusCode();
  String response_string = EntityUtils.toString(response.getEntity());
  JSONArray json = new JSONArray(response_string);  
  System.out.println("json:" + json.toString());

} catch (Exception e) {
  e.printStackTrace();
}

<?php
# Don't forget to add your HMAC Authorization Headers

$data = array (
  'northMid' => '323241562996',
  'merchantOrderId' => 'Joa1j',
)

$data_json = json_encode($data);
$headers = array(
    'date: ' . $date,
    'Authorization: ' . $hmacAuth,
    'Content-Type: application/json',
    'Content-Length: ' . strlen($data_json)
);

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url . "/marketplace/v1/merchant/activation");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_json);
$res = curl_exec($ch);
echo($res);

?>

The above command returns JSON structured like this:

[
   {
       "northMid": "323241562996",
       "nashVilleMid": "6653029",
       "processorContactName": "Tom Doe",
       "processorContactPhone": "(123)456-7890",
       "processorContactEmail": "processor@emailaddress.com",
       "dbaName": "Test Business Name",
       "dbaAddress1": "123 Main Street",
       "dbaCity": "SCHENECTADY",
       "dbaState": "NY",
       "dbaZip": "12345",
       "merchantPhone": "1234567890",
       "merchantEmail": "john.smith@emailaddress.com",
       "buyPassMID": "49253434",
       "merchantCategoryCode": "5964",
       "entitlements": [
           {
               "code": "18",
               "memberIdNumber": "000000044483030",
               "name": "Debit"
           }
       ],
       "terminalDetails": [
           {
               "productId": "56142",
               "terminalId": "12121212",
               "dataWireId": "123",
               "rapidConnectGroupId": "10001",
               "network": "NASHVILLE",
               "selfRegisteringInd": "N",
               "productName": "Auth.net Gateway (Payment Connection)"
           },
           {
               "productId": "56142",
               "terminalId": "245678",
               "dataWireId": "1234",
               "rapidConnectGroupId": "10001",
               "network": "NASHVILLE",
               "selfRegisteringInd": "N",
               "productName": "Auth.net Gateway (Payment Connection)"
           },
           {
               "productId": "56142",
               "terminalId": "4",
               "dataWireId": "1234",
               "rapidConnectGroupId": "10001",
               "network": "NASHVILLE",
               "selfRegisteringInd": "N",
               "productName": "Auth.net Gateway (Payment Connection)"
           },
           {
               "productId": "56142",
               "terminalId": "5",
               "dataWireId": "1234",
               "rapidConnectGroupId": "10001",
               "network": "NASHVILLE",
               "selfRegisteringInd": "N",
               "productName": "Auth.net Gateway (Payment Connection)"
           }
       ],
       "category": "RESTAURANT",
       "terminalReady": true,
       "connectivity": [
           {
               "connectivityCode": "SETTLE_ALTERNATE_PHONE",
               "connectivityDesc": "Settle Alternate Phone",
               "connectivityInfo": "800-453-0660"
           },
           {
               "connectivityCode": "AUTH_PRIMARY_PHONE",
               "connectivityDesc": "Authorization Primary Phone",
               "connectivityInfo": "800-453-0660"
           },
           {
               "connectivityCode": "PRIMARY_URL",
               "connectivityDesc": "Primary URL",
               "connectivityInfo": "https://vxn.datawire.net/sd"
           },
           {
               "connectivityCode": "SECONDARY_URL",
               "connectivityDesc": "Secondary URL",
               "connectivityInfo": "http://vxn1.datawire.net/sd"
           },
           {
               "connectivityCode": "AUTH_ALTERNATE_PHONE",
               "connectivityDesc": "Authorization Alternate Phone",
               "connectivityInfo": "800-253-2237"
           },
           {
               "connectivityCode": "SETTLE_PRIMARY_PHONE",
               "connectivityDesc": "Settle Primary Phone",
               "connectivityInfo": "800-253-2237"
           }
       ],
       "merchantContact": "JOHN DOE"
   }
]

This endpoint provides the technical specifications that need to be updated on your payment processing device to allow the merchant to start processing through First Data.

Request

POST /marketplace/v1/merchant/activation

The endpoint takes a JSON object as input, which contains following information.

Parameter Required Data Type Short Description
northMid string First Data North Platform unique merchant identifier.
merchantOrderId string The unique identifier of an order returned after successful submission. Used in following processes as input data.

Response

The endpoint returns an object containing information about the credit decision.

Parameter Data Type Description
northMid string Backend merchant identifier.
buyPassMid string First Data BuyPass Frontend merchant identifier.
nashVilleMid string First Data Nashville BuyPass merchant identifier.
processorContactName string Business consultant (sales person) name.
processorContactPhone string Business consultant (sales person) phone number.
processorContactEmail string Business consultant (sales person) email.
dbaName string DBA name.
dbaAddress1 string DBA street address.
dbaCity string DBA city.
dbaState string DBA state.
dbaZip string DBA ZIP/Postal code.
merchantPhone string Merchant phone number.
merchantEmail string Merchant email address.
merchantContact string Merchant contact name.
merchantCategoryCode string Merchant MCC Code. The MCC is assigned by the acquiring financial institution when a merchant initially begins accepting credit cards. (refer to: GET MCC/Category).
category string Business category, eg: "RETAIL/MOTO" (refer to: GET Categories).
terminalReady boolean If terminals ready for transaction.
entitlements array Array of objects, each representing entitlements/payment card types.
code string Unique entitlement code/identifier.
memberIdNumber string Service establishment number of entitlement.
name string Entitlement name eg: "Visa", "MasterCard", "Debit" etc.
terminalDetails array Array of objects, each representing merchant terminal details.
productId string productId as string. Numeric value that uniquely identifies each product (canonical identifier).
terminalId string Identifier assigned by the First Data payment processing platform for each terminal.
dataWireId string Datawire Identifier.
rapidConnectGroupId string Rapid Connect Group ID.
network string First Data payment network name eg: "Nashville", "CardNet", "BuyPass".
selfRegisteringInd string Self Registering Indicator.
productName string Name of product to be used in the user interface.
connectivity array Array of objects, each representing support details.
connectivityCode string Connectivity type eg: "SETTLE_ALTERNATE_PHONE", "AUTH_PRIMARY_PHONE", "PRIMARY_URL", "SECONDARY_URL", "AUTH_ALTERNATE_PHONE", "SETTLE_PRIMARY_PHONE"
connectivityDesc string Connectivity Description eg: "Settle Alternate Phone", "Authorization Primary Phone", "Primary URL", "Secondary URL", "Authorization Alternate Phone", "Settle Primary Phone".
connectivityInfo string Connectivity Information: phone, email or website.