MerchantApplication

Contains information for a merchant application.   

Description

New merchants are added to the gateway by submitting a merchant application.   The application is reviewed for accuracy and if all information is correct, will be converted into an active merchant account.  Applications are typically activated within 1-2 hours during business hours and within 12 hours during non-business hours.

This object contains all of the information necessary for submitting a new merchant application. All fields must be passed. You only need to populate platform fields required by the platform specified. If a required field is left blank, a soapfault will be thrown, non-required fields must be passed, but may be left blank.

Properties

Type     Name     Description    
string       ResellerEmail           Email address for reseller.
string       MerchantName           Company name of merchant, used to identify merchant
ContactInfo ContactInfo             Address and contact information for merchant
string       CallInPassword         Optional call in password for merchant.   If a merchant has a call in password, they must provide this password to customer support staff before support will be given.  If no call in password is set,  support staff will verify merchant account info to clear the merchant
BillingInfo     BillingInfo                 Billing information and gateway package
string       SourceKeyName           Name of SourceKey to create when merchant is activated. Leave blank if no source key is requested
string       SourceKeyPin           Pin to assign to new SourceKey
string       EmailSourceKeyTo       Email address to send the new sourcekey to.  The email will contain the sourcekey but not the pin
string       UserName               Username of merchant user that will be created when the application is activated.  A password will be randomly assigned by the system.  Merchant must change the password the first time they log in
string       EmailInstructionsTo     Email address to send the merchant console instructions to. The email will include the merchants username and password
string       CreditCardPlatform     Name of the credit card processor to set the merchant up on.  Possible values are: FDMS, FDMS North, Tsys, Paymentech, Global, MeS, Rapid Connect, EPX and Heartland.  Leave blank if no credit card processing is requested.
string       CreditCardIndustry     Merchant Industry type: "eCommerce", "Mail Order", "Retail (Swipe)", "Hotel", "Restaurant", "Utility/Bill Pay", "Utility/Bill Pay (Card Present)"
FieldValue CreditCardPlatformSetup   Array of processor specific setup information (see below)
string       eCheckPlatform         Name of the electronic check processor to set the merchant up on. Possible values are: Vericheck, Checkgateway, Payliance, and Paya.  Leave blank if no check processing is requested.
FieldValue eCheckPlatformSetup Array of processor specific setup information (contact integration support for list of fields)
string       ApplicationNotes         Notes or instructions for gateway staff activating merchant account, ie "Hold application until 3/4/10"
integer     MerchRefNum              Read only value.  Contains the Merchant ID Number once the application has been activated
integer     ApplicationID         Read only value.  The gateway assigned Application ID
string       Status                   Read only value.  Contains the status of the application

Credit Card Platform Setup

The fields required vary depending on the platform being used. The following fields apply to all platforms:

Field Example Notes
CreditPolicy Block All Credits This sets the level of restrictions placed on a merchants ability to issue credits (refunds) to a credit cards. Possible values (listed from least to most restrictive): "No Restrictions", "Minimal Restrictions", "Require Prior Sale", "Connected Refunds Only", "Block All Credits"
AutoBatchClosure 24 Hours The desired schedule for automatically closing the merchants open batch. If omitted, the setting from the selected Package will be used. Can either be every x hours: '6 hours', '12 hours', '24 hours', '36 hours', '48 hours', '72 hours' or it can be a specific time of day: '3:45pm'. Multiple closures can be specified in a comma separated list: '6:30am,7:39pm,11:55pm'
ConsoleVersion 2 Set the desired console version

FDMS Nashville

Field Example Notes
MerchantNum 4120949485344948
MerchantID 0000000
TerminalID 0000000

FDMS North

Parameter Example Notes
MerchantID 123456789012
TerminalID alphanumeric 1234567
MCC 1234 Merchant category code (4 digits)
TaxID 000000000
Level3 Y Y/N - Denotes if level 3 processing should be enabled. Y to enable and N to disable. Defaults to disabled.
DefaultCommodityCode 00 Only required of Level 3 processing is enabled.

First Data Rapid Connect

Parameter Type Example Description
MerchantNum integer 4120949485344948
MerchantID string RCTST0000008056
TerminalID integer 1234567
MCC integer 1234 Merchant category code (4 digits)
GroupID integer 10001
TaxID integer 0000
SettlementID integer 987654321012 Settlement terminal id
Level3 boolean Y Denotes if level 3 processing should be enabled. Y to enable and N to disable. Defaults to disabled.
DefaultCommodityCode integer 00 Only required of Level 3 processing is enabled.
PinDebitSupport boolean Set to 'True' to enable debit processing

Tsys

Field Example Notes
AcquirerBIN 123456
MerchantNum 891234567890
AgentBank 000000
AgentChain 000000
StoreNumber 0001
TerminalNumber 0001
MCC 1234 Merchant category code (4 digits)
VNumber 1234567 Only needed for Tsys
MerchantName ACME BAGELS Merchant name as it will appear on cardholder statement
MerchantState CA
MerchantZip 90010
ServicePhoneNumber 3239312233 Customer Service number for merchant
AmexLevel2 Y Merchant is enrolled to process level 2 corporate purchasing cards (Y/N)
PinDebitSupport boolean Set to 'True' to enable debit processing
DebitNetworks V,P,T Comma separated list of one character debit network codes
Level3 boolean Y

MeS and Heartland

Field Example Notes
AcquirerBIN 123456
MerchantNum 891234567890
AgentBank 000000
AgentChain 000000
StoreNumber 0001
TerminalNumber 0001
MCC 1234 Merchant category code (4 digits)
VNumber 1234567 Only needed for Tsys
MerchantName ACME BAGELS Merchant name as it will appear on cardholder statement
MerchantState CA
MerchantZip 90010
ServicePhoneNumber 3239312233 Customer Service number for merchant
AmexLevel2 Y Merchant is enrolled to process level 2 corporate purchasing cards (Y/N)
PinDebitSupport boolean Set to 'True' to enable debit processing

Paymentech

Field Example Notes
ClientNumber 1234
MerchantID 012345678901
TerminalNumber 001

Global

Field Example Notes
BankID 123456
MerchantID 4567890123456

EPX

Parameter Type Example Description
CustNum string 5001 Max length of 16 numeric digits - This will usually be 4 digits
MerchNum string 3130030000000 Max length of 16 numeric digits
TerminalNum string 1 Max length of 16 numeric digits
DbaNum string 1 Max length of 16 numeric digits
Mac string 1 Max length of 80 numeric digits (optional)
PinDebitSupport boolean Set to 'True' to enable debit processing

Vantiv

Parameter Type Description
BankID integer 123456
MerchantID integer 567890123456
TerminalID integer 001
DebitTerminalID integer 000
PinDebitSupport boolean Set to 'True' to enable debit processing

eCheck Platform Setup

The fields required vary depending on the platform being used. The following fields apply to all platforms:

Vericheck

Parameter Type Description
DefaultSEC string Default Check Format. Click here for more info on check formats.
TaxID string
PIN string
MID string

Checkgateway

Parameter Type Description
DefaultSEC string Default Check Format. Click here for more info on check formats.
Username string Required

Paya

Parameter Type Description
DefaultSEC string Default Check Format. Click here for more info on check formats.
TerminalID_WEB string
TerminalID_POP string
TerminalID_TEL string
TerminalID_PPD string
TerminalID_CCD string
TerminalID_C21 string

Payliance

Parameter Type Description
DefaultSEC string Default Check Format. Click here for more info on check formats.
MerchantID string Required
Password string Required
Location string Required

CrossCheck

Parameter Type Description
Username string Required
Password string Required

ACH Solutions

Parameter Type Description
Username string Required
Password string Required
DefaultSEC string Default Check Format. Click here for more info on check formats.

Reliafund

Parameter Type Description
Username string Required
Password string Required
DefaultSEC string Default Check Format. Click here for more info on check formats.

Actum

Parameter Type Description
TELParentID string
TELSubID string
TELUsername string
TELPassword string
TELSystemPassword string
PPDParentID string
PPDSubID string
PPDUsername string
PPDPassword string
PPDSystemPassword string
CCDParentID string
CCDSubID string
CCDUsername string
CCDPassword string
CCDSystemPassword string
WEBParentID string
WEBSubID string
WEBUsername string
WEBPassword string
WEBSystemPassword string
DefaultSEC string Default Check Format. Click here for more info on check formats.

Places Used

addMerchantApplication 

Examples

PHP

    $App=new stdClass();

    $App->ResellerEmail='applications@reseller.com';

    $App->ContactInfo = new stdClass();
    $App->MerchantName = "Acme Bagel Company";
    $App->ContactInfo->Contact = "John Doe";
    $App->ContactInfo->Street  ='4929 Wilshire Blvd';
    $App->ContactInfo->Street2 ='Suite 800';
    $App->ContactInfo->City    ='Los Angeles';
    $App->ContactInfo->State   ='CA';            
    $App->ContactInfo->Zip     ='90010';           
    $App->ContactInfo->Country ='US';        
    $App->ContactInfo->Email   = 'john@acme.com';
    $App->ContactInfo->Fax         ='012134567890';      
    $App->ContactInfo->Phone   ='687668678677';     
    $App->ContactInfo->MobilePhone='798787978788';
    $App->ContactInfo->AltEmail='mary@tmcode.com';
    $App->ContactInfo->URL = 'http://acme bagels.com';

    $App->BillingInfo = new stdClass();
    $App->BillingInfo->BankName = 'Bank of America';
    $App->BillingInfo->RoutingNumber = '12342313312';
    $App->BillingInfo->AccountNumber = '57655765754';
    $App->BillingInfo->GatewayPackage = 'Platinum Package';

    $App->CreditCardPlatform = 'FDMS';
    $App->CreditCardIndustry = 'Retail (Swipe)';
    $App->CreditCardPlatformSetup = array();
    $App->CreditCardPlatformSetup[] = array('Field'=>'MerchantNum', 'Value'=>'4454900399430020');
    $App->CreditCardPlatformSetup[] = array('Field'=>'MerchantID', 'Value'=>'382772891');
    $App->CreditCardPlatformSetup[] = array('Field'=>'TerminalID', 'Value'=>'112198000');

    $App->eCheckPlatform = 'Vericheck';
    $App->eCheckPlatformSetup = array();
    $App->eCheckPlatformSetup[] = array('Field'=>'DefaultSEC', 'Value'=>'TEL');
    $App->eCheckPlatformSetup[] = array('Field'=>'TaxID', 'Value'=>'123456789');
    $App->eCheckPlatformSetup[] = array('Field'=>'PIN', 'Value'=>'231');
    $App->eCheckPlatformSetup[] = array('Field'=>'MID', 'Value'=>'11231');
    $App->eCheckPlatformSetup[] = array('Field'=>'AcceptedSecCodes', 'Value'=>'TEL,PPD,CCD');

    $App->SourceKeyName = 'My Shopping Cart';
    $App->SourceKeyPin = '1351';
    $App->EmailSourceKeyTo = 'demo@acmebagels.com';

    $App->UserName = 'acmebagels';
    $App->EmailInstructionsTo = 'demo@acmebagels.com';

    $App->ApplicationNotes = 'An example note for merchant application';

Java

               MerchantApplication merchantapp = new MerchantApplication();


                merchantapp.setApplicationNotes("Application notes");

                BillingInfo billing = new BillingInfo();
                billing.setBankName("Example Bank");
                billing.setRoutingNumber("123456789");
                billing.setAccountNumber("910293112");
                billing.setGatewayPackage("Silver Package");
                merchantapp.setBillingInfo(billing);

                merchantapp.setCallInPassword("1234");
                ContactInfo contactinfo = new ContactInfo();
                contactinfo.setContact("John Doe");
                contactinfo.setStreet("4929 Wilshire Blvd");
                contactinfo.setStreet2("Suite 899");
                contactinfo.setCity("Los Angeles");
                contactinfo.setState("CA");
                contactinfo.setZip("90010");
                contactinfo.setCountry("US");
                contactinfo.setEmail("merchant@tmcode.com");
                contactinfo.setAltEmail("merchant@tmcode.com");
                contactinfo.setPhone("222-333-4446");
                contactinfo.setMobilePhone("222-333-4445");
                contactinfo.setFax("222-333-4444");
                contactinfo.setURL("http://www.acme.org");
                merchantapp.setContactInfo(http://help.newtekgateway.com/developer/soap-api/boarding/objects/contactinfo/);

                merchantapp.setCreditCardIndustry("eCommerce");
                merchantapp.setCreditCardPlatform("FDMS");

                FieldValueArray platformdata = new FieldValueArray();
                platformdata.add(new FieldValue("MerchantNum","2334566356345"));
                platformdata.add(new FieldValue("MerchantID","1231230"));
                platformdata.add(new FieldValue("TerminalID","1231239"));
                merchantapp.setCreditCardPlatformSetup(platformdata);

                merchantapp.setECheckPlatform("Vericheck");
                FieldValueArray checkplatform = new FieldValueArray();
                checkplatform.add(new FieldValue("DefaultSEC","TEL"));
                checkplatform.add(new FieldValue("TaxID","123456789"));
                checkplatform.add(new FieldValue("PIN","231"));
                checkplatform.add(new FieldValue("MID","11231"));
                checkplatform.add(new FieldValue("AcceptedSecCodes","TEL,PPD,CCD"));
                merchantapp.setECheckPlatformSetup(checkplatform);

                merchantapp.setEmailInstructionsTo("merchant@tmcode.com");
                merchantapp.setEmailSourceKeyTo("merchant@tmcode.com");
                merchantapp.setMerchantName("Example Company");
                merchantapp.setResellerEmail("reselller@tmcode.com");
                merchantapp.setSourceKeyName("ShoppingCart");
                merchantapp.setSourceKeyPin("1234");
                merchantapp.setUserName("jdoe23");