MercuryActivate 

Document created by chadb on May 10, 2016Last modified by chadb on Jun 1, 2016
Version 2Show Document
  • View in full screen mode

MercuryActivate is an enrollment service that enables merchants to apply to Vantiv Integrated Payments on the MercuryPay processing platform, through an online form. This shortens the enrollment time so that your merchants can start processing payments as quickly as possible. MercuryActivate offers especially fast turn-around times for enrollment types where details such as contract pricing have been pre-negotiated.

 

All personally identifiable information (PII), is encrypted on the backend, and is never returned, either in the responses or status queries. Only provisioned developer APIs have the ability to connect to our endpoint, and the connection is by request through encrypted SSL.

 

The MercuryActivate service is designed to be flexible so you can tailor the data collected to match your own sales process. There are three options for submitting a merchant lead:

A simple Lead submission with basic contact information. Once submitted, Mercury will contact the merchant and gather the information needed to turn the lead into an approved, processing merchant.

A Prospect submission that covers detailed financial information and gives immediate feedback on verification requirements, shortening the enrollment-to-processing time.

A “hybrid” submission that contains more than the basic information, but not all of the information defined as a Prospect.

 

MercuryActivate may be implemented as either a hosted web site for merchant enrollment, or as part of your POS software suite. In both cases the enrollments are routed through your site to Vantiv Integrated Payments.

 

Get a test API Key and password from Mercury

An API Key is required for a developer to communicate with the MercuryActivate service.  Each API Key is unique for that developer. It is also unique to the certification service used for testing. To obtain a certification API Key, contact integrationteam@vantiv.com

 

Build your RESTful format: JSON or XML

The RESTful API can pass messages that are either JSON-formatted or XML-formatted; the entry points are identical.

The message formatting is determined by the HTML headers passed to the service.  If you omit specific instructions for what type of message format you are using, the service will default to XML. 

 

  • With the XML style, the data elements must be maintained in the same order as listed in the documentation. Out of order elements will cause missed values. 
  • The JSON format is not picky about element order.

 

Using JSON

Setup

JSON formatted requests and responses are used over HTTPS for transaction processing.

 

Host

The base endpoint address for the RESTful MercuryActivate Service is https://activatebeta.mps-lab.com:8121/

 

Authentication

Authentication occurs via HTTP Basic Auth using an HTTP authorization header.

Username: existing MerchantID

Password: created and stored by Mercury

  1. Create string of [username]:[password]
  2. BASE64 encoded string
  3. Set Authorization header value to: “Basic [encoded string]”

 

Content-Type

Set Content-Type header value to: “application/json”

 

Submission and Status Addresses

All test transactions are posted to https://activatebeta.mps-lab.com:8121/ 

 

Description

 

 

Developer  ServerAddress

 

To submita Leador hybrid through an HTTP POST

 

https://activatebeta.mps-lab.com:8121/Lead/Submission

 

To submita Prospectthrough an HTTP POST

 

https://activatebeta.mps-lab.com:8121/QualifiedLead/Submission

 

To getthe statuson the application via an HTTP GET

 

https://activatebeta.mps-lab.com:8121/Application/Status/{id}

Where {id}is the integer representing the application ID returned from the submission.

 

Submission Messages: JSON examples

JSON example for a Lead submission (fields shown below are required)

{ 
  "OwnerFirstName":"Jenny", 
  "OwnerLastName":"Smith", 
  "OwnerEmail":"Jenny@HelpMe.com", 
  "DBAName":"What's For Dinner?", 
  "DBAPhone":"7192223333" 
} 

 

JSON example for a Prospect submission

{ 
  "OwnerTitle":"General Manager Store 5150", 
  "OwnerFirstName":"Gustavo", 
  "OwnerMiddleName":"Reyna", 
  "OwnerLastName":"Argo", 
  "OwnerSuffix":"PHD", 
  "OwnerDOBDay":10, 
  "OwnerDOBMonth":6, 
  "OwnerDOBYear":1985, 
  "OwnerSSN":"123456789", 
  "OwnerEmail":"grargo@HelpMe.com", 
  "OwnerAddress":"200 Main St", 
  "OwnerCity":"Denver", 
  "OwnerStateOrProvince":"CO", 
  "OwnerPostalCode":"80229", 
  "OwnerCountry":"US", 
  "DBAName":"What’s For Dinner?", 
  "DBAAddress":"100 Main St", 
  "DBACity":"Denver", 
  "DBAStateOrProvince":"CO", 
  "DBAPostalCode":"80229", 
  "DBACountry":"US", 
  "DBAPhone":"3031112222", 
  "DBAExtension":"1234", 
  "LegalName":"Zoom Dinner Inc", 
  "LegalAddress":"300 Main St", 
  "LegalCity":"Denver", 
  "LegalStateOrProvince":"CO", 
  "LegalPostalCode":"80229", 
  "LegalCountry":"US", 
  "LegalPhone":"3031113333", 
  "LegalExtension":"1122", 
  "ProductServiceSold":"Prepared Food", 
  "Market":"722210", 
  "SIC":"5812", 
  "TaxId":"123111234", 
  "AvgTicket":15.50, 
  "DailyVolume":4125.00, 
  "AnnualSalesVisaMc":1240000.00, 
  "CurrencyType":"USD", 
  "PercentRetailSwipedTransactions":80, 
  "PercentCardKeyedTransactions":10, 
  "PercentMailOrderTransactions":0, 
  "Dda":"123 4567 8900", 
  "Routing":"111222333", 
  "FinancialInstitutionName":"WellsFargo", 
  "IsChecking":true, 
  "FinancialInstitutionNumber":"111222333", 
  "OwnershipType"LLC, 
  "ReferenceString":"Admin@helpme.com" 
} 

 

Status Response Messages

The format of a successful status response message for the get lead status or get Prospect status calls is identical.

{ 
  "CmdStatus":"Success", 
  "TextResponse":"Submitted", 
  "ApplicationId": "0D9217A9-1559-437D-A1A6-6283215CAD44" 
} 

Attachments

    Outcomes