Mercury Network Outbound Integration Guide


Introduction

Mercury Network is a platform used by Lenders and Appraisal Management Companies to manage their vendor workflow process from a cloud‑based platform in compliance with UMDP, appraisal independence standards, and security regulations.  Mercury Network is not an Appraisal Management Company, but rather a technology provider for AMCs and lenders.

This guide will provide technical details for integrating your platform with Mercury Network to receive orders, and to send and receive updates or documents, including the completed appraisal report and other supporting documents.


  TOTAL XML

TOTAL XML is a proprietary form of XML (Extensible Markup Language) created by a la mode, inc. and is used throughout its product lineup as a common way to communicate between products and with our Integration Partners.

Back to top


Receiving Orders

When a client submits an order request, Mercury Network generates the Order XML for the new order.  Mercury Network then routes the order request to a Web service hosted by the Integration Partner.  A confirmation receipt is required from the Integration Partner that will come in the form of an ACK (successful) or a NACK (not successful).

New orders are placed in a status of Awaiting Acceptance.  Each Integration Partner can be configured to automatically accept the order upon receipt of the ACK or they can send back the Order Acceptance via a post to our Web service.

The request will consist of the Username and Password for the Web service, and an XMLPost containing the order data.  In addition to the basic order data, the XMLPost can contain base64 encoded documents, such as sales contracts, deeds, or anything else that the client needs to send to the Integration Partner.

Back to top

Sample Request:

<MNRequest>
  <UserName>string​</UserName>
  <Password>string​</Password>
  <XMLPost>string​</XMLPost>
</MNRequest>

Back to top

Sample XMLPost:

<REPORT xmlns:xsi= "http://​www.w3.org/​2001/​XMLSchema‑instance" DESCRIPTION="TestOrder" FILENUM="1234">
  <TRACKING>
    <CLIENTID>​123456​</CLIENTID>
    <TRACKINGID>984572​</TRACKINGID>
    <CARDNUMBER>​4444********4444​</CARDNUMBER>
    <CARDEXPMONTH>​12​</CARDEXPMONTH>
    <CARDEXPYEAR>​2012​</CARDEXPYEAR>
    <CARDHOLDERFIRSTNAME>​FirstName​</CARDHOLDERFIRSTNAME>
    <CARDHOLDERMIDDLENAME>​Middle​</CARDHOLDERMIDDLENAME>
    <CARDHOLDERLASTNAME>​LastName​</CARDHOLDERLASTNAME>
    <CARDHOLDERADDRESS>​100 Card Holder Address​</CARDHOLDERADDRESS>
    <CARDHOLDERCITY>​Card City​</CARDHOLDERCITY>
    <CARDHOLDERSTATE>​OK​</CARDHOLDERSTATE>
    <CARDHOLDERZIP>​73134​</CARDHOLDERZIP>
    <CARDHOLDEREMAIL>​cardholderemail@cwlogin.info​</CARDHOLDEREMAIL>
    <PAYMENTMETHOD>​CREDIT CARD​</PAYMENTMETHOD>
    <PLUGINREQUIRED>​True​</PLUGINREQUIRED>
    <ENVREQUIRED>​False​</ENVREQUIRED>
  </TRACKING>
  <FORMS>
    <FORM FORMCODE="ORD" DESC="OrderForm">
      <FIELDS>
        <LOAN_TYPE>​Conventional​</LOAN_TYPE>
        <LOAN_PURPOSE>​PURCHASE​</LOAN_PURPOSE>
        <LENDERCASENUMBER>​123456​</LENDERCASENUMBER>
        <SUBLENCLIENT>​Mercury Lending​</SUBLENCLIENT>
        <LENDERADDRESS1>​3705 W Memorial RD​</LENDERADDRESS1>
        <LENDERADDRESS2>​Building 402​</LENDERADDRESS2>
        <LENDERCITY>​Oklahoma City​</LENDERCITY>
        <LENDERSTATE>​OK​</LENDERSTATE>
        <LENDERZIP>​73134​</LENDERZIP>
        <SUBBORROWER>​John Doe​</SUBBORROWER>
        <BORROWERCONTACTTYPE1>​EMAIL​</BORROWERCONTACTTYPE1>
        <BORROWERCONTACT1>​John.Doe@cwlogin.info​</BORROWERCONTACT1>
        <BORROWERCONTACTTYPE2>​WORK​</BORROWERCONTACTTYPE2>
        <BORROWERCONTACT2>​8002526633​</BORROWERCONTACT2>
        <SUBSALEPRICE>​100000​</SUBSALEPRICE>
        <SUBPROPADDRESS>​3705 Subject Address​</SUBPROPADDRESS>
        <SUBCITY>​Oklahoma City​</SUBCITY>
        <SUBSTATE>​OK​</SUBSTATE>
        <SUBZIP>​73134​</SUBZIP>
        <SUBCOUNTY>​Oklahoma​</SUBCOUNTY>
        <GDSTYPE>​SingleFamily​</GDSTYPE>
        <TYPE_OF_APPRAISAL>​FHA Appraisal (FNMA 1004)​</TYPE_OF_APPRAISAL>
        <DUE_DATE>​2012‑07‑04​</DUE_DATE>
        <FEE>​$350.00​</FEE>
        <CLIENTREVISED_NOTES>​More Notes​</CLIENTREVISED_NOTES>
        <WHO_ORDERED_PER>​OrderedBy​</WHO_ORDERED_PER>
        <APPT_CONTACT>​CO‑BORROWER​</APPT_CONTACT>
        <OCCUPANTTYPE>​Owner​</OCCUPANTTYPE>
      </FIELDS>
    </FORM>
  </FORMS>
  <ADDENDA>
    <ATTACHMENTS>
      <ATTACHMENT NUM="1" TYPE="1">
        <FILENAME>​4215.pdf​</FILENAME>
        <DESCRIPTION>​Sales Contract​</DESCRIPTION>
        <CONTENT>​Base64 String​</CONTENT>
      </ATTACHMENT>
    </ATTACHMENTS>
  </ADDENDA>
