Location
- Method
- ExampleRequest
- ExampleResponse
Location(LocationRequest)
Parameters
| TYPE | NAME | DESCRIPTION |
|---|---|---|
| LocationRequest | request |
Returns
| TYPE | DESCRIPTION |
|---|---|
| LocationResponse |
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": ""
}
Example LocationResponse
Auto-Approval Response: XML
<LocationRequestResponse>
<CaseNumber>#########</CaseNumber>
<Success>true</Success>
<LocationId>######</LocationId>
<UpdateStatus>LocationWithVelocitySettings successfully added. LocationId:######</UpdateStatus>
</LocationRequestResponse>
Non-Auto-Approval Response: XML
<LocationRequestResponse>
<CaseNumber>#########</CaseNumber>
<Success>true</Success>
<UpdateStatus>Pending manual review.</UpdateStatus>
</LocationRequestResponse>
Auto-Approval Response: JSON
{
"CaseNumber": "########",
"Success": "true",
"LocationId": "#######",
"UpdateStatus": "LocationWithVelocitySettings successfully added. LocationId:#######"
}
Non-Auto-Approval Response: JSON
{
"CaseNumber": "########",
"Success": "true",
"UpdateStatus": "Pending manual review."
}
note
The LocationId field will be present in response only when a request is auto-approved and successfully boarded.