Class LocationWithVelocityRequest
A Location with Velocity Request is used to add location to an existing merchant with velocity set at the location 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 | |
| customer_name | Y | Merchant Name; alphanumeric (50) | |
| entity_id | Y | Merchant Id | |
| 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_ach_company_name = true the provided value will appear on the customer’s statement. | |
| merchant_first_name | N | IF any merchant notification field is populated, all 4 must be populated | |
| merchant_last_name | N | IF any merchant notification field is populated, all 4 must be populated | |
| merchant_email | N | Email format: IF any merchant notification field is populated, all 4 must be populated | |
| merchant_phone | N | ###-###-####; IF any merchant notification field is populated, all 4 must be populated | |
| debit_max_single_trans_amount | Y* | numeric | |
| debit_max_single_day_count | Y* | numeric | |
| debit_max_single_day_amount | Y* | numeric | |
| debit_max_period_count | Y* | numeric | |
| debit_max_period_amount | Y* | numeric | |
| credit_max_single_trans_amount | Y* | numeric | |
| credit_max_single_day_count | Y* | numeric | |
| credit_max_single_day_amount | Y* | numeric | |
| credit_max_period_count | Y* | numeric | |
| credit_max_period_amount | Y* | numeric | |
| debit_period_percentage_warning | N | Numeric - percentage | |
| debit_single_amount_percentage_warning | N | Numeric - percentage | |
| debit_daily_percentage_warning | N | Numeric - percentage | |
| credit_period_percentage_warning | N | Numeric - percentage | |
| credit_single_amount_percentage_warning | N | Numeric - percentage | |
| credit_daily_percentage_warning | N | Numeric - percentage | |
| 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) | |
| case_reason | Application Special Circumstances, Update Bank Account Information, Update Business Information | N | This is an optional field to explain the reason. |
Y* - Use Customer ACH Company Name requires “true” or “false.” If “false,” the Custom ACH Company Name field will be left blank.
Example LocationWithVelocityRequest
Input Method: XML
<xml>
<custServProviderId>######</custServProviderId>
<entity_id>######</entity_id>
<customer_name>Sample Test</customer_name>
<request_email>none@example.com</request_email>
<location_name>Test Location</location_name>
<routing_number>#########</routing_number>
<account_type>checking</account_type>
<account_number>####</account_number>
<use_custom_ach_company_name>true</use_custom_ach_company_name>
<custom_ach_company_name>Test</custom_ach_company_name>
<debit_max_single_trans_amount>10</debit_max_single_trans_amount>
<debit_max_single_day_count>10</debit_max_single_day_count>
<debit_max_single_day_amount>100</debit_max_single_day_amount>
<debit_max_period_count>100</debit_max_period_count>
<debit_max_period_amount>1000</debit_max_period_amount>
<debit_single_amount_percentage_warning>0</debit_single_amount_percentage_warning>
<debit_daily_percentage_warning>0</debit_daily_percentage_warning>
<debit_period_percentage_warning>0</debit_period_percentage_warning>
<credit_max_single_trans_amount>0</credit_max_single_trans_amount>
<credit_max_single_day_count>0</credit_max_single_day_count>
<credit_max_single_day_amount>0</credit_max_single_day_amount>
<credit_max_period_count>0</credit_max_period_count>
<credit_max_period_amount>0</credit_max_period_amount>
<credit_single_amount_percentage_warning>0</credit_single_amount_percentage_warning>
<credit_daily_percentage_warning>0</credit_daily_percentage_warning>
<credit_period_percentage_warning>0</credit_period_percentage_warning>
<merchant_first_name></merchant_first_name>
<merchant_last_name></merchant_last_name>
<merchant_email></merchant_email>
<merchant_phone></merchant_phone>
<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": "",
"debit_max_single_trans_amount": "1",
"debit_max_single_day_count": "2",
"debit_max_single_day_amount": "3",
"debit_max_period_count": "4",
"debit_max_period_amount": "5",
"debit_single_amount_percentage_warning": "",
"debit_daily_percentage_warning": "",
"debit_period_percentage_warning": "",
"credit_max_single_trans_amount": "",
"credit_max_single_day_count": "",
"credit_max_single_day_amount": "",
"credit_max_period_count": "",
"credit_max_period_amount": "",
"credit_single_amount_percentage_warning": "",
"credit_daily_percentage_warning": "",
"credit_period_percentage_warning": "",
"merchant_first_name": "",
"merchant_last_name": "",
"merchant_email": "",
"merchant_phone": "",
"legal_name": "",
"dba_name": "",
"federal_tax_id": "",
"address_1": "",
"address_2": "",
"city": "",
"state_or_region": "",
"postal_code": "",
"case_reason": "",
"subject": "",
"description": ""
}