Zip and Country Codes|
Development
Reference Materials
Provisioning New Account 
Description: Provides access to new merchant account provisioning options.
Provisioning Wizard |
|
Includes various options to create a new merchant with the help of provisioning wizard.
|
| ¦_ |
Save
|
Saves all information on the form. |
| ¦_ |
Close
|
Closes the form without saving any changes. |
| ¦_ |
Previous
|
Allows to move to the previous page. |
| ¦_ |
Next
|
Allows to move to the next page. |
| ¦_ |
Skip
|
Allows to skip the next page. |
| ¦_ |
select processor
|
Allows to select a processor for merchant provisioning. |
| ¦_ |
vantiv-tandem
|
Indicates that merchant is going to be provisioned by Vantiv Tandem. |
| ¦_ |
firstdata
|
Indicates that merchant is going to be provisioned by FirstData. |
| ¦_ |
propay
|
Indicates that merchant is going to be provisioned by ProPay. |
general (a) |
|
Provides access to general information about the merchant.
|
Detail |
|
Includes various options to create a new merchant.
|
| ¦_ |
Portfolio
|
Reference to the entity that represents the portfolio attached to the merchant.
References: Merchant.Portfolio FK
|
| ¦_ |
ID
|
Identification number of the merchant in the system. |
| ¦_ |
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
|
The DBA name of the merchant.
References: Merchant.Name
|
| ¦_ |
Time Zone
|
Time zone of a merchant.
References: Merchant.Time Zone Code
|
Settings |
|
Includes detailed merchant settings.
|
| ¦_ |
Remitter
|
Reference to a merchant that contains settings necessary to execute remittance operations.
References: Merchant.Remitter FK
|
| ¦_ |
Notes
|
Provides a place to store short generic notes about the merchant.
References: Merchant.Notes
|
business (a) |
|
Provides access to various required business information about the merchant.
|
Business Information |
|
Includes business information about the merchant.
|
| ¦_ |
Federal Tax ID
|
Federal Tax identifier of the company.
References: Business Info.Federal Tax ID
|
| ¦_ |
State Tax ID
|
State Tax identifier of the company.
References: Business Info.State Tax ID
|
| ¦_ |
Sales Tax ID
|
Sale Tax identifier of the company.
References: Business Info.Sale Tax ID
|
| ¦_ |
Legal Business Name
|
The legal name of the company.
References: Business Info.Legal Name
|
| ¦_ |
DBA Business Name
|
The DBA ("doing business as") name.
References: Business Info.Business Name
|
| ¦_ |
Ownership Structure
|
Enumeration of possible ownership types of the company.
References: Business Info.Ownership Structure CL
|
| ¦_ |
Business Registration Country
|
The country where the merchant's business was established.
References: Business Info.Registration Country Code
|
| ¦_ |
Business Registration State
|
The state where the merchant's business was established.
References: Business Info.Registration State
|
| ¦_ |
Business Registration Year
|
The year when the merchant's business was established.
References: Business Info.Registration Year
|
| ¦_ |
Relationship Begin Date
|
Date when the business relationship with this company was officially established.
References: Business Info.Relationship Begin Date
|
Legal Address |
|
Includes information about business legal address of the merchant.
|
| ¦_ |
Copy Data From
|
Allows to copy information from the selected source. |
| ¦_ |
Contact Address
|
Allows to copy information from the contact address. |
|
Street
|
Street1 of a company's mailing address.
References: Business Info.Street1
|
|
City
|
City name of a company's mailing address.
References: Business Info.City
|
|
Country
|
Country code of a company's mailing address.
References: Business Info.Country Code
|
|
State
|
State of a company's mailing address.
References: Business Info.State
|
|
Zip Code/Postal Code
|
ZIP code of a company's mailing address.
References: Business Info.ZIP Code
|
|
Email
|
Email address of a company.
References: Business Info.Email
|
|
Phone
|
Phone number of the customer service.
References: Business Info.Customer Service Phone
|
|
Work Hours
|
Working hours of the company.
References: Business Info.Work Hours
|
|
Web Site
|
URL of the corporate website of the company.
References: Business Info.WEB Site
|
Contact Address |
|
Includes contact address of the merchant.
|
| ¦_ |
Copy Data From
|
Allows to copy information from the selected source. |
| ¦_ |
Legal Address
|
Allows to copy information from the legal address. |
|
Name
|
Name of the contact person for this merchant account.
References: Merchant Account.Contact Name
|
|
Street
|
Street1 of the merchant's mailing address
References: Merchant Account.Street1
|
|
City
|
City of the merchant's mailing address
References: Merchant Account.City
|
|
Country
|
Country code of the merchant's mailing address
References: Merchant Account.Country Code
|
|
State
|
State code of the merchant's mailing address
References: Merchant Account.State
|
|
Zip Code/Postal Code
|
ZIP code of the merchant's mailing address.
References: Merchant Account.ZIP Code
|
|
Email
|
Email associated with this merchant account
References: Merchant Account.Email
|
|
Phone
|
Phone number associated with this merchant account
References: Merchant Account.Phone
|
owners (a) |
|
Provides access to various business information about the owner.
|
Primary Owner |
|
Includes general information about primary owner.
|
| ¦_ |
Copy Data From
|
Allows to copy information from the selected source. |
| ¦_ |
Legal Address
|
Allows to copy information from the legal address. |
| ¦_ |
Contact Address
|
Allows to copy information from the contact address. |
Personal |
|
Includes personal information about primary 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
|
| ¦_ |
Birth Date
|
Business owner's birth date.
References: Business Owner.Birth Date
|
| ¦_ |
Social Security
|
Business owner's social security number.
References: Business Owner.Social Security
|
Driver Licence |
|
Includes information about primary owner's driver licence.
|
| ¦_ |
Number
|
Business owner's driver's license number.
References: Business Owner.Driver License
|
| ¦_ |
Country
|
Country code associated with business owner's address.
References: Business Owner.Country Code
|
| ¦_ |
State
|
State where business owner's driver license was issued.
References: Business Owner.Driver License State
|
Address |
|
Includes primary owner's address.
|
| ¦_ |
Street (line 1)
|
Street (line 1) associated with business owner's address.
References: Business Owner.Street1
|
| ¦_ |
Street (line 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
|
| ¦_ |
Country
|
Country code associated with business owner's address.
References: Business Owner.Country Code
|
| ¦_ |
State
|
State associated with business owner's address.
References: Business Owner.State
|
| ¦_ |
Zip Code/Postal Code
|
ZIP/postal code associated with business owner's address.
References: Business Owner.ZIP Code
|
Secondary Owner |
|
Includes general information about secondary owner.
|
| ¦_ |
Copy Data From
|
Allows to copy information from the selected source. |
| ¦_ |
Legal Address
|
Allows to copy information from the legal address. |
| ¦_ |
Contact Address
|
Allows to copy information from the contact address. |
Personal |
|
Includes personal information about secondary 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
|
| ¦_ |
Birth Date
|
Business owner's birth date.
References: Business Owner.Birth Date
|
| ¦_ |
Social Security
|
Business owner's social security number.
References: Business Owner.Social Security
|
Driver Licence |
|
Includes information about secondary owner's driver licence.
|
| ¦_ |
Country
|
Country code associated with business owner's address.
References: Business Owner.Country Code
|
| ¦_ |
State
|
State where business owner's driver license was issued.
References: Business Owner.Driver License State
|
| ¦_ |
Number
|
Business owner's driver's license number.
References: Business Owner.Driver License
|
Address |
|
Includes secondary owner's address.
|
| ¦_ |
Street (line 1)
|
Street (line 1) associated with business owner's address.
References: Business Owner.Street1
|
| ¦_ |
Street (line 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
|
| ¦_ |
Country
|
Country code associated with business owner's address.
References: Business Owner.Country Code
|
| ¦_ |
State
|
State associated with business owner's address.
References: Business Owner.State
|
| ¦_ |
Zip Code/Postal Code
|
ZIP/postal code associated with business owner's address.
References: Business Owner.ZIP Code
|
contacts (a) |
|
Provides access to contact information of the merchant.
|
Contacts |
|
Includes contact information associated with the merchant.
|
| ¦_ |
Type
|
Type of a customer service contact. Includes finance, operation and technical ones. |
| ¦_ |
Last (Family) Name
|
Last name of the contact. |
| ¦_ |
First Name
|
First name of the contact. |
| ¦_ |
Middle Name
|
Middle name of the contact. |
| ¦_ |
Title
|
Title of the contact. |
| ¦_ |
Phone
|
Phone of the contact. |
| ¦_ |
Email
|
Email of the contact. |
| ¦_ |
Copy From
|
Allows to copy information from the selected source. |
| ¦_ |
Finance
|
Allows to copy information from the finance contact. |
| ¦_ |
Operation
|
Allows to copy information from the operation contact. |
| ¦_ |
Technical
|
Allows to copy information from the technical contact. |
Adresses |
|
Includes various addresses associated with the merchant.
|
| ¦_ |
Type
|
Type of address. Includes tax filling, statement mailing and shipping ones. |
| ¦_ |
Street1
|
Street of the selected address (line 1). |
| ¦_ |
Street2
|
Street of the selected address (line 2). |
| ¦_ |
City
|
City of the selected address. |
| ¦_ |
Country
|
Country of the selected address. |
| ¦_ |
State
|
State of the selected address. |
| ¦_ |
Zip Code
|
Zip code of the selected address. |
| ¦_ |
Copy From
|
Allows to copy information from the selected source. |
| ¦_ |
Tax Filling
|
Allows to copy information from the tax filling address. |
| ¦_ |
Statement Mailing
|
Allows to copy information from the statement mailing address. |
| ¦_ |
Shipping
|
Allows to copy information from the shipping address. |
| ¦_ |
Legal Address
|
Allows to copy information from the legal address. |
| ¦_ |
Contact Address
|
Allows to copy information from the contact address. |
| ¦_ |
Primary Owner
|
Allows to copy information from the primary owner address. |
| ¦_ |
Secondary Owner
|
Allows to copy information from the secondary owner address. |
estimates (a) |
|
Provides access to estimates information of the merchant.
|
Estimates (Transaction Amount) |
|
Includes transaction estimation information.
|
| ¦_ |
Estimation Period
|
Enumeration of possible time periods for which transaction volume and average transaction amount are defined.
References: Business Info.Estimation Period CL
|
| ¦_ |
Total Volume
|
The estimated volume of transactions expected to be processed during the indicated estimation period.
References: Business Info.Estimated Transaction Volume
|
| ¦_ |
Avg Ticket
|
The estimated average amount of transactions expected to be processed during the indicated estimation period.
References: Business Info.Estimated AVG Transaction Amount
|
Card Type Distribution |
|
Includes information related to card type distribution.
|
| ¦_ |
Type
|
Type of a payment card. |
| ¦_ |
Lock
|
Allows to lock percents for the selected card type. |
| ¦_ |
%
|
Percentage of estimated transaction amount for the selected card type. |
| ¦_ |
Tx Volume
|
Estimated transaction volume for the selected card type. |
| ¦_ |
Tx Count
|
Estimated transaction count for the selected card type. |
Entry Mode Distribution |
|
Includes information related to entry mode distribution.
|
| ¦_ |
Type
|
Type of an entry mode. |
| ¦_ |
Lock
|
Allows to lock percents for the selected entry mode. |
| ¦_ |
%
|
Percentage of estimated transaction amount for the selected entry mode. |
| ¦_ |
Tx Volume
|
Estimated transaction volume for the selected entry mode. |
| ¦_ |
Tx Count
|
Estimated transaction count for the selected entry mode. |
deposit (a) |
|
Provides access to deposit information of the merchant.
|
Deposit Information |
|
Includes deposit information of the merchant.
|
| ¦_ |
Account Usage
|
Allows to select an appropriate type of charges distribution for a particular account. |
| ¦_ |
Fee Only
|
Indicates that only fees are withdrawn from a particular account. |
| ¦_ |
Negative Balance
|
Indicates that fees, chargebacks, returns and adjustments are withdrawn from a particular account. |
| ¦_ |
Not Used
|
Default value.
Indicates that no money is withdrawn from a particular account. |
|
Bank Name
|
Name of the bank which holds the account. |
|
Bank Phone
|
Phone of the bank which holds the account. |
|
Holder Name
|
Full name of the account holder. |
|
Account #
|
The bank account number.
When update (modify) action is performed, the real bank account information has to be supplied for this field. When the information is requested for reading (load), the masked value will be returned instead for security purposes. |
|
Routing #
|
Routing number of the bank.
When update (modify) action is performed, the real routing number information has to be supplied for this field. When the information is requested for reading (load), the masked value will be returned instead for security purposes. |
|
Token
|
Value issued by the internal tokenization system that replaces actual bank account and routing number. Using that value system can obtain the real bank account number and routing number to process. |
|
Deposit Information
|
Includes deposit information to be used as the source of the remittance of the funds. |
|
Charge Information
|
Includes charge information to be used as the source of the remittance of the funds. |
Reserves |
|
Includes information about the reserves.
|
| ¦_ |
Enabled
|
Indicates whether a reserve is enabled. If not enabled, money will not be withheld in the reserve. |
| ¦_ |
Required Amount
|
Amount of the reserve that the system needs to maintain. See Reserves for additional information. |
| ¦_ |
Collected Amount
|
Amount of the reserve that the system managed to collect at the time of the last remittance. See Reserves for additional information. |
| ¦_ |
Minimum Amount
|
Minimum amount of money that must be held in reserve at all times. See Reserves for additional information. |
| ¦_ |
Rate
|
Percentage of total transaction volume that should be retained as reserve. Using this rate and the Chargeback/Return Reserve Period the requested amount of chargeback reserve is dynamically calculated and adjusted on each remittance. See Reserves for additional information. |
| ¦_ |
Period
|
Time period in days used to determine the requested amount of the reserve. See Reserves for additional information. |
| ¦_ |
Remaining Amount
|
Amount of money against which refunds can be made. See Reserves definition for additional information. |
| ¦_ |
Bank Card
|
Includes information about the reserve used to cover chargebacks. |
| ¦_ |
ACH
|
Includes information about the reserve used to cover ACH returns. |
| ¦_ |
Refund
|
Includes information about the reserve used to limit refund. |
settings (a) |
|
Provides access to additional settings of the merchant.
|
Descriptors |
|
Includes various descriptors of the merchant.
|
| ¦_ |
MCC
|
Merchant category code assigned to the processing configuration of the merchant.
References: Provisioning Transaction.Merchant Processing Config Merchant Category Code
|
| ¦_ |
Card Descriptor
|
Dynamic description of the card processing configuration of the merchant.
References: Provisioning Transaction.Merchant Processing Config Card Descriptor
|
| ¦_ |
Direct Debit Processing
|
Indicates whether direct debit processing is enabled for the selected merchant. |
| ¦_ |
Direct Debit Descriptor Item
|
Default descriptor for direct debit transactions that is shown on merchant statements. |
| ¦_ |
Direct Debit Descriptor Merchant
|
Merchant name that is shown on merchant statements. |
| ¦_ |
Customer Service Phone
|
Phone of the support team used for discussing merchant's configuration issues.
References: Provisioning Transaction.Merchant Processing Config Customer Service Phone
|
Merchant Fees |
|
Includes information related to merchant fees.
|
| ¦_ |
Pricing Policy
|
Indicates merchant fees pricing policy. |
Pre-existing MIDs |
|
Includes pre-exsiting MIDs of American Express and Discover payment cards.
|
| ¦_ |
Amex MID
|
Merchant identifier assigned to AmEx processing configurations of the merchant.
References: Provisioning Transaction.Merchant Processing Config AmEx MID
|
| ¦_ |
OptBlue
|
Indicates whether American Express OptBlue program is used. |
Settlement |
|
Includes settlement settings of the merchant.
|
| ¦_ |
Type
|
Allows to select how transactions should be settled. |
| ¦_ |
manual
|
Indicates that settlement is initiated manually. |
| ¦_ |
hourly
|
Indicates that transactions are settled for predefined time range. |
| ¦_ |
daily
|
Indicates that settlement is initiated every day on specified time. |
|
Cutoff
|
Shows the time of the day that marks the end of the business day.
This time is set according to the server time zone but should be adjusted for merchant/merchant account individually, if needed. For example, if server time zone is set as EST but a particular merchant/merchant account operates according to PST, the cutoff time setting should be set as 3 AM, in case if cutoff processing time should occur at midnight.
Any transactions processed before this time are dated as the date-processed, while any transactions processed after this time are dated as being processed the next day.
References: Merchant.Processing Cutoff
|
process (a) |
|
Provides access to merchant's verification.
|
Merchant Verify |
|
Includes merchant verification information.
|
| ¦_ |
Process Provisioning
|
Allows to select processor settings that should be used for provisioning. |
| ¦_ |
Mode
|
Type of verification request that is going to be performed. |
| ¦_ |
Create
|
Creates a brand new legal entity and populates with values. After that a background check is going to be executed. |
| ¦_ |
Modify
|
Updates an existing legal entity and after that executes a background check again. |
| ¦_ |
Verify
|
Runs the verification process on the information supplied using the selected profile and mode. |
| ¦_ |
Send
|
Sends provisioning request to the processor. |
Provisioning Requests List |
|
Includes all 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 provisioning request. |
| ¦_ |
Response Date
|
Date of the transaction response.
References: Provisioning Transaction.Response Date
|
| ¦_ |
Status
|
Represents current transaction status.
References: Provisioning Transaction.Status Cl
|
Provisioning Verification Result |
|
Includes provisioning verification result in case of approved provisioning request.
|
| ¦_ |
Request ID
|
ID of the provisioning request. |
| ¦_ |
Request Date
|
Date of the request.
References: Provisioning Transaction.Request Date
|
| ¦_ |
Response Date
|
Date of the transaction response.
References: Provisioning Transaction.Response Date
|
| ¦_ |
Status
|
Represents current transaction status.
References: Provisioning Transaction.Status Cl
|
| ¦_ |
Account Number
|
Number of the merchant within the processor's system. |
| ¦_ |
Password
|
Password associated with the merchant within the processor's system. |
profiles (a) |
|
Provides access to processing setup.
|
Merchant Configure |
|
Includes various configuration scripts that can be selected for merchant or merchant account.
|
| ¦_ |
Configuration Script
|
Allows to choose an appropriate script for configuration for a particular merchant or merchant account. |
| ¦_ |
Configure
|
Alows to configure a merchant with the selected configuration script. |
Processing Information |
|
Includes information about merchant's processing profiles.
|
|
Synchronize with external sources
|
Indicates whether processing information is synchronized with external sources associated with the merchant. |
|
Merchant Category Code (MCC)
|
Code of the merchant's category. |
|
Amex MID
|
Merchant ID assigned by Amex. |
| ¦_ |
OptBlue
|
Indicates whether American Express OptBlue program is used. |
|
Discover MID
|
Merchant ID assigned by Discover. |
|
Max. Transaction Amount
|
Maximum amount that can be processed within one transaction. |
|
Card Descriptor
|
Descriptor of the card used by merchant. |
|
Direct Debit Processing
|
Indicates whether direct debit processing is enabled. |
|
Direct Debit Descriptor Item
|
Descriptor of the e-check or bank account used by the merchant. |
|
Direct Debit Descriptor Merchant
|
Name of the merchant that owns the e-check or bank account. |
|
Customer Service Phone
|
Phone number of the customer service. |
|
Group
|
The group of the transaction processing. |
|
Type
|
The type of the transaction processing. |
|
Service Provider
|
The name of the service provider for transaction processing. |
|
Identity
|
The identity of the transaction processing. |
|
Edit Provider Profile
|
Allows to edit processor's profile. |
|
Modify Provider Profile
|
Provides access to various provider modifying options. |
| ¦_ |
modify...
|
Allows to edit provider's profile. |
| ¦_ |
copy to...
|
Allows to copy settings to other merchant or merchant account's processor profile. |
| ¦_ |
copy from...
|
Allows to copy settings from other merchant or merchant account's processor profile. |
| ¦_ |
enable
|
Enables processing within the profile. |
| ¦_ |
disable
|
Disables processing within the profile. |
| ¦_ |
delete
|
Deletes the provider profile. |
| 