</REPORT>

Back to top


Web Services Response:

The Web service should return confirmation in the form of an ACK (if successful) or a NACK (if not successful) that should be formatted like the XML sample below.

<MNRequestResult>
  <bResult>​boolean​</bResult>
  <iError>​int​</iError>
  <szError>​string​</szError>
</MNRequestResult>
bResult
 — 
True if successful, false if not.
iError
 — 
0 for a success, otherwise return a unique error code.
szError
 — 
This will provide an error description.

Back to top

Sample ACK:

<MNRequestResult>
  <bResult>​True​</bResult>
  <iError>​0​</iError>
  </szError>
</MNRequestResult>

Back to top

Sample NACK:

<MNRequestResult>
  <bResult>​false​</bResult>
  <iError>​1​</iError>
  <szError>Please Log in before placing an order.​</szError>
</MNRequestResult>

Back to top


  Status Updates

Receiving Status Updates

The Integration Partner’s Web service should be able to consume status updates and documents that are sent after the initial order placement.

The request will consist of the Username and Password for the Web service, and an XMLPost containing the order data.

Back to top

Sample Request:

<MNRequest>
  <UserName>​string​</UserName>
  <Password>​string​</Password>
  <XMLPost>​string​</XMLPost>
</MNRequest>

Back to top

Sample XMLPost:

<STATUS>
  <TRACKINGID>​984572​</TRACKINGID>
  <STATUSID>​900000​</STATUSID>
  <STATUSCOMMENT>​Message to appraiser.​</STATUSCOMMENT>
</STATUS>
TRACKINGID
 — 
This is the unique ID for the order that was placed.
STATUSID
 — 
Each type of Status event that can occur has a unique STATUSID.
STATUSCOMMENT
 — 
Any comments that were entered by the client will show up here.

A full list of status events, their STATUSIDs, and a description is available in the MercuryNetworkEvents.xlsx file inside of the UpdateAppraisalStatusGlobal folder.

Back to top

Sample ACK:

<MNRequestResult>
  <bResult>​true​</bResult>
  <iError>​0<iError>
  </szError>
</MNRequestResult>

Back to top

Sample NACK:

<MNRequestResult>
  <bResult>​false​</bResult>
  <iError>​1​</iError>
  <szError>​The TrackingID could not be found.​</szError>
</MNRequestResult>

Back to top


Sending Status Updates

Integration Partners can use the Mercury Network Web Service (https://​www.mercurynetworkapi.com/​mercuryapi.asmx) to send status updates (Inspection Scheduled, Inspection Completed, Delayed, Cancelled, etc.) or to attach documents to the Client.

Back to top

Usage:

The Web service can be called using SOAP 1.1, SOAP 1.2, HTTP GET, or HTTP Post.  https://​www.mercurynetworkapi.com​/mercuryapi.asmx?op=UpdateAppraisalStatusGlobal

Back to top

Parameters:

UserName
 — 
Mercury Network username
Password
 — 
Mercury Network Password
XMLPost
 — 
XML data to be posted (Refer to updateappraisalstatusglobal.dtd)

Back to top

Sample Request:

<UpdateAppraisalStatusGlobal>
  <UserName>​string​</UserName>
  <Password>​string​</Password>
  <XMLPost>​string​</XMLPost>
</UpdateAppraisalStatusGlobal>

Back to top

Sample XMLPost:

<STATUS>
  <TRACKINGID>​984572​</TRACKINGID>
  <STATUSID>​300020​</STATUSID>
  <STATUSCOMMENT>​Borrower is not moving forward with this loan.​</STATUSCOMMENT>
</STATUS>
TRACKINGID
 — 
This is the unique ID for the order that was placed.
STATUSID
 — 
Each type of Status event that can occur has a unique STATUSID.
STATUSCOMMENT
 — 
Any comments that were entered by the client will show up here.

A full list of status events, their STATUSIDs, and a description is available in the MercuryNetworkEvents.xlsx file inside of the UpdateAppraisalStatusGlobal folder.

Back to top

Sample Response:

<UpdateAppraisalStatusGlobalResult xmlnso="http://mercuryvmp.com/">
  <bResult>​boolean​</bResult>
  <iError>​int​</iError>
  <szError>​string​</szError>
  <TrackingID>​string​</TrackingID>
  <TrackingNumber>​string​</TrackingNumber>
  <DocFileID>​string​</DocFileID>
</UpdateAppraisalStatusGlobalResult>
bResult
 — 
True if successful, false if not.  Check iError and szError for error details.
iError
 — 
Error Code.
szError
 — 
Error Description.
TrackingID
 — 
Mercury Network Tracking ID used to reference a specific order.
TrackingNumber
 — 
This value can be used to search for the order in Mercury Network.
DocFileID
 — 
DocFileID returned after order has been submitted to UCDP.

Back to top


Doc Details

Mercury Network Outbound Integration Guide

  • Document 9602
  • Created: 06/18/2014 MJY

The Big Picture

This document provides technical details for integrating your platform with Mercury Network to receive orders, and to send and receive updates or documents.