Menu

Location Object

The location object contains more specific data about the merchant. It is also the container for all other objects used throughout the merchant application, with the exception of the account object.


DBA Address

Description

DBA Address of the business. The is the address of the physical location.

JSON String

location_dba_address

Type

Object

Required

Yes


Address Line 1

Description

The Street Address portion of the business's physical location.

JSON String

address_line_1

Type

String

Required

Yes


Address City

Description

The City of the business's physical location.

JSON String

address_city

Type

String

Required

Yes


Address State

Description

The State of the business's physical location.

JSON String

address_state

Type

String

Required

Yes

Comments

Use only the two character state abbreviation. (i.e. AZ, NY)


Address Zip Code

Description

The 5 digit Zip Code of the business's physical location.

JSON String

address_zipcode

Type

String

Required

Yes


Location Contact Name

Description

Full Name of the contact for this location.

JSON String

location_contact_name

Type

String

Required

No


Location Contact Email

Description

Email Address of the contact for this location.

JSON String

location_contact_email

Type

String

Required

No


Location Contact Mobile

Description

Mobile Phone Number of the location contact.

JSON String

location_contact_mobile

Type

String

Required

No

Comments

Format: (NNN)NNN-NNNN


Location Fax

Description

The company’s fax number.

JSON String

location_fax

Type

String

Required

No

Comments

Format: (NNN)NNN-NNNN


Entity Start Date

Description

The Date an entity opened for business.

JSON String

location_entity_start_date

Type

Date

Required

Yes

Comments

Format: MM/DD/YYYY


Entity State

Description

The State an entity was incorporated in.

JSON String

location_entity_state

Type

String

Required

Yes

Comments

Use the 2 character state abbreviation in this field.


Length of Current Ownership

Description

When did the Primary Contact / Owner take over ownership of the company?

JSON String

location_length_of_current_ownership

Type

Date

Required

Yes

Comments

Format: MM/DD/YYYY


Sales Agents Name

Description

The name of the Sales Agent.

JSON String

location_sales_agent_name

Type

String

Required

No


Description

Description

Description of the nature of the business and the products / services sold.

JSON String

location_description

Type

String. Static Variables below.

Required

No

Comments

Valid Values:

XS_DESCRIPTION_ACCOUNTING = "Accounting";

XS_DESCRIPTION_APPAREL = "Apparel";

XS_DESCRIPTION_ART_PHOTO_FILM = "Art / Photo / Film";

XS_DESCRIPTION_BARBER_HAIR_SALON = "Barber / Hair Salon";

XS_DESCRIPTION_CATERING = "Catering";

XS_DESCRIPTION_CLEANING_SERVICES = "Cleaning Services";

XS_DESCRIPTION_COMPUTER_SERVICES = "Computer Services";

XS_DESCRIPTION_CONSULTING = "Consulting";

XS_DESCRIPTION_CONSTRUCTION = "Construction";

XS_DESCRIPTION_DENTISTRY = "Dentistry";

XS_DESCRIPTION_FOOD_GROCERY ="Food / Grocery";

XS_DESCRIPTION_HEALTH_CARE = "Health Care";

XS_DESCRIPTION_LANDSCAPING = "Landscaping";

XS_DESCRIPTION_LEGAL_SERVICES = "Legal Services";

XS_DESCRIPTION_MEMBERSHIP_ORGANIZATION = "Membership Organization";

XS_DESCRIPTION_OTHER = "OTHER";

XS_DESCRIPTION_PERSONAL_SERVICES = "Personal Services";

XS_DESCRIPTION_REAL_ESTATE = "Real Estate";

XS_DESCRIPTION_REPAIR_SERVICS = "Repair Services";

XS_DESCRIPTION_RESTAURANT_BAR = "Restaurant / Bar";

XS_DESCRIPTION_RETAIL = "Retail";

XS_DESCRIPTION_SHIPPING = "Shipping";

XS_DESCRIPTION_TAXI_LIMO = "Taxi / Limo";

XS_DESCRIPTION_TRADE_CONTRACTOR = "Trade Contractor";

XS_DESCRIPTION_VETERINARY = "Veterinary";

XS_DESCRIPTION_WEB_DESIGN_DEVELOPMENT = "Web Design / Development";


Additional Description

Description

Extra space that can be used to further describe your business.

JSON String

location_additional_description

Type

String

Required

No


Location Chargeback Fax

Description

Fax Number for Chargeback Notifications.

JSON String

location_chargeback_fax

Type

String

Required

No

Comments

Format: (NNN)NNN-NNNN


Settlement Time

Description

Time you want the Merchant’s batches to be settled at.

JSON String

location_settlement_time

Type

String

Required

No

Comments

If on the Base Commerce Platform and no settlement time is indicated will default to 17:30 EST.


ACH Details

Description

Please see the ACH Details Object section 4 for further details on ACH Details.

JSON String

location_ach_details

Type

Object

Required

Conditional

Comments

Required if merchant will be accepting ACH Payments


Bank Card Details

Description

Please see the BankCardDetails Object section 5 for further details on BankCardDetails.

JSON String

location_bc_details

Type

Object

Required

Conditional

Comments

Required if merchant will be accepting Bank Card Payments


Principal Contacts

Description

A container of PrincipalContact objects. Please see the PrincipalContact Object section 6 for further details.

JSON String

location_principal_contacts

Type

Object

Required

Yes


Terminals

Description

A container of Terminal objects. Please see the Terminal Object section 7 for further details on Terminals.

JSON String

location_terminals

Type

Object

Required

Conditional

Comments

Required if merchant will be using a wireless or countertop based terminal either on its own or connected to a POS Device.


MOTO

Description

Please see the MOTO Object section 9 for further details on MOTO.

JSON String

location_moto

Type

Object

Required

Conditional

Comments

Required if merchant is taking either mail order or telephone order transactions.


Internet

Description

Please see the Internet Object section 10 for further details on Internet.

JSON String

location_internet

Type

Object

Required

Conditional

Comments

Required if merchant is accepting transactions via a web interface.


POS

Description

Please see the Internet Object section 8 for further details on Internet.

JSON String

location_pos

Type

Object

Required

Conditional

Comments

Required if merchant is accepting transactions via physical point of sale device.



Location o_location = new Location ();

        Address o_dba_address = new Address( address.XS_DBA );
          o_dba_address.setLine1( "123 Fake St." );
          o_dba_address.setCity( "Toontown" );
          o_dba_address.setState( "AZ" );
          o_dba_address.setZipcode( "85284" );
        o_location.setDBAAddress( o_dba_address );

        o_location.setContactName( "John Doe" );
        o_location.setContactEmail( "John.Doe@email.com" );
        o_location.setFax( "(480)555-1234" );
        o_location.setEntityStartDate( new Date() );
        o_location.setEntityState( "AZ" );

        ACHDetails o_ach_details = new ACHDetails();
          //ach details go here
        o_location.setAchDetails( o_ach_details );

        BankCardDetails o_bc_details = new BankCardDetails();
          //bank card details go here
        o_location.SetBankCardDetails( o_bc_details );

        PrincipalContact o_contact = new PrincipalContact();
          //principal contact details go here
        o_location.addPrincipalContact( o_contact );

		Terminals o_terminals = new Terminals();
		  //terminal object details go here
		o_location.setTerminals( o_terminals);

		MOTO o_moto = new MOTO();
		  //moto object details go here
		o_location.setMOTO( o_moto );

		Internet o_internet = new Interent();
          //internet object details go here
        o_location.setInternet( o_internet );

		POS o_pos = new POS();
		  //pos object details go here
		o_location.setPOS( o_pos );

o_merchant_application.addLocation( o_location );