Zip and Country Codes|
Development
Reference Materials
Onboarding Application Wizard (Merchant) 
Description: Provides access to onboarding wizard that allows onboarding of a merchant.
Onboarding Wizard |
|
Includes settings that allow merchant creation with the help of onboarding wizard.
|
| ¦_ |
Save
|
Saves all information on the form. |
| ¦_ |
Close
|
Closes the form without saving any changes. |
| ¦_ |
Previous
|
Returns to the previous step. |
| ¦_ |
Next
|
Proceeds to the next step. |
| ¦_ |
Skip
|
Skips the current step. |
Select Portfolio |
|
Includes the list of available portfolios and associated onboarding profiles.
|
Portfolio |
|
Includes the list of available portfolios. After a portfolio is selected, the list of the processors available for this portfolio will be shown.
|
Onboarding Profile |
|
Includes the list of available onboarding profiles associated with the selected portfolio.
|
General |
|
Provides access to general merchant settings.
|
Detail |
|
Includes general settings that identify the merchant within the system.
|
| ¦_ |
Tax ID
|
Federal tax identifier of the company.
References: Provisioning Transaction.Business Info Federal Tax ID
|
| ¦_ |
Verify
|
Allows to verify the specified tax ID. |
| ¦_ |
Portfolio
|
Reference to the entity that represents the portfolio attached to the merchant.
References: Merchant.Portfolio FK
|
| ¦_ |
ID
|
Identification number of the merchant within the system. |
| ¦_ |
Get Next Available Merchant ID
|
Allows to generate merchant ID automatically. |
| ¦_ |
Active
|
Indicates whether the record is active and can process through the system.
References: Merchant.Is Active
|
| ¦_ |
Code
|
Unique identifier of the merchant generated by the gateway.
References: Merchant.Code
|
| ¦_ |
Name
|
DBA ("doing business as") name of the merchant. The value of this field is automatically copied from Business Name field from Business section (during both merchant information modify and merchant onboarding process). |
| ¦_ |
Time Zone
|
This field consists of two parts - a code of the country and a code of the time zone.
Time zone of a merchant.
References: Merchant.Time Zone Code
|
Submerchant |
|
Includes settings of the merchant account that will be created along with the merchant.
|
| ¦_ |
Name
|
DBA ("doing business as") name of the submerchant. |
| ¦_ |
Code
|
Unique identifier of the merchant account generated by the system, divisible by 1000.
References: Merchant Account.Code
|
Settings |
|
Includes general processing settings of the merchant.
|
| ¦_ |
Profile
|
Set of parameters that are used to govern the setup of the merchant with the respect to its merchant account, merchant IDs, descriptors and deposit accounts. |
| ¦_ |
Accounts
|
Defines whether it is a multi-location / multi-terminal or single-location / single-terminal merchant. |
| ¦_ |
Single
|
Indicates that everything is configured at the merchant level. Other parameters in the profile are ignored. |
| ¦_ |
Multiple
|
Indicates that multiple merchant accounts will be set up. The settings will be configured based on the remaining parameters on the profile. |
|
Tax IDs
|
Defines whether a single federal tax ID will be used for all locations or each tax ID will be used specifically per each of the locations. |
| ¦_ |
Single
|
Indicates that the legal entity owning the tax ID is represented with a merchant. |
| ¦_ |
Multiple
|
Indicates that the legal entity owning the tax ID is represented with a merchant account. |
|
Descriptors
|
Defines the desired number of soft descriptors to be used all across the accounts. |
| ¦_ |
Single
|
Indicates that a single merchant ID (MID) is required for processing. |
| ¦_ |
Multiple
|
Indicates that for the majority of the processors, multiple MIDs will be required for processing; one MID per descriptor. |
|
Deposit Accounts
|
Defines the number of deposit accounts to use for remittance. |
| ¦_ |
Single
|
Indicates that all remittance settings are configured on the merchant level. All of the money is funded to a single deposit account regardless of the number of used merchant accounts. |
| ¦_ |
Multiple
|
Indicates that all remittance settings are configured on the merchant account level. The money processed to each merchant account is funded separately in a separate deposit account. |
|
Recurring Fees
|
Defines how the recurring fees are charged. |
| ¦_ |
Per Merchant
|
Indicates that recurring fees are only charged once regardless of the number of accounts under a merchant. |
| ¦_ |
Per Account
|
Indicates that recurring fees are charged per each account set up under a merchant. |
|
Reseller
|
Reference to the entity that represents the reseller associated with the merchant.
References: Merchant.Reseller FK
|
|
Notes
|
Provides a place to store short generic notes about the merchant.
References: Merchant.Notes
|
Merchant |
|
Includes merchant creation settings.
|
| ¦_ |
Merchant Creation Policy
|
Reference to the entity that represents enumeration of merchant creation policy values.
References: Onboarding Application.Merchant Creation Policy CL
|
| ¦_ |
On Approval Only
|
Indicates that a merchant is created when an onboarding application is approved by a processor. |
| ¦_ |
On Approval And Review
|
Indicates that a merchant is created when an onboarding application either in review or approved by a processor. |
Business |
|
Provides access to various business information about the merchant.
|
Business Information |
|
Includes business information about the merchant.
|
Business Name |
|
Includes information about business names of the merchant.
|
| ¦_ |
Legal
|
Legal name of the business company.
References: Onboarding Business Info.Legal Name
|
| ¦_ |
DBA
|
DBA ("doing business as") name of the merchant. The value in this field is automatically copied from the Name field in General section. |
|
Ownership Type
|
Represents the type of ownership structure.
References: Onboarding Business Info.Onboarding Ownership Structure
|
|
Relationship Begin Date
|
Date when business relationship began.
References: Onboarding Business Info.Relationship Begin Date
|
|
Tax ID
|
Identifier of the assigned federal tax.
References: Onboarding Business Info.Tax ID
|
|
MCC
|
Code of the associated category of the merchant.
References: Onboarding Business Info.Merchant Category Code
|
Business Registration |
|
Includes business registration information associated with the merchant.
|
| ¦_ |
State
|
State of the business entity registration.
References: Onboarding Business Info.Registration State
|
| ¦_ |
Year
|
Year when business entity was registered.
References: Onboarding Business Info.Registration Year
|
Legal Address |
|
Includes information about business legal address of the merchant.
|
| ¦_ |
Copy Data From
|
Allows to copy information from the selected source. |
| ¦_ |
Owner Address
|
Allows to copy information from the primary owner address. |
|
Street (line 1)
|
Street (line 1) of the business company mailing address.
References: Onboarding Business Info.Street 1
|
|
Street (line 2)
|
Street (line 2) of the business company mailing address.
References: Onboarding Business Info.Street 2
|
|
City
|
City of the mailing address.
References: Onboarding Business Info.City
|
|
Country
|
Country code of the business company mailing address.
References: Onboarding Business Info.Country Code
|
|
State
|
State code of the business company mailing address.
References: Onboarding Business Info.State
|
|
Zip Code/Postal Code
|
ZIP (or postal) code of the business company mailing address.
References: Onboarding Business Info.ZIP Code
|
|
Email
|
Email address asigned to the record.
References: Onboarding Business Info.Email
|
|
Phone
|
Contact phone of the business company for discussing any processing issues.
References: Onboarding Business Info.Contact Phone
|
|
Work Hours
|
Work hours of the business entity.
References: Onboarding Business Info.Work Hours
|
|
Web Site
|
Web site URL of the business company.
References: Onboarding Business Info.Web Site
|
Owners |
|
Includes information about the business owners.
|
| ¦_ |
Add Owner
|
Allows adding the number of owners one-by-one, but not more than 4. |
| ¦_ |
Controlling Officer is
|
Allows selecting a controlling officer of a business. These radio buttons are available for certain ownership types for which an officer is required to be present. |
| ¦_ |
Not an Owner
|
Indicates that the controlling officer is not an owner. |
| ¦_ |
an Owner
|
Indicates that the controlling officer is one of the business owners. |
Owner |
|
Includes information about the owner.
|
| ¦_ |
First Name*
|
Business owner's first name.
References: Business Owner.First Name
|
| ¦_ |
Last Name*
|
Business owner's last name.
References: Business Owner.Last Name
|
| ¦_ |
Email
|
Business owner's e-mail.
References: Business Owner.Email
|
| ¦_ |
Phone
|
Business owner's phone number.
References: Business Owner.Phone
|
| ¦_ |
SIN/SSN/Tax ID
|
Business owner's social security number.
References: Business Owner.Social Security
|
| ¦_ |
Title
|
Business owner's title. References: Business Contact.Title
|
| ¦_ |
Birth Date
|
Business owner's birth date.
References: Business Owner.Birth Date
|
| ¦_ |
Stake %
|
Business owner's stake percentage. References: Business Owner.Stake Percentage
|
Address Information |
|
Address of the owner.
|
| ¦_ |
Street 1
|
Street (line 1) associated with business owner's address.
References: Business Owner.Street1
|
| ¦_ |
Street 2
|
Street (line 2) associated with business owner's address.
References: Business Owner.Street2
|
| ¦_ |
City*
|
City associated with business owner's address.
References: Business Owner.City
|
| ¦_ |
Province*/State*
|
State associated with business owner's address.
References: Business Owner.State
|
| ¦_ |
Postal Code*/Zip Code*
|
ZIP/postal code associated with business owner's address.
References: Business Owner.ZIP Code
|
Government Issued ID |
|
Includes information about owner's driver license.
|
| ¦_ |
Driver License
|
The number of owner's driver license. |
| ¦_ |
Province Issued /State Issued
|
State where business owner's driver license was issued.
References: Business Owner.Driver License State
|
Estimates |
|
Provides access to merchant's estimates.
|
Estimates (Transaction Amount) |
|
Includes settings related to estimated transactions' count and volume.
|
| ¦_ |
Estimation Period
|
Enumeration of possible time periods for which transaction volume and average transaction amount are defined.
References: Business Info.Estimation Period CL
|
| ¦_ |
Annualy
|
Indicates that transaction volume and average transaction amount are defined for a year. |
| ¦_ |
Daily
|
Indicates that transaction volume and average transaction amount are defined for a day. |
| ¦_ |
Monthly
|
Indicates that transaction volume and average transaction amount are defined for a month. |
| ¦_ |
Weekly
|
Indicates that transaction volume and average transaction amount are defined for a week. |
|
Total Volume
|
Estimated number of the payment card transactions within a year.
References: Onboarding Business Info.Annual Cards Volume
|
|
Avg Ticket
|
Estimated average amount of the payment card transactions within a year.
References: Onboarding Business Info.Avg Cards Transaction Amount
|
|
Max Ticket
|
Maximum allowed amount of transactions.
References: Onboarding Business Info.Max Transaction Amount
|
Settings |
|
Provides access to additional merchant settings.
|
Profile List |
|
Includes the list of available profiles.
|
| ¦_ |
Configuration
|
Onboarding configuration that includes one or more processor profiles. |
Descriptors |
|
Includes descriptors of the merchant.
|
| ¦_ |
Card Descriptor
|
Descriptor assigned to payment card transactions associated with the merchant. Shows up on cardholder statements.
References: Onboarding Business Info.Card Descriptor
|
| ¦_ |
Direct Debit Descriptor
|
Direct debit transaction descriptor that consists of two parts: descriptor value assigned by the merchant (entered within Item textbox) and name of the merchant's company (entered within Merchant textbox). |
| ¦_ |
Merchant
|
Name of the merchant's company. Shown on account holder statements.
References: Onboarding Business Info.Direct Debit Descriptor Merchant Name
|
| ¦_ |
Item
|
Descriptor assigned to direct debit transactions associated with the merchant. Shows up on account holder statements.
References: Onboarding Business Info.Direct Debit Descriptor
|
|
Customer Service Phone
|
Customer service phone. Shown on payment card or account holder statements.
References: Onboarding Business Info.Descriptor Phone
|
Terminals |
|
Includes information about merchant's terminals.
|
| ¦_ |
Industry Type
|
Allows to select for which industry terminal(s) is/are going to be used. |
| ¦_ |
Retail
|
Indicates that the terminal is going to be used in the retail industry. |
| ¦_ |
Restaurant
|
Indicates that the terminal is going to be used in the restaurant industry. |
|
Quantity
|
Number of the terminals that are to obtain TID(s) during the onboarding process. |
Remittance |
|
Includes remittance settings of the merchant.
|
Deposit Information |
|
Includes deposit settings of the merchant.
|
| ¦_ |
Bank Name
|
Name of the deposit account assigned by the bank.
References: Onboarding Business Info.Deposit Bank Name
|
| ¦_ |
Bank Phone
|
Telephone number of the bank associated with merchant's deposit account.
References: Onboarding Business Info.Deposit Bank Phone
|
| ¦_ |
Holder Name
|
Name of the deposit account holder.
References: Onboarding Business Info.Deposit Holder Name
|
| ¦_ |
Account #
|
Number of the deposit account assigned by the bank.
References: Onboarding Business Info.Deposit Account Number
|
| ¦_ |
Show account number
|
Shows number of the deposit account assigned by the bank. |
| ¦_ |
Routing #
|
Routing number of the bank deposit account.
References: Onboarding Business Info.Deposit Routing Number
|
| ¦_ |
Token
|
Value issued by the internal tokenization system that replaces actual bank account and routing number. Using this value system can obtain the real bank account number and routing number and use them for further processing. |
Merchant Fees |
|
Includes fee settings of the merchant.
|
| ¦_ |
Pricing Policy
|
Code of the fee template assigned to this record.
References: Onboarding Business Info.Fee Template Code
|
| ¦_ |
Annual Fee Month
|
Allows to select a month when an annual fee should be collected. |
Process |
|
Provides access to merchant's verification process.
|
Process List |
|
Includes detailed information about merchant's verification process.
|
| ¦_ |
Stage
|
Stage of the merchant onboarding process. References: Onboarding Application.Onboarding Application
|
| ¦_ |
Date
|
Date and time of the stage completion. References: Onboarding Application.Onboarding Application
|
| ¦_ |
Status
|
Status of the stage completion. References: Onboarding Application.Verification Request Status Cl
|
| ¦_ |
Application Status
|
Represents current status of the application.
References: Onboarding Application.Status Cl
|
| ¦_ |
Underwriting
|
Provides access to underwriting options. |
| ¦_ |
Application submission
|
Application record creating stage. |
| ¦_ |
Verification (request)
|
Merchant verification process stage (request). |
| ¦_ |
Verification (response)
|
Merchant verification process stage (response). |
| ¦_ |
Underwriting/MID (request)
|
Stage of sending data to the provider. |
| ¦_ |
Underwriting/MID (response)
|
Stage of receiving a response from the provider. |
|
Configuration
|
Provides access to the list of available terminal configurations. |
| ¦_ |
Merchant configuration
|
Merchant configuration stage. |
| ¦_ |
FTP Folder configuration
|
FTP Folder configuration stage. |
| ¦_ |
Provider Profiles configuration
|
Provider Profiles configuration stage. |
| ¦_ |
Merchant Fees configuration
|
Merchant Fees configuration stage. |
| ¦_ |
Billing Settings configuration
|
Billing Settings configuration stage. |
|
Available Actions
|
Available actions for change statuses. |
| ¦_ |
Rejected
|
Reject status of application. The button is available if only processor answer is:
- Approved.
- Approved_Warning.
- In review.
- Needs Correct.
- Error. |
|
Details
|
Allows viewing processor response details. The Onboarding Transaction List form is available for Underwriting/MID (response) stage only. Opens Form:
Onboarding Transaction List
|
Provisioning Requests List |
|
Includes the list of provisioning requests sent to the processor.
|
| ¦_ |
ID
|
Identifier of the object used for references; auto-incremented integer value.
References: Provisioning Transaction.Id
|
| ¦_ |
Request Date
|
Date of the request.
References: Provisioning Transaction.Request Date
|
| ¦_ |
Type
|
Type of the request associated with the transaction.
References: Provisioning Transaction.Request Type
|
| ¦_ |
Response Date
|
Date of the transaction response.
References: Provisioning Transaction.Response Date
|
| ¦_ |
Status
|
Represents current transaction status.
References: Provisioning Transaction.Status Cl
|
| ¦_ |
Show Processor Identities
|
Allows to review processor identities associated with the onboarded merchant. |
| ¦_ |
Show Request Details
|
Allows to review processor response details. |
Provisioning Info |
|
Includes the provisioning information of the merchant.
|
Details |
|
Allows viewing agreement details.
|
| ¦_ |
Client Host
|
IP address associated with API call sent by the merchant. References: Onboarding Application.Client Host
|
| ¦_ |
Agreement Version
|
The current version of agreement.
Reference to the entity that represents onboard agreement document.
References: Onboarding Application.Onboarding Agreement
|
| ¦_ |
View Agreement
|
Opening the Onboarding Agreement form. Opens Form:
Agreements
|
| | 