New Applications
The New Application Module is used to board new customers/merchants to the system. The application requires standard business information necessary for underwriting customers. The system also contains many informational fields that Jack Henry is obligated to capture under the “Uniting and Strengthening America by Providing Appropriate Tools Required to Intercept and Obstruct Terrorism Act” (USA PATRIOT Act).
The boarding process is available manually through the user interface or by directly connecting through API requests. The user interface is very helpful in the validation of the information submitted.
Connectivity
Successful requests require the following setup information:
Basic Authentication (username and password, provided by EPS)
Header – Determines how you will receive data.Request Type = POST/GET
Request Format = REST
Content –Type = application/JSON or application/XML {REST}
Authorization Basic
Request Data Formats
Data will need to be formatted and submitted in REST JSON or XML to interface with the system. The fields required for the call can vary based on the products contracted. Below is a list of the request types that will always be used regardless of the request type:
Action: either POST or GET
CustServProviderId: numeric value with a maximum of eight characters (Partner ID)
Entity_id: numeric value with a maximum of eight characters (Merchant ID)
Request_email: your active account email (Please check with ProfitStars)
Authentication to Note
- The request_email is used to validate the user related to a specific Partner and determine if they have access/permission to run the API calls. If the requestor is not associated with the account, an error message will be returned to the user: User (email address) is not authorized to run the API.
- The custServProviderId and entity_id is used to validate that the Entity ID is related to that specific Partner’s custServProviderId. If they are not related, an error message will be returned to the user: This Merchant (Entity ID) is not associated with this Partner.
- When completing an application for a new account, the CustServProviderId, Request Email, Customer Name, and FederalTaxID need to be provided. The CustServProviderId will be validated to fetch the Parent Account ID. If validation fails, an error message will be returned: This Partner (CustServProviderId) is not associated with this Partner.
note
You will need to submit data in the same format as you are set up to receive it.
Below is the URL for the STAGE (TEST) environment:
| API/Service Process Name | URL (Stage) |
|---|---|
| Add Application | https://use4-apigw.dm-us.informaticacloud.com/t/dev.jha.domain.com/API-Integration-Salesforce |
Below is the URL for the PRODUCTION environment:
| API/Service Process Name | URL (Production) |
|---|---|
| Add Application | https://use4-apigw.dm-us.informaticacloud.com/t/prod.jha.domain.com/API-Integration-Salesforce |
Request Fields
The fields listed below are common among all Partners. Sample layouts appear after the table.
Account Information
| Field/Tag Name | Value | Required | Notes |
|---|---|---|---|
| CustServProviderId | String(6) | Y | Partner ID |
| CustomerName | String(120) | Y | Merchant Legal Name |
| RequestEmail | String | Y | Registered at ProfitStars; email format |
| FederalTaxID | Numeric(9) | Y | ######### |
| BoardingRefID | String(20) | N | Alpha-numeric unique identifier supplied by Partner; solely for use by Partner in identifying merchants |
| DBAName | String(120) | Y | |
| PhysicalAddress1 | String(255) | Y | |
| PhysicalCity | String(50) | Y | |
| PhysicalState | String(2) | Y | USPS state abbreviations for US and Canada |
| PhysicalZip | String(10) | Y | ##### or #####-#### |
| PhysicalCountry | String(50) | N | Valid values: United States or Canada |
| PhoneNumber | String(12) | Y | ###-###-#### |
| PhoneNumberExt | Numeric(6) | N | |
| FaxNumber | String(12) | N | ###-###-#### |
| CustomerServicePhoneNumber | String(12) | Y | ###-###-#### |
| CustomerServicePhoneNumberExt | Numeric(6) | N | |
| WebsiteURL | String(50) | Y | Do not include http:// or https:// within the URL. |
| BillingAddress1 | String(255) | N | All billing address fields are N/A when JHA bills the Partner |
| BillingCity | String(50) | N | |
| BillingState | String(2) | N | USPS state abbreviations for US and Canada |
| BillingZip | String(10) | N | ##### or #####-#### |
| BillingCountry | String(50) | N | Valid values: United States or Canada |
| BusinessStructure | Picklist | Y | Possible values entire string: 4~Corporation 8~Government 5~Limited Liability Corporation 3~Limited Liability Partnership 7~Not For Profit 2~Partnership 6~S Corporation 1~Sole Proprietorship |
| StockSymbol | String(6) | N | |
| DateFormed | Date | Y | yyyy-mm-dd |
| HowAreSalesGenerated | Picklist | N | Possible values entire string: Face to Face Internet Mail Order Telephone Order (MOTO) Outbound Telemarketing Public Relations Print Advertising Retail TV/Radio Advertising Word of Mouth |
| NAICSIndustry | Picklist | N | Possible values entire string: 11~Agriculture, Forestry, Fishing, and Hunting 21~Mining 22~Utilities 23~Construction 31-33~Manufacturing 42~Wholesale Trade 44-45~Retail Trade 48-49~Transportation and Warehousing 51~Information 52~Finance and Insurance 53~Real Estate and Rental and Leasing 54~Professional, Scientific, and Technical Services 55~Management of Companies and Enterprises 56~Administration, Support, Waste Mgmt, and Remediation Services 61~Educational Services 62~Health Care and Social Assistance 71~Arts, Entertainment, and Recreation 72~Accommodation and Food Services 81~Other Services [except Public Administration] 92~Public Administration |
| ClassificationCode | Picklist | Y | Please see Appendix C for the possible Classification Codes and NACIS Industry Code Values. |
Contact Information
| Field/Tag Name | Value | Required | Notes |
|---|---|---|---|
| PrimaryContactName | String(50) | Y | Can be Partner or Merchant contact; will be used as recipient of Riskforce application status emails |
| PrimaryContactTitle | String(50) | Y | |
| PrimaryContactPhoneNumber | String(12) | N | Required Format: ###-###-#### |
| PrimaryContactPhoneNumberExt | Numeric(6) | N | |
| PrimaryContactEmailAddress | String(50) | Y | Can be Partner or Merchant contact; will be used as recipient of Riskforce application status emails |
| SecondaryContactName | String(50) | N | |
| SecondaryContactTitle | String(50) | IF SecondaryContactName not empty | |
| SecondaryContactPhoneNumber | String(12) | IF SecondaryContactName not empty | Required Format: ###-###-#### |
| SecondaryContactPhoneNumberExt | Numeric(6) | N | |
| SecondaryContactEmailAddress | String(50) | IF SecondaryContactName not empty |
Officer Information
| Field/Tag Name | Value | Required | Notes |
|---|---|---|---|
| PrimaryOfficerName | String(50) | Y | |
| PrimaryOfficerTitle | String(50) | Y | |
| PrimaryOfficerPhoneNumber | String(12) | Y | Required Format: ###-###-#### |
| PrimaryOfficerPhoneNumberExt | String(6) | N | |
| PrimaryOfficerRole | List | Y | Possible values entire string: 1 2 3 ~Officer |
| PrimaryOfficerEmailAddress | String(50) | Y | |
| PrimaryOfficerPercent | Numeric(3) | Y | Must be ≥ 0 and ≤ 100. |
| PrimaryOfficerDOB | String(10) | IF PrimaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership OR Money Center merchant | yyyy-mm-dd |
| PrimaryOfficerSSN | String(11) | IF PrimaryOfficerPercent ≥ 25% AND PrimaryOfficerDL & PrimaryOfficerDLState empty OR BusinessStructure = 2~Partnership AND PrimaryOfficerDL & PrimaryOfficerDLState empty OR Money Center merchant AND PrimaryOfficerDL & PrimaryOfficerDLState empty | ###-##-#### |
| PrimaryOfficerHomeAddress | String(150) | IF PrimaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership OR Money Center merchant | |
| PrimaryOfficerCity | String(50) | IF PrimaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership OR Money Center merchant | |
| PrimaryOfficerState | String(2) | IF PrimaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership OR Money Center merchant | USPS state abbreviations |
| PrimaryOfficerZip | String(10) | IF PrimaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership OR Money Center merchant | ##### or #####-#### |
| PrimaryOfficerDL | String(20) | IF PrimaryOfficerPercent ≥ 25% AND PrimaryOfficerSSN empty OR BusinessStructure = 2~Partnership AND PrimaryOfficerSSN empty OR Money Center merchant AND PrimaryOfficerSSN empty | |
| PrimaryOfficerDLState | String(2) | IF PrimaryOfficerPercent ≥ 25% AND PrimaryOfficerSSN empty OR BusinessStructure = 2~Partnership AND PrimaryOfficerSSN empty OR Money Center merchant AND PrimaryOfficerSSN empty | USPS state abbreviations |
| SecondaryOfficerName | String(50) | IF SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | |
| SecondaryOfficerTitle | String(50) | IF SecondaryOfficerName not empty OR SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | |
| SecondaryOfficerPhoneNumber | String(12) | IF SecondaryOfficerName not empty OR SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | Required Format: ###-###-#### |
| SecondaryOfficerPhoneNumberExt | String(6) | N | |
| SecondaryOfficerRole | List | IF SecondaryOfficerName not empty OR SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | Possible values entire string: 1 2 3~Officer |
| SecondaryOfficerEmailAddress | String(50) | IF SecondaryOfficerName not empty OR SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | |
| SecondaryOfficerPercent | Numeric(3) | IF SecondaryOfficerName not empty OR SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | Must be ≥ 0 and ≤ 100 |
| SecondaryOfficerDOB | String(10) | IF SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | yyyy-mm-dd |
| SecondaryOfficerSSN | String(11) | IF SecondaryOfficerPercent ≥ 25% AND SecondaryOfficerDL & SecondaryOfficerDLState empty OR IF BusinessStructure =2~Partnership AND SecondOfficerDL & SecondaryOfficerDLState empty | ###-##-#### |
| SecondaryOfficerHomeAddress | String(150) | IF SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | |
| SecondaryOfficerCity | String(50) | IF SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | |
| SecondaryOfficerState | String(2) | IF SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | USPS state abbreviations |
| SecondaryOfficerZip | String(10) | IF SecondaryOfficerPercent ≥ 25% OR BusinessStructure = 2~Partnership | ##### or #####-#### |
| SecondaryOfficerDL | String(20) | IF SecondaryOfficerPercent ≥ 25% AND PrimaryOfficerSSN empty OR IF BusinessStructure = 2~Partnership AND PrimaryOfficerSSN empty | |
| SecondaryOfficerDLState | String(2) | IF SecondaryOfficerPercent ≥ 25% AND SecondaryOfficerSSN empty OR IF BusinessStructure = 2~Partnership AND SecondaryOfficerSSN empty | USPS state abbreviations |
| TertiaryOfficerName | String(50) | IF TertiaryOfficerPercent ≥ 25% | |
| TertiaryOfficerTitle | String(50) | IF TertiaryOfficerName not empty OR TertiaryOfficerPercent ≥ 25% | |
| TertiaryOfficerPhoneNumber | String(12) | IF TertiaryOfficerName not empty OR TertiaryOfficerPercent ≥ 25% | Required Format: ###-###-#### |
| TertiaryOfficerPhoneNumberExt | String(6) | N | |
| TertiaryOfficerRole | List | IF TertiaryOfficerName not empty OR TertiaryOfficerPercent ≥ 25% | Possible values entire string: 1 2 3~Officer |
| TertiaryOfficerEmailAddress | String(50) | IF TertiaryOfficerName not empty OR TertiaryOfficerPercent ≥ 25% | |
| TertiaryOfficerPercent | Numeric(3) | IF TertiaryOfficerName not empty OR TertiaryOfficerPercent ≥ 25% | Must be ≥ 0 and ≤ 100. |
| TertiaryOfficerDOB | String(10) | IF TertiaryOfficerPercent ≥ 25% | yyyy-mm-dd |
| TertiaryOfficerSSN | String(11) | IF TertiaryOfficerPercent ≥ 25% AND TertiaryOfficerDL & TertiaryOfficerDLState empty | ###-##-#### |
| TertiaryOfficerHomeAddress | String(150) | IF TertiaryOfficerPercent ≥ 25% | |
| TertiaryOfficerCity | String(50) | IF TertiaryOfficerPercent ≥ 25% | |
| TertiaryOfficerState | String(2) | IF TertiaryOfficerPercent ≥ 25% | USPS state abbreviations |
| TertiaryOfficerZip | String(10) | IF TertiaryOfficerPercent ≥ 25% | ##### or #####-#### |
| TertiaryOfficerDL | String(20) | IF TertiaryOfficerPercent ≥ 25% AND TertiaryOfficerSSN empty | |
| TertiaryOfficerDLState | String(2) | IF TertiaryOfficerPercent ≥ 25% AND TertiaryOfficerSSN empty | USPS state abbreviations |
| QuaternaryOfficerName | String(50) | IF QuaternaryOfficerPercent ≥ 25% | |
| QuaternaryOfficerTitle | String(50) | IF QuaternaryOfficerName not empty OR QuaternaryOfficerPercent ≥ 25% | |
| QuaternaryOfficerPhoneNumber | String(12) | IF QuaternaryOfficerName not empty OR QuaternaryOfficerPercent ≥ 25% | Required Format: ###-###-#### |
| QuaternaryOfficerPhoneNumberExt | String(6) | N | |
| QuaternaryOfficerRole | List | IF QuaternaryOfficerName not empty OR QuaternaryOfficerPercent ≥ 25% | Possible values entire string: 1 2 3~Officer |
| QuaternaryOfficerEmailAddress | String(50) | IF QuaternaryOfficerName not empty OR QuaternaryOfficerPercent ≥ 25% | |
| QuaternaryOfficerPercent | Numeric(3) | IF QuaternaryOfficerName not empty OR QuaternaryOfficerPercent ≥ 25% | Must be ≥ 0 and ≤ 100. |
| QuaternaryOfficerDOB | String(10) | IF QuaternaryOfficerPercent ≥ 25% | yyyy-mm-dd |
| QuaternaryOfficerSSN | String(11) | IF QuaternaryOfficerPercent ≥ 25% AND QuaternaryOfficerDL & QuaternaryOfficerDLState empty | ###-##-#### |
| QuaternaryOfficerHomeAddress | String(150) | IF QuaternaryOfficerPercent ≥ 25% | |
| QuaternaryOfficerCity | String(50) | IF QuaternaryOfficerPercent ≥ 25% | |
| QuaternaryOfficerState | String(2) | IF QuaternaryOfficerPercent ≥ 25% | USPS state abbreviations |
| QuaternaryOfficerZip | String(10) | IF QuaternaryOfficerPercent ≥ 25% | ##### or #####-#### |
| QuaternaryOfficerDL | String(20) | IF QuaternaryOfficerPercent ≥ 25% AND QuaternaryOfficerSSN empty | |
| QuaternaryOfficerDLState | String(2) | IF QuaternaryOfficerPercent ≥ 25% AND QuaternaryOfficerSSN empty | USPS state abbreviations |
Application Information
| Field/Tag Name | Value | Required | Notes |
|---|---|---|---|
| OpportunityName | String(120) | Y | |
| CloseDate | Date | Y | yyyy-mm-dd |
| RecordType | String(50) | Y | Value to be provided: Merchant Application |
| Amount | Numeric(10) | Y | |
| ScannerMake | List | N | Possible values entire string: 501~Magtek / MagneSafe [USB], 502~Magtek / Dynamag Card Swipe, 715~RDM / ec7000i, 718~RDM / Epson, 721~RDM / ec7500i 760~Unisys / SmartSource Professional Series, 765~Digital Check / SmartSource Professional Elite, 805~Panini / I:Deal, 806~Panini / wI:Deal, 807~Panini / Vision X, 808~Panini / MyVision X, 900~Digital Check Corp. / TS230, 930~Unisys / SmartSource Value Series, 935~Digital Check / SmartSource Micro Elite, 936~Ditial Check / SmartSource Merchant Elite, 940~Digital Check Corp. / CheXpress 30, 950~Digital Check Corp. / [Single Feed], 951~Digital Check Corp. / TS240, 960~Canon CR-L1, 965~Canon CR-120, 970~Canon CR-150, 975~Canon CR-190i II |
| ScannerSerialNumber | String(20) | N | |
| FaceAmountRePresentments | List | N | N/A for Check 21. Possible values (entire string): 0~Do not re-present the face amount 1~Re-present the face amount one time 2~Re-present the face amount up to two times |
| TimingOfFirstPresentment | List | N | N/A for Check 21. Possible values (entire string): 0~Immediately following ACH return 1~1 day following ACH return 2~2 days following ACH return 3~3 days following ACH return 4~4 days following ACH return 5~5 days following ACH return 6~6 days following ACH return 7~7 days following ACH return 8~8 days following ACH return 9~9 days following ACH return 10~10 days following ACH return 15~15 days following ACH return 20~20 days following ACH return 25~25 days following ACH return 30~30 days following ACH return |
| TimeFinalPresentment | List | N | N/A for Check 21. Possible values (entire string): 0~Schedule after a specified number of days 1~Coincide with common paydays |
| TimingOfFinalPresentment | Numeric(2) | N | N/A for Check 21 |
| ReturnedCheckPresentments | List | N | N/A for Check 21. Possible values (entire string): 0~Do not re-present the fee amount 1~Re-present the fee amount one time 2~Re-present the fee amount up to two times 3~Re-present the fee amount up to three times |
| ReturnedCheckFeeAmount | Numeric(2) | N | N/A for Check 21 |
| FinancialInstitutionAccount | List | N | N/A for Check 21. Possible values (entire string): 0~Deposit collected funds into client's settlement account 1~Deposit collected funds into another specified account |
| SettlementABA | String(9) | N | N/A for Check 21 |
| SettlementAccount | String(17) | N | N/A for Check 21. Must be a valid ABA Routing & Transit Number |
| NotesSpecialInstructions | String(255) | N | N/A for Check 21 |
| Check21FaceAmountRePresentments | List | N | N/A for ACH. Possible values (entire string): 0~Do not re-present the face amount 1~Re-present the face amount one time |
| Check21AutomatedRePresentment | List | N | N/A for ACH. Possible values (entire string): 0~Manual Re-presentment 1~Auto Re-presentment |
| Check21TimeFinalPresentment | List | N | N/A for ACH. Possible values (entire string): 0~Schedule after a specified number of days 1~Coincide with common paydays |
| Check21TimingOfFinalPresentment | List | N | N/A for ACH. Possible values: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 15, 20, 25, or 30 |
| Check21FinancialInstitutionAccount | List | N | N/A for ACH Possible values (entire string): 0~Deposit collected funds into client's settlement account 1~Deposit collected funds into another specified account |
| Check21ABA | Numeric(9) | N | N/A for ACH Must be a valid ABA Routing & Transit Number |
| Check21Account | Numeric(17) | N | N/A for ACH |
| MerchDebitSingleTransAmount | Numeric(10) | N | Merchant-level velocity setting for C21 and ACH debits |
| MerchDebitSingleDayCount | Numeric(10) | N | Merchant-level velocity setting for C21 and ACH debits |
| MerchDebitSingleDayAmount | Numeric(10) | N | Merchant-level velocity setting for C21 and ACH debits |
| MerchDebitPeriodCount | Numeric(10) | N | Merchant-level velocity setting for C21 and ACH debits |
| MerchDebitPeriodAmount | Numeric(10) | N | Merchant-level velocity setting for C21 and ACH debits |
| MerchCreditSingleTransAmount | Numeric(10) | N | Merchant-level velocity setting for Money Center ACH credits |
| MerchCreditSingleDayCount | Numeric(10) | N | Merchant-level velocity setting for Money Center ACH credits |
| MerchCreditSingleDayAmount | Numeric(10) | N | Merchant-level velocity setting for Money Center ACH credits |
| MerchCreditPeriodCount | Numeric(10) | N | Merchant-level velocity setting for Money Center ACH credits |
| MerchCreditPeriodAmount | Numeric(10) | N | Merchant-level velocity setting for Money Center ACH credits |
| SingleAmountPercentage | Numeric(3) | N | Specifies what percentage of velocity will trigger a warning notice. Must be ≥ 1 and ≤ 100. |
| DailyPercentage | Numeric(3) | N | Specifies what percentage of velocity will trigger a warning notice. Must be ≥ 1 and ≤ 100. |
| PeriodPercentage | Numeric(3) | N | Specifies what percentage of velocity will trigger a warning notice. Must be ≥ 1 and ≤ 100. |
| Recipient1VelocityEmailAddress | String(50) | Y | Specifies who will receive velocity exception and/or warning notices |
| Recipient2VelocityEmailAddress | String(50) | N | Specifies who will receive velocity exception and/or warning notices |
| Recipient3VelocityEmailAddress | String(50) | N | Specifies who will receive velocity exception and/or warning notices |
| Recipient4VelocityEmailAddress | String(50) | N | Specifies who will receive velocity exception and/or warning notices |
| Recipient5VelocityEmailAddress | String(50) | N | Specifies who will receive velocity exception and/or warning notices |
| Recipient1FIEmailAddress | String(50) | Y | Specifies who will receive account credentials |
| Recipient2FIEmailAddress | String(50) | N | Specifies who will receive account credentials |
| Recipient3FIEmailAddress | String(50) | N | Specifies who will receive account credentials |
| Recipient4FIEmailAddress | String(50) | N | Specifies who will receive account credentials |
Location Information *Maximum of 500 Locations
| Field/Tag Name | Value | Required | Notes |
|---|---|---|---|
| BankName | String (50) | Y | Name of Location that appears on the bank statement. Not the name of the financial institution. *Maximum of 500 Locations. |
| RoutingNumber | Numeric (9) | Y | Must be a valid ABA Routing & Transit Number |
| AccountNumber | Numeric (17) | Y | Should be between 4 and 17 digits. |
| AccountType | List | Y | Possible values (entire string) : 0 1 |
| DebitSingleTransAmount | Numeric (10) | N | |
| DebitSingleDayCount | Numeric (10) | N | |
| DebitSingleDayAmount | Numeric (10) | N | |
| DebitPeriodCount | Numeric (10) | N | |
| DebitPeriodAmount | Numeric (10) | N | |
| CreditSingleTransAmount | Numeric (10) | N | |
| CreditSingleDayCount | Numeric (10) | N | |
| CreditSingleDayAmount | Numeric (10) | N | |
| CreditPeriodCount | Numeric (10) | N | |
| CreditPeriodAmount | Numeric (10) | N | |
| LocationLegalName | String (120) | IF LID Level Boarding KYC requirements are applicable | |
| LocationDBAName | String (120) | IF LID Level Boarding KYC requirements are applicable | |
| LocationBusinessTaxID | Numeric (9) | IF LID Level Boarding KYC requirements are applicable | ######### |
| LocationAddressSameAsCompa ny | Boolean | IF LID Level Boarding KYC requirements are applicable | Possible values: true false |
| LocationAddress1 | String (255) | IF LID Level Boarding KYC requirements are applicable AND LocationAddressSam eAsCompany = false | |
| LocationAddress2 | String (50) | N | |
| LocationCity | String (50) | IF LID Level Boarding KYC requirements are applicable AND LocationAddressSam eAsCompany = false | |
| LocationState | String (2) | IF LID Level Boarding KYC requirements are applicable AND LocationAddressSam eAsCompany = false | USPS state abbreviations for US and Canada |
| LocationZip | String (10) | IF LID Level Boarding KYC requirements are applicable AND LocationAddressSam eAsCompany = false | ##### or #####-#### |
Data Format (XML)
<api:API-IntegrationRequest>
<APIIntegration>
<Account>
<custServProviderId></custServProviderId>
<CustomerName></CustomerName>
<RequestEmail></RequestEmail>
<BoardingRefID></BoardingRefID>
<FederalTaxID></FederalTaxID>
<DBAName></DBAName>
<PhysicalAddress1></PhysicalAddress1>
<PhysicalCity></PhysicalCity>
<PhysicalState></PhysicalState>
<PhysicalZip></PhysicalZip>
<PhysicalCountry></PhysicalCountry>
<PhoneNumber></PhoneNumber>
<PhoneNumberExt></PhoneNumberExt>
<FaxNumber></FaxNumber>
<CustomerServicePhoneNumber></CustomerServicePhoneNumber>
<CustomerServicePhoneNumberExt></CustomerServicePhoneNumberExt>
<WebsiteURL></WebsiteURL>
<BillingAddress1></BillingAddress1>
<BillingCity></BillingCity>
<BillingState></BillingState>
<BillingZip></BillingZip>
<BillingCountry></BillingCountry>
<BusinessStructure></BusinessStructure>
<StockSymbol></StockSymbol>
<DateFormed></DateFormed>
<HowAreSalesGenerated></HowAreSalesGenerated>
<NAICSIndustry></NAICSIndustry>
<ClassificationCode></ClassificationCode>
</Account>
<Contacts>
<PrimaryContact>
<PrimaryContactName></PrimaryContactName>
<PrimaryContactTitle></PrimaryContactTitle>
<PrimaryContactPhoneNumber></PrimaryContactPhoneNumber>
<PrimaryContactPhoneNumberExt></PrimaryContactPhoneNumberExt>
<PrimaryContactEmailAddress></PrimaryContactEmailAddress>
</PrimaryContact>
<SecondaryContact>
<SecondaryContactName></SecondaryContactName>
<SecondaryContactTitle></SecondaryContactTitle>
<SecondaryContactPhoneNumber></SecondaryContactPhoneNumber>
<SecondaryContactPhoneNumberExt></SecondaryContactPhoneNumberExt>
<SecondaryContactEmailAddress></SecondaryContactEmailAddress>
</SecondaryContact>
<PrimaryOfficer>
<PrimaryOfficerName></PrimaryOfficerName>
<PrimaryOfficerTitle></PrimaryOfficerTitle>
<PrimaryOfficerPhoneNumber></PrimaryOfficerPhoneNumber>
<PrimaryOfficerPhoneNumberExt></PrimaryOfficerPhoneNumberExt>
<PrimaryOfficerRole></PrimaryOfficerRole>
<PrimaryOfficerEmailAddress></PrimaryOfficerEmailAddress>
<PrimaryOfficerPercent></PrimaryOfficerPercent>
<PrimaryOfficerDOB></PrimaryOfficerDOB>
<PrimaryOfficerSSN></PrimaryOfficerSSN>
<PrimaryOfficerHomeAddress></PrimaryOfficerHomeAddress>
<PrimaryOfficerCity></PrimaryOfficerCity>
<PrimaryOfficerState></PrimaryOfficerState>
<PrimaryOfficerZip></PrimaryOfficerZip>
<PrimaryOfficerDL></PrimaryOfficerDL>
<PrimaryOfficerDLState></PrimaryOfficerDLState>
</PrimaryOfficer>
<SecondaryOfficer>
<SecondaryOfficerName></SecondaryOfficerName>
<SecondaryOfficerTitle></SecondaryOfficerTitle>
<SecondaryOfficerPhoneNumber></SecondaryOfficerPhoneNumber>
<SecondaryOfficerPhoneNumberExt></SecondaryOfficerPhoneNumberExt>
<SecondaryOfficerRole></SecondaryOfficerRole>
<SecondaryOfficerEmailAddress></SecondaryOfficerEmailAddress>
<SecondaryOfficerPercent></SecondaryOfficerPercent>
<SecondaryOfficerDOB></SecondaryOfficerDOB>
<SecondaryOfficerSSN></SecondaryOfficerSSN>
<SecondaryOfficerHomeAddress>r</SecondaryOfficerHomeAddress>
<SecondaryOfficerCity>S</SecondaryOfficerCity>
<SecondaryOfficerState></SecondaryOfficerState>
<SecondaryOfficerZip></SecondaryOfficerZip>
<SecondaryOfficerDL></SecondaryOfficerDL>
<SecondaryOfficerDLState></SecondaryOfficerDLState>
</SecondaryOfficer>
<TertiaryOfficer>
<TertiaryOfficerName></TertiaryOfficerName>
<TertiaryOfficerTitle></TertiaryOfficerTitle>
<TertiaryOfficerPhoneNumber></TertiaryOfficerPhoneNumber>
<TertiaryOfficerPhoneNumberExt></TertiaryOfficerPhoneNumberExt>
<TertiaryOfficerRole></TertiaryOfficerRole>
<TertiaryOfficerEmailAddress></TertiaryOfficerEmailAddress>
<TertiaryOfficerPercent></TertiaryOfficerPercent>
<TertiaryOfficerDOB></TertiaryOfficerDOB>
<TertiaryOfficerSSN></TertiaryOfficerSSN>
<TertiaryOfficerHomeAddress></TertiaryOfficerHomeAddress>
<TertiaryOfficerCity></TertiaryOfficerCity>
<TertiaryOfficerState></TertiaryOfficerState>
<TertiaryOfficerZip></TertiaryOfficerZip>
<TertiaryOfficerDL></TertiaryOfficerDL>
<TertiaryOfficerDLState></TertiaryOfficerDLState>
</TertiaryOfficer>
<QuaternaryOfficer>
<QuaternaryOfficerName></QuaternaryOfficerName>
<QuaternaryOfficerTitle>C</QuaternaryOfficerTitle>
<QuaternaryOfficerPhoneNumber></QuaternaryOfficerPhoneNumber>
<QuaternaryOfficerPhoneNumberExt></QuaternaryOfficerPhoneNumberExt>
<QuaternaryOfficerRole></QuaternaryOfficerRole>
<QuaternaryOfficerEmailAddress></QuaternaryOfficerEmailAddress>
<QuaternaryOfficerPercent></QuaternaryOfficerPercent>
<QuaternaryOfficerDOB></QuaternaryOfficerDOB>
<QuaternaryOfficerSSN></QuaternaryOfficerSSN>
<QuaternaryOfficerHomeAddress></QuaternaryOfficerHomeAddress>
<QuaternaryOfficerCity></QuaternaryOfficerCity>
<QuaternaryOfficerState></QuaternaryOfficerState>
<QuaternaryOfficerZip></QuaternaryOfficerZip>
<QuaternaryOfficerDL></QuaternaryOfficerDL>
<QuaternaryOfficerDLState></QuaternaryOfficerDLState>
</QuaternaryOfficer>
</Contacts>
<Opportunity>
<OpportunityName></OpportunityName>
<CloseDate></CloseDate>
<RecordType></RecordType>
<Amount></Amount>
<ScannerMake></ScannerMake>
<ScannerSerialNumber></ScannerSerialNumber>
<FaceAmountRePresentments></FaceAmountRePresentments>
<TimingOfFirstPresentment></TimingOfFirstPresentment>
<TimeFinalPresentment></TimeFinalPresentment>
<TimingOfFinalPresentment></TimingOfFinalPresentment>
<ReturnedCheckPresentments></ReturnedCheckPresentments>
<ReturnedCheckFeeAmount></ReturnedCheckFeeAmount>
<FinancialInstitutionAccount></FinancialInstitutionAccount>
<SettlementABA></SettlementABA>
<SettlementAccount></SettlementAccount>
<NotesSpecialInstructions></NotesSpecialInstructions>
<Check21FaceAmountRePresentments></Check21FaceAmountRePresentments>
<Check21AutomatedRePresentment></Check21AutomatedRePresentment>
<Check21TimeFinalPresentment></Check21TimeFinalPresentment>
<Check21TimingOfFinalPresentment></Check21TimingOfFinalPresentment>
<Check21FinancialInstitutionAccount></Check21FinancialInstitutionAccount>
<Check21ABA></Check21ABA>
<Check21Account></Check21Account>
<MerchDebitSingleTransAmount></MerchDebitSingleTransAmount>
<MerchDebitSingleDayCount></MerchDebitSingleDayCount>
<MerchDebitSingleDayAmount></MerchDebitSingleDayAmount>
<MerchDebitPeriodCount></MerchDebitPeriodCount>
<MerchDebitPeriodAmount></MerchDebitPeriodAmount>
<MerchCreditSingleTransAmount></MerchCreditSingleTransAmount>
<MerchCreditSingleDayCount></MerchCreditSingleDayCount>
<MerchCreditSingleDayAmount></MerchCreditSingleDayAmount>
<MerchCreditPeriodCount></MerchCreditPeriodCount>
<MerchCreditPeriodAmount></MerchCreditPeriodAmount>
<SingleAmountPercentage></SingleAmountPercentage>
<DailyPercentage></DailyPercentage>
<PeriodPercentage></PeriodPercentage>
<Recipient1VelocityEmailAddress></Recipient1VelocityEmailAddress>
<Recipient2VelocityEmailAddress></Recipient2VelocityEmailAddress>
<Recipient3VelocityEmailAddress></Recipient3VelocityEmailAddress>
<Recipient4VelocityEmailAddress></Recipient4VelocityEmailAddress>
<Recipient5VelocityEmailAddress></Recipient5VelocityEmailAddress>
<Recipient1FIEmailAddress></Recipient1FIEmailAddress>
<Recipient2FIEmailAddress></Recipient2FIEmailAddress>
<Recipient3FIEmailAddress></Recipient3FIEmailAddress>
<Recipient4FIEmailAddress></Recipient4FIEmailAddress>
</Opportunity>
<CustomerLocations>
<Location>
<BankName></BankName>
<RoutingNumber></RoutingNumber>
<AccountNumber></AccountNumber>
<AccountType></AccountType>
<DebitSingleTransAmount></DebitSingleTransAmount>
<DebitSingleDayCount></DebitSingleDayCount>
<DebitSingleDayAmount></DebitSingleDayAmount>
<DebitPeriodCount></DebitPeriodCount>
<DebitPeriodAmount></DebitPeriodAmount>
<CreditSingleTransAmount></CreditSingleTransAmount>
<CreditSingleDayCount></CreditSingleDayCount>
<CreditSingleDayAmount></CreditSingleDayAmount>
<CreditPeriodCount></CreditPeriodCount>
<CreditPeriodAmount></CreditPeriodAmount>
<LocationLegalName></LocationLegalName>
<LocationDBAName></LocationDBAName>
<LocationBusinessTaxID></LocationBusinessTaxID>
<LocationAddressSameAsCompany></LocationAddressSameAsCompany>
<LocationAddress1></LocationAddress1>
<LocationAddress2></LocationAddress2>
<LocationCity></LocationCity>
<LocationState></LocationState>
<LocationZip></LocationZip>
</Location>
</CustomerLocations>
</APIIntegration>
</api:API-IntegrationRequest>
XML Response: (Note: The highlighted values are specific to the application.)
<APIIntegrationSalesforceResponse>
<result>Application Created</result>
<transaction_id>006f400000E5Yi7AAF</transaction_id>
<code>200</code>
<message>Success</message>
<application_id>00000266</application_id>
</APIIntegrationSalesforceResponse>
REST Data Format (JSON)
{
"APIIntegration": {
"Account": {
"custServProviderId": "",
"CustomerName": "",
"RequestEmail": "",
"BoardingRefID": "",
"FederalTaxID": "",
"DBAName": "",
"PhysicalAddress1": "",
"PhysicalCity": "",
"PhysicalState": "",
"PhysicalZip": "",
"PhysicalCountry": "",
"PhoneNumber": "",
"PhoneNumberExt": "",
"CustomerServicePhoneNumber": "",
"CustomerServicePhoneNumberExt": "",
"WebsiteURL": "",
"BillingAddress1": "",
"BillingCity": "",
"BillingState": "",
"BillingZip": "",
"BillingCountry": "",
"BusinessStructure": "",
"StockSymbol": "",
"DateFormed": "",
"HowAreSalesGenerated": "",
"NAICSIndustry": "",
"ClassificationCode": ""
},
"Contacts": {
"PrimaryContact": {
"PrimaryContactName": "",
"PrimaryContactTitle": "",
"PrimaryContactPhoneNumber": "",
"PrimaryContactPhoneNumberExt": "",
"PrimaryContactEmailAddress": ""
},
"SecondaryContact": {
"SecondaryContactName": "",
"SecondaryContactTitle": "",
"SecondaryContactPhoneNumber": "",
"SecondaryContactPhoneNumberExt": "",
"SecondaryContactEmailAddress": ""
},
"PrimaryOfficer": {
"PrimaryOfficerName": "",
"PrimaryOfficerTitle": "",
"PrimaryOfficerPhoneNumber": "",
"PrimaryOfficerPhoneNumberExt": "",
"PrimaryOfficerRole": "",
"PrimaryOfficerEmailAddress": "",
"PrimaryOfficerPercent": "",
"PrimaryOfficerDOB": "",
"PrimaryOfficerSSN": "",
"PrimaryOfficerHomeAddress": "",
"PrimaryOfficerCity": "",
"PrimaryOfficerState": "",
"PrimaryOfficerZip": "",
"PrimaryOfficerDL": "",
"PrimaryOfficerDLState": ""
},
"SecondaryOfficer": {
"SecondaryOfficerName": "",
"SecondaryOfficerTitle": "",
"SecondaryOfficerPhoneNumber": "",
"SecondaryOfficerPhoneNumberExt": "",
"SecondaryOfficerRole": "",
"SecondaryOfficerEmailAddress": "",
"SecondaryOfficerPercent": "",
"SecondaryOfficerDOB": "",
"SecondaryOfficerSSN": "",
"SecondaryOfficerHomeAddress": "",
"SecondaryOfficerCity": "",
"SecondaryOfficerState": "",
"SecondaryOfficerZip": "",
"SecondaryOfficerDL": "",
"SecondaryOfficerDLState": ""
},
"TertiaryOfficer": {
"TertiaryOfficerName": "",
"TertiaryOfficerTitle": "",
"TertiaryOfficerPhoneNumber": "",
"TertiaryOfficerPhoneNumberExt": "",
"TertiaryOfficerRole": "",
"TertiaryOfficerEmailAddress": "",
"TertiaryOfficerPercent": "",
"TertiaryOfficerDOB": "",
"TertiaryOfficerSSN": "",
"TertiaryOfficerHomeAddress": "",
"TertiaryOfficerCity": "",
"TertiaryOfficerState": "",
"TertiaryOfficerZip": "",
"TertiaryOfficerDL": "",
"TertiaryOfficerDLState": ""
},
"QuaternaryOfficer": {
"QuaternaryOfficerName": "",
"QuaternaryOfficerTitle": "",
"QuaternaryOfficerPhoneNumber": "",
"QuaternaryOfficerPhoneNumberExt": "",
"QuaternaryOfficerRole": "",
"QuaternaryOfficerEmailAddress": "",
"QuaternaryOfficerPercent": "",
"QuaternaryOfficerDOB": "",
"QuaternaryOfficerSSN": "",
"QuaternaryOfficerHomeAddress": "",
"QuaternaryOfficerCity": "",
"QuaternaryOfficerState": "",
"QuaternaryOfficerZip": "",
"QuaternaryOfficerDL": "",
"QuaternaryOfficerDLState": ""
}
},
"Opportunity": {
"OpportunityName": "",
"CloseDate": "",
"Amount": "",
"RecordType": "",
"ScannerMake": "",
"ScannerSerialNumber": "",
"FaceAmountRePresentments": "",
"TimingOfFirstPresentment ": "",
"TimeFinalPresentment": "",
"TimingOfFinalPresentment ": "",
"ReturnedCheckPresentments": "",
"ReturnedCheckFeeAmount": "",
"FinancialInstitutionAccount": "",
"SettlementABA": "",
"SettlementAccount": "",
"NotesSpecialInstructions": "",
"Check21FaceAmountRePresentments": "",
"Check21AutomatedRePresentment": "",
"Check21TimeFinalPresentment": "",
"Check21TimingOfFinalPresentment": "",
"Check21FinancialInstitutionAccount": "",
"Check21ABA": "",
"Check21Account": "",
"MerchDebitSingleTransAmount": "",
"MerchDebitSingleDayCount": "",
"MerchDebitSingleDayAmount": "",
"MerchDebitPeriodCount": "",
"MerchDebitPeriodAmount": "",
"MerchCreditSingleTransAmount": "",
"MerchCreditSingleDayCount": "",
"MerchCreditSingleDayAmount": "",
"MerchCreditPeriodCount": "",
"MerchCreditPeriodAmount": "",
"SingleAmountPercentage": "",
"DailyPercentage": "",
"PeriodPercentage": "",
"Recipient1VelocityEmailAddress": "",
"Recipient2VelocityEmailAddress": "",
"Recipient3VelocityEmailAddress": "",
"Recipient4VelocityEmailAddress": "",
"Recipient5VelocityEmailAddress": "",
"Recipient1FIEmailAddress ": "",
"Recipient2FIEmailAddress ": "",
"Recipient3FIEmailAddress ": "",
"Recipient4FIEmailAddress ": ""
},
"CustomerLocations": {
"Location": [
{
"BankName": "",
"RoutingNumber": "",
"AccountNumber": "",
"AccountType": "",
"Debit_SingleTransAmount": "",
"Debit_SingleDayCount": "",
"Debit_SingleDayAmount": "",
"Debit_PeriodCount": "",
"Debit_PeriodAmount": "",
"Credit_SingleTransAmount": "",
"Credit_SingleDayCount": "",
"Credit_SingleDayAmount": "",
"Credit_PeriodCount": "",
"Credit_PeriodAmount": "",
"LocationLegalName": "",
"LocationDBAName": "",
"LocationBusinessTaxID": "",
"LocationAddressSameAsCompany": "",
"LocationAddress1": "",
"LocationAddress2": "",
"LocationCity": "",
"LocationState": "",
"LocationZip": ""
}
]
}
}
}