Class LocationRequest

A Location Request is used to add a location for an existing merchant with velocity set at the merchant level.

note

The following 1099K reporting fields are only required If the merchant has Location ID Level Boarding: Legal Name, DBA Name, Federal Tax ID, Address, City, State or Region, Postal Code.

Properties

Field/Tag Name	Value	Required	Notes
custServProviderId		Y	Partner Id
request_email		Y	Registered at Jack Henry; email format
entity_id		Y	Merchant Id
customer_name		Y	Merchant Name; alphanumeric (50)
location_name		Y	Unique Location Name
routing_number		Y	9-digit ABA Routing & Transit number
account_type	Checking, Savings, G/L	Y
account_number		Y	Numeric Merchant’s Bank Account Number
use_custom_ach_company_name	true, false	Y	Determines whether the Location Name (false) or a customer value (true) will appear on the customer's statement. Possible values: true false
custom_ach_company_name		N	IF: use_custom_ach_company_name = true, the provided value will appear on the customer's statement
legal_name		N	Required IF 1099K requirements are applicable
dba_name		N	Required IF 1099K requirements are applicable
federal_tax_id		N	######### Required IF 1099K requirements are applicable
address_1		N	Required IF 1099K requirements are applicable
address_2		N
city		N	Required IF 1099K requirements are applicable
state_or_region		N	USPS state abbreviations for US and Canada. Format is XX. Required IF 1099K requirements are applicable
postal_code		N	##### or #####-#### Required IF 1099K requirements are applicable
subject		N	Text(255)
description		N	Text(long)

Y* - Use Custom ACH Company Name requires “true” or “false.” If “false,” the Custom ACH Company Name field will be left blank.

Example LocationRequest

Input Method: XML

<xml>
	<request_email>none@example.com</request_email>
	<entity_id>######</entity_id>
	<custServProviderId>######</custServProviderId>
	<customer_name>Sample Test</customer_name>
	<routing_number>#########</routing_number>
	<account_number>####</account_number>
	<account_type>checking</account_type>
	<location_name>Test Location</location_name>
	<use_custom_ach_company_name>true</use_custom_ach_company_name>
	<custom_ach_company_name>Test</custom_ach_company_name>
	<legal_name></legal_name>
	<dba_name></dba_name>
	<federal_tax_id></federal_tax_id>
	<address_1></address_1>
	<address_2></address_2>
	<city></city>
	<state_or_region></state_or_region>
	<postal_code></postal_code>
	<case_reason></case_reason>
	<subject></subject>
	<description></description>
</xml>     

Input Method: JSON

{
  "custServProviderId": "######",
  "entity_id": "######",
  "customer_name": " Sample Test",
  "request_email": "none@example.com",
  "location_name": "Test Location",
  "routing_number": "#########",
  "account_type": "checking",
  "account_number": "####",
  "use_custom_ach_company_name": "false",
  "custom_ach_company_name": "",
  "legal_name": "",
  "dba_name": "",
  "federal_tax_id": "",
  "address_1": "",
  "address_2": "",
  "city": "",
  "state_or_region": "",
  "postal_code": "",
  "case_reason": "",
  "subject": "",
  "description": ""
}