Zip and Country Codes|
Development
Reference Materials
New Merchant (Provisioning) 
Description: Arrangement of provisioning wizard forms for creating a new Merchant.
Provisioning Wizard |
|
Includes various options to create a new merchant with the help of provisioning wizard.
|
| ¦_ |
?
|
Provides user with additional information about required fields on the form. |
| ¦_ |
Remove All Hints
|
Allows to remove all hints from the form. |
| ¦_ |
New Litle Merchant (ISP)
|
Allows to see required fields for creationg a new litle merchant (ISP). |
| ¦_ |
New Litle Merchant (non-ISP)
|
Allows to see required fields for creationg a new litle merchant (non-ISP). |
General |
|
Provides access to general information about the merchant.
|
Merchant |
|
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
|
| ¦_ |
Tax ID
|
Use "Federal Tax Id" in "Business Info" object instead of this field.
References: Merchant.Tax ID Code
|
| ¦_ |
Verify
|
Allows to verify specified tax ID code. |
| ¦_ |
Profile
|
Shows minor merchant profile settings that can be secified. |
| ¦_ |
Accounts
|
Shows type of accounts that can be used for this profile. |
| ¦_ |
Single
|
Indicates single merchant account. |
| ¦_ |
Multiple
|
Indicates multiple merchants account. |
|
Tax IDs
|
Shows type of tax IDs that can be used for this profile. |
| ¦_ |
Single
|
Indicates single tax IDs account. |
| ¦_ |
Multiple
|
Indicates multiple tax IDs account. |
|
Descriptors
|
Shows type of descriptors that can be used for this profile. |
| ¦_ |
Single
|
Indicates single descriptors account. |
| ¦_ |
Multiple
|
Indicates multiple descriptors account. |
|
Deposit Accounts
|
Shows type of deposit accounts that can be used for this profile. |
| ¦_ |
Single
|
Indicates single deposit account. |
| ¦_ |
Multiple
|
Indicates multiple deposit account. |
|
Recurring Fees
|
Shows type of recurring fees that can be used for this profile. |
| ¦_ |
Per Merchant
|
This type of fee is charged only once regardless of merchant accounts number. |
| ¦_ |
Per Account
|
This type of fees is charged for each account setup under a merchant. |
|
ID
|
Identification number of the merchant in the system. |
|
Create
|
Allows to create a new merchant ID. |
|
Code
|
Unique identifier of the merchant generated by the gateway.
References: Merchant.Code
|
|
Name
|
The DBA name of the merchant.
References: Merchant.Name
|
|
Active
|
Indicates whether the record is active and can process through the system.
References: Merchant.Is Active
|
|
Time Zone
|
Time zone of a merchant.
References: Merchant.Time Zone Code
|
|
Time Zone
|
System code indicating the time zone.
References: Merchant.Time Zone System Code
|
|
Password
|
Merchant's password for transaction processing API. This value in combination with Merchant Code serves as a set of credentials to authenticate the submitter of a transaction.
References: Merchant.password
|
|
Generate Password
|
Allows to generate a new password for the merchant. |
|
Confirm Password
|
Repeated password of the merchant. |
|
Reseller
|
Reference to the entity that represents the reseller associated with the merchant.
References: Merchant.Reseller FK
|
|
Fee Processor
|
Reference to the entity that reresents processor's fee.
References: Merchant.Fee Processor FK
|
|
Channel
|
Reference to the entity that represents the channel.
References: Merchant.Channel FK
|
|
Create Date
|
Date when the record was created.
References: Merchant.Create Date
|
Submerchant |
|
Includes various options to create a new submerchant.
|
| ¦_ |
Name
|
Name associated with this submerchant account. |
| ¦_ |
Code
|
Code of the submerchant in the system. |
Contact Information |
|
Includes contact information of the merchant.
|
| ¦_ |
Copy From
|
Allows to copy information from the selected source. |
| ¦_ |
business-info
|
Allows to copy information from the business information. |
| ¦_ |
primary-owner
|
Allows to copy information from the primary owner. |
| ¦_ |
contact-info
|
Allows to copy information from the contact information. |
|
Contact Name
|
Name of the contact person for this merchant account.
References: Merchant Account.Contact Name
|
|
Street (line 1)
|
Street1 of the merchant's mailing address
References: Merchant Account.Street1
|
|
Street (line 1)
|
Street2 of the merchant's mailing address
References: Merchant Account.Street2
|
|
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/Province/Region
|
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
|
|
Phone
|
Phone number associated with this merchant account
References: Merchant Account.Phone
|
|
Fax
|
Fax number associated with this merchant account
References: Merchant Account.Fax
|
|
Email
|
Email associated with this merchant account
References: Merchant Account.Email
|
Notes |
|
Includes any additional information about a new merchant.
|
Business |
|
Provides access to various required business information about the merchant.
|
Business Information |
|
Includes business information about the merchant.
|
| ¦_ |
Legal Name
|
The legal name of the company.
References: BusinessInfo.legalName
|
| ¦_ |
Business Name (DBA)
|
DBA ("doing business as") name of the merchant. The value of this field is automatically copied to Name field on General form. |
| ¦_ |
Ownership Structure
|
Enumeration of possible ownership types of the company.
References: BusinessInfo.ownershipStructureType
|
| ¦_ |
Business Registration Year
|
The year when the merchant's business was established.
References: BusinessInfo.registrationYear
|
| ¦_ |
Business Registration Country
|
The country where the merchant's business was established.
References: BusinessInfo.registrationCountryCode
|
| ¦_ |
Business Registration State
|
Allows to select an appropriate state of the registration of the business.
The state where the merchant's business was established.
References: BusinessInfo.registrationState
|
| ¦_ |
Federal Tax ID
|
Federal Tax identifier of the company.
References: BusinessInfo.federalTaxId
|
| ¦_ |
State Tax ID
|
State Tax identifier of the company.
References: BusinessInfo.stateTaxId
|
| ¦_ |
Sales Tax ID
|
Sale Tax identifier of the company.
References: BusinessInfo.salesTaxId
|
| ¦_ |
Estimation Period
|
Enumeration of possible time periods for which transaction volume and average transaction amount are defined.
References: BusinessInfo.estimationPeriodType
|
| ¦_ |
Est. Transaction Volume
|
The estimated volume of transactions expected to be processed during the indicated estimation period.
References: BusinessInfo.estimatedTransactionVolume
|
| ¦_ |
Est. Transaction Amount
|
The estimated average amount of transactions expected to be processed during the indicated estimation period.
References: BusinessInfo.estimatedAvgTransactionAmount
|
| ¦_ |
Contract Begin Date
|
References: BusinessInfo.contractBeginDate
|
| ¦_ |
Contract End Date
|
References: BusinessInfo.contractEndDate
|
| ¦_ |
Relationship Begin Date
|
Date when the business relationship with this company was officially established.
References: BusinessInfo.relationshipBeginDate
|
| ¦_ |
Currency
|
The code of currency which the company processes transactions in.
References: BusinessInfo.currencyCode
|
Legal Address |
|
Includes information about business legal address of the merchant.
|
| ¦_ |
Copy from
|
Allows to copy the information from a specific location. |
| ¦_ |
contact-info
|
Allows to copy information for the Merchant from the "contact info". |
| ¦_ |
primary-owner
|
Allows to copy information from the "merchant business owner". |
|
Street1
|
Street1 of a company's mailing address.
References: BusinessInfo.street1
|
|
Street2
|
Street2 of a company's mailing address.
References: BusinessInfo.street2
|
|
City
|
City name of a company's mailing address.
References: BusinessInfo.city
|
|
Country
|
Allows to select an appropriate country associated with the company mailing address.
Country code of a company's mailing address.
References: BusinessInfo.countryCode
|
|
State
|
Allows to select an appropriate state associated with the company mailing address.
State of a company's mailing address.
References: BusinessInfo.state
|
|
ZIP Code
|
ZIP code of a company's mailing address.
References: BusinessInfo.zipCode
|
|
Email
|
Email address of a company.
References: BusinessInfo.email
|
|
Web Site
|
URL of the corporate website of the company.
References: BusinessInfo.webSite
|
|
Work Hours
|
Working hours of the company.
References: BusinessInfo.workHours
|
Background Verification Result for Business |
|
Includes information about results based on background verification that was conducted for the business.
|
Overall Score |
Includes the results of background verification of the company. These results can be used for evaluation of the risk of dealing with this merchant. |
| ¦_ |
Score
|
Overall background verification score (10X, where X is an integer value from 0 to 5, and 50 is the highest score with the lowest risk involved).
References: BackgroundVerificationResult.score
|
| ¦_ |
Description
|
Description of the overall background verification score.
References: BackgroundVerificationResult.scoreDescription
|
Name-Address-SSN Association |
|
Includes information whether name, address and social security number of the business owner were proved to correspond.
|
| ¦_ |
Code
|
The value indicating whether the social security number matches the address that has been indicated for this person.
References: BackgroundVerificationResult.nameAddressSsnAssociationCode
|
| ¦_ |
Description
|
The value indicating whether the social security number matches the address that has been indicated for this person.
References: BackgroundVerificationResult.nameAddressSsnAssociationDescription
|
Name-Address-Tax ID Association |
|
Includes information whether name, address and tax ID of the particular business were proved to correspond.
|
| ¦_ |
Code
|
A value indicating whether the tax ID matches the address that has been indicated for this company.
References: BackgroundVerificationResult.nameAddressTaxIdAssociationCode
|
| ¦_ |
Description
|
A value indicating whether the tax ID matches the address that has been indicated for this company.
References: BackgroundVerificationResult.nameAddressTaxIdAssociationDescription
|
Name-Address-Phone Association |
|
Includes information whether name, address and phone number of the particular business were proved to correspond.
|
| ¦_ |
Code
|
A value indicating whether the phone number matches the address that has been indicated for this company.
References: BackgroundVerificationResult.nameAddressPhoneAssociationCode
|
| ¦_ |
Description
|
A value indicating whether the phone number matches the address that has been indicated for this company.
References: BackgroundVerificationResult.nameAddressPhoneAssociationDescription
|
Data Verification |
Includes information whether it was possible to verify the data supplied by the Merchant. |
| ¦_ |
Name
|
Indicates whether it has been possible to verify that the specified name really belongs to the person under consideration.
References: BackgroundVerificationResult.isNameVerified
|
| ¦_ |
Phone
|
Indicates whether it has been possible to verify that the specified phone number is really the phone number of the person or company.
References: BackgroundVerificationResult.isPhoneVerified
|
| ¦_ |
SSN
|
Indicates whether it has been possible to verify that the specified social security number is the real social security number of the person.
References: BackgroundVerificationResult.isSsnVerified
|
| ¦_ |
Tax ID
|
Indicates whether it has been possible to verify that the specified tax ID is the real tax ID of the company.
References: BackgroundVerificationResult.isTaxIdVerified
|
| ¦_ |
Dob
|
Indicates whether it has been possible to verify that the specified date of birth is really the date of birth of the person.
References: BackgroundVerificationResult.isDobVerified
|
| ¦_ |
Street
|
Indicates whether it has been possible to verify that the specified street name is really where the person resides (or where the company is located).
References: BackgroundVerificationResult.isStreetVerified
|
| ¦_ |
City
|
Indicates whether it has been possible to verify that the specified city name is really where the person resides (or where the company is located).
References: BackgroundVerificationResult.isCityVerified
|
| ¦_ |
State
|
Indicates whether it has been possible to verify that the specified state name is really where the person resides (or where the company is located).
References: BackgroundVerificationResult.isStateVerified
|
| ¦_ |
ZIP Code
|
Indicates whether it has been possible to verify that the specified ZIP/postal code is the real actual ZIP/postal code of the place where the person resides (or the company is located).
References: BackgroundVerificationResult.isZipVerified
|
| ¦_ |
Last Update
|
The date when profile was updated the last time.
References: BackgroundVerificationResult.lastUpdateDate
|
Business-Owner Association |
|
Includes information whether the relationship between principal owner and the company was verified.
|
| ¦_ |
Score
|
The score characterizing the relationship\association between the principal owner and the company.
References: BackgroundVerificationResult.associationScore
|
| ¦_ |
Description
|
Description of the score characterizing the relationship\association between the principal owner and the company.
References: BackgroundVerificationResult.associationScoreDescription
|
Background Check Decision Notes |
|
Includes comments related to decision on company's background verification and underwriting.
|
Risk Indicators |
|
Includes information abour possible risk indicators associated with the person or company verified. Risk indicators may include presence of the person or business on Federal Blacklist, etc.
|
| ¦_ |
Code
|
The code of the risk indicator.
References: RiskIndicator.code
|
| ¦_ |
Description
|
Risk indicator description.
References: RiskIndicator.description
|
Bankruptcy |
|
Includes information about company's bankruptcy history(if any).
|
| ¦_ |
Type
|
Bankruptcy type.
References: Bankruptcy.type
|
| ¦_ |
Count
|
Bankruptcy count for a company.
References: Bankruptcy.count
|
| ¦_ |
Company Name
|
Name of bankrupt company.
References: Bankruptcy.companyName
|
| ¦_ |
Street1
|
Street1 of the bankrupt company's mailing address.
References: Bankruptcy.street1
|
| ¦_ |
Street2
|
Street2 of the bankrupt company's mailing address.
References: Bankruptcy.street2
|
| ¦_ |
City
|
City of the bankrupt company's mailing address.
References: Bankruptcy.city
|
| ¦_ |
State
|
State code of the bankrupt company's mailing address.
References: Bankruptcy.state
|
| ¦_ |
ZIP Code
|
ZIP/postal code of the bankrupt company's mailing address.
References: Bankruptcy.zipCode
|
| ¦_ |
Filing date
|
The date when the bankruptcy was filed.
References: Bankruptcy.filingDate
|
Lien |
|
Includes information about company's lien history (if any).
|
| ¦_ |
Type
|
Type of the lien.
Lien type.
References: Lien.type
|
| ¦_ |
Released Count
|
The count of property items released to the owner for this lien.
The count of property items released to the owner for this lien.
References: Lien.releasedCount
|
| ¦_ |
Unreleased Count
|
The count of unreleased property items for this lien.
The count of unreleased property items for this lien.
References: Lien.unreleasedCount
|
| ¦_ |
Company Name
|
Name of the company with a lien.
Name of the company with a lien.
References: Lien.companyName
|
| ¦_ |
Street1
|
Street (line 1) associated with the mailing address of the company with a lien.
Street1 in the mailing address of the company with a lien.
References: Lien.street1
|
| ¦_ |
Street2
|
Street (line 2) associated with the mailing address of the company with a lien.
Street2 in the mailing address of the company with a lien.
References: Lien.street2
|
| ¦_ |
City
|
City associated with the mailing address of the company with a lien.
City in the mailing address of the company with a lien.
References: Lien.city
|
| ¦_ |
State
|
State associated with the mailing address of the company with a lien.
State code in the mailing address of the company with a lien.
References: Lien.state
|
| ¦_ |
ZIP Code
|
Zip code associated with the mailing address of the company with a lien.
Zip code in the mailing address of the company with a lien.
References: Lien.zipCode
|
| ¦_ |
Filing date
|
The date when the lien was filed.
References: Lien.filingDate
|
Owners |
|
Provides access to various business information about the owner.
|
Primary Owner |
|
Includes general information about primary owner.
|
| ¦_ |
First Name
|
Business owner's first name.
References: BusinessOwner.firstName
|
| ¦_ |
Last Name
|
Business owner's last name.
References: BusinessOwner.lastName
|
| ¦_ |
Email
|
Business owner's e-mail.
References: BusinessOwner.email
|
| ¦_ |
Social Security
|
Business owner's social security number.
References: BusinessOwner.socialSecurity
|
| ¦_ |
Phone
|
Business owner's phone number.
References: BusinessOwner.phone
|
| ¦_ |
Birth Date
|
Business owner's birth date.
References: BusinessOwner.birthDate
|
| ¦_ |
Driver License
|
Business owner's driver's license number.
References: BusinessOwner.driverLicense
|
| ¦_ |
Driver License Country
|
Code of the country where the driver license was provided to the business owner.
References: BusinessOwner.driverLicenseCountryCode
|
| ¦_ |
Driver License State
|
State where business owner's driver license was issued.
References: BusinessOwner.driverLicenseState
|
| ¦_ |
Street1
|
Street (line 1) associated with business owner's address.
Street (line 1) associated with business owner's address.
References: BusinessOwner.street1
|
| ¦_ |
Street2
|
Street (line 2) associated with business owner's address.
References: BusinessOwner.street2
|
| ¦_ |
City
|
City associated with business owner's address.
References: BusinessOwner.city
|
| ¦_ |
Country
|
Country code associated with business owner's address.
References: BusinessOwner.countryCode
|
| ¦_ |
State
|
State associated with business owner's address.
References: BusinessOwner.state
|
| ¦_ |
ZIP Code
|
ZIP/postal code associated with business owner's address.
References: BusinessOwner.zipCode
|
Secondary Owner |
|
Includes general information about secondary owner.
|
| ¦_ |
First Name
|
Business owner's first name.
References: BusinessOwner.firstName
|
| ¦_ |
Last Name
|
Business owner's last name.
References: BusinessOwner.lastName
|
| ¦_ |
Email
|
Business owner's e-mail.
References: BusinessOwner.email
|
| ¦_ |
Social Security
|
Business owner's social security number.
References: BusinessOwner.socialSecurity
|
| ¦_ |
Phone
|
Business owner's phone number.
References: BusinessOwner.phone
|
| ¦_ |
Birth Date
|
Business owner's birth date.
References: BusinessOwner.birthDate
|
| ¦_ |
Driver License
|
Business owner's driver's license number.
References: BusinessOwner.driverLicense
|
| ¦_ |
Driver License Country
|
Code of the country where the driver license was provided to the business owner.
References: BusinessOwner.driverLicenseCountryCode
|
| ¦_ |
Driver License State
|
State where business owner's driver license was issued.
References: BusinessOwner.driverLicenseState
|
| ¦_ |
Street1
|
Street (line 1) associated with business owner's address.
Street (line 1) associated with business owner's address.
References: BusinessOwner.street1
|
| ¦_ |
Street2
|
Street (line 2) associated with business owner's address.
References: BusinessOwner.street2
|
| ¦_ |
City
|
City associated with business owner's address.
References: BusinessOwner.city
|
| ¦_ |
Country
|
Country code associated with business owner's address.
References: BusinessOwner.countryCode
|
| ¦_ |
State
|
State associated with business owner's address.
References: BusinessOwner.state
|
Background Verification Result for Owner |
|
Includes information about results based on background verification that was conducted for primary owner.
|
Overall Score |
Includes information about estimation score based on background verification results on the whole that can be used to evaluate risk of dealing with this Merchant. |
| ¦_ |
Score
|
Overall background verification score (10X, where X is an integer value from 0 to 5, and 50 is the highest score with the lowest risk involved).
References: BackgroundVerificationResult.score
|
| ¦_ |
Description
|
Description of the overall background verification score.
References: BackgroundVerificationResult.scoreDescription
|
Name-Address-SSN Association |
|
Includes information whether name, address and social security number of the business owner were verified as corresponding to each other.
|
| ¦_ |
Code
|
The value indicating whether the social security number matches the address that has been indicated for this person.
References: BackgroundVerificationResult.nameAddressSsnAssociationCode
|
| ¦_ |
Description
|
The value indicating whether the social security number matches the address that has been indicated for this person.
References: BackgroundVerificationResult.nameAddressSsnAssociationDescription
|
Name-Address-Tax ID Association |
|
Includes information whether name, address and tax ID of the particular business were verified as corresponding to each other.
|
| ¦_ |
Code
|
A value indicating whether the tax ID matches the address that has been indicated for this company.
References: BackgroundVerificationResult.nameAddressTaxIdAssociationCode
|
| ¦_ |
Description
|
A value indicating whether the tax ID matches the address that has been indicated for this company.
References: BackgroundVerificationResult.nameAddressTaxIdAssociationDescription
|
Name-Address-Phone Association |
|
Includes information whether name, address and phone number of the particular business were verified as corresponding to each other.
|
| ¦_ |
Code
|
A value indicating whether the phone number matches the address that has been indicated for this company.
References: BackgroundVerificationResult.nameAddressPhoneAssociationCode
|
| ¦_ |
Description
|
A value indicating whether the phone number matches the address that has been indicated for this company.
References: BackgroundVerificationResult.nameAddressPhoneAssociationDescription
|
Data Verification |
Includes information whether it was possible to verify the data supplied by the Merchant. |
| ¦_ |
Name
|
Indicates whether it has been possible to verify that the specified name really belongs to the person under consideration.
References: BackgroundVerificationResult.isNameVerified
|
| ¦_ |
Phone
|
Indicates whether it has been possible to verify that the specified phone number is really the phone number of the person or company.
References: BackgroundVerificationResult.isPhoneVerified
|
| ¦_ |
SSN
|
Indicates whether it has been possible to verify that the specified social security number is the real social security number of the person.
References: BackgroundVerificationResult.isSsnVerified
|
| ¦_ |
Tax ID
|
Indicates whether it has been possible to verify that the specified tax ID is the real tax ID of the company.
References: BackgroundVerificationResult.isTaxIdVerified
|
| ¦_ |
Dob
|
Indicates whether it has been possible to verify that the specified date of birth is really the date of birth of the person.
References: BackgroundVerificationResult.isDobVerified
|
| ¦_ |
Street
|
Indicates whether it has been possible to verify that the specified street name is really where the person resides (or where the company is located).
References: BackgroundVerificationResult.isStreetVerified
|
| ¦_ |
City
|
Indicates whether it has been possible to verify that the specified city name is really where the person resides (or where the company is located).
References: BackgroundVerificationResult.isCityVerified
|
| ¦_ |
State
|
Indicates whether it has been possible to verify that the specified state name is really where the person resides (or where the company is located).
References: BackgroundVerificationResult.isStateVerified
|
| ¦_ |
ZIP Code
|
Indicates whether it has been possible to verify that the specified ZIP/postal code is the real actual ZIP/postal code of the place where the person resides (or the company is located).
References: BackgroundVerificationResult.isZipVerified
|
| ¦_ |
Last Update
|
The date when profile was updated the last time.
References: BackgroundVerificationResult.lastUpdateDate
|
Business-Owner Association |
|
Includes information whether the relationship between principal owner and the company was verified.
|
| ¦_ |
Score
|
The score characterizing the relationship\association between the principal owner and the company.
References: BackgroundVerificationResult.associationScore
|
| ¦_ |
Description
|
Description of the score characterizing the relationship\association between the principal owner and the company.
References: BackgroundVerificationResult.associationScoreDescription
|
Background Check Decision Notes |
|
Includes comments related to decision on company's background verification and underwriting.
|
Risk Indicators |
|
Includes information about possible risk indicators associated with the person or company verified. Risk indicators may include presence of the person or business on Federal Blacklist, etc.
|
| ¦_ |
Code
|
The code of the risk indicator.
References: RiskIndicator.code
|
| ¦_ |
Description
|
Risk indicator description.
References: RiskIndicator.description
|
References |
|
Provides access to general information about primary business reference.
|
Primary Business Reference |
|
Includes general information about primary business reference.
|
| ¦_ |
First Name
|
Business owner's first name.
References: BusinessOwner.firstName
|
| ¦_ |
Last Name
|
Business owner's last name.
References: BusinessOwner.lastName
|
| ¦_ |
Email
|
Business owner's e-mail.
References: BusinessOwner.email
|
| ¦_ |
Social Security
|
Business owner's social security number.
References: BusinessOwner.socialSecurity
|
| ¦_ |
Phone
|
Business owner's phone number.
References: BusinessOwner.phone
|
| ¦_ |
Birth Date
|
Business owner's birth date.
References: BusinessOwner.birthDate
|
| ¦_ |
Driver License
|
Business owner's driver's license number.
References: BusinessOwner.driverLicense
|
| ¦_ |
Driver License Country
|
Code of the country where the driver license was provided to the business owner.
References: BusinessOwner.driverLicenseCountryCode
|
| ¦_ |
Driver License State
|
State where business owner's driver license was issued.
References: BusinessOwner.driverLicenseState
|
| ¦_ |
Street1
|
Street (line 1) associated with business owner's address.
Street (line 1) associated with business owner's address.
References: BusinessOwner.street1
|
| ¦_ |
Street2
|
Street (line 2) associated with business owner's address.
References: BusinessOwner.street2
|
| ¦_ |
City
|
City associated with business owner's address.
References: BusinessOwner.city
|
| ¦_ |
Country
|
Country code associated with business owner's address.
References: BusinessOwner.countryCode
|
| ¦_ |
State
|
State associated with business owner's address.
References: BusinessOwner.state
|
| ¦_ |
ZIP Code
|
ZIP/postal code associated with business owner's address.
References: BusinessOwner.zipCode
|
Deposit |
|
Provides access to various deposit information.
|
Deposit Information |
|
Includes deposit information to be used as the source of the remittance of the funds.
|
| ¦_ |
Bank Name
|
Name of the bank which holds the account where remittance deposits are directed.
References: MerchantDepositInfo.bankName
|
| ¦_ |
Bank Phone
|
Phone of the bank which holds the account where remittance deposits are directed.
References: MerchantDepositInfo.bankPhone
|
| ¦_ |
Holder Name
|
Name of a payment card or bank account holder. The value is a concatenation of the firstName and lastName field values separated by a space.
Full name of the account holder, where remittance deposits are directed.
References: MerchantDepositInfo.holderName
|
| ¦_ |
Account #/IBAN
|
Bank account where remittance deposits are directed.
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.
Masked account number (last four digits) of the bank account associated with the merchant account group.
References: MerchantDepositInfo.accountNumber
|
| ¦_ |
Routing #/SWIFT/BIC/BSB
|
Routing number of the bank where deposits are directed.
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.
Masked routing number (last four digits) of the bank account associated with the merchant account group.
References: MerchantDepositInfo.routingNumber
|
| ¦_ |
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.
References: MerchantDepositInfo.tokenCode
|
Charge Information |
|
Includes charge information to be used as the source of the remittance of the funds.
|
| ¦_ |
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 from which merchant fees are deducted.
References: MerchantChargeInfo.bankName
|
|
Bank Phone
|
Phone of the bank which holds the account from which merchant fees are deducted.
References: MerchantChargeInfo.bankPhone
|
|
Holder Name
|
Name of a payment card or bank account holder. The value is a concatenation of the firstName and lastName field values separated by a space.
Full name of the holder of the account from which merchant fees are deducted.
References: MerchantChargeInfo.holderName
|
|
Account #
|
The bank account where remittance deposits are directed.
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.
Masked account number (last four digits) of the bank account associated with the merchant account group.
References: MerchantChargeInfo.accountNumber
|
|
Routing #
|
Routing number of the bank where deposits are directed.
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.
Masked routing number (last four digits) of the bank account associated with the merchant account group.
References: MerchantChargeInfo.routingNumber
|
|
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.
References: MerchantChargeInfo.tokenCode
|
Bank Card Reserve |
|
Includes information about the reserve used to cover chargebacks.
|
|
Enabled
|
Indicates whether chargeback reserve is enabled. If not enabled, money will not be withheld in the reserve.
References: MerchantChargebacksReserve.isEnabled
|
|
Required Amount
|
Amount of money that must be maintained as chargebacks reserve. Requested amount gets dynamically adjusted as time progresses and processing volume changes. The requested amount should never drop below the minimum amount. See Reserves definition for additional information.
References: MerchantChargebacksReserve.requiredAmount
|
|
Collected Amount
|
Note: This field is read-only and cannot be modified.
Amount of money available in the reserve after the last remittance happened. See Reserves definition for additional information.
References: MerchantChargebacksReserve.collectedAmount
|
|
Minimum Amount
|
Minimum amount of money that must be held in reserve at all times. See Reserves definition for additional information.
References: MerchantChargebacksReserve.minimumAmount
|
|
Rate
|
Percentage of total transaction volume that should be retained as reserve. Using this rate and the Chargeback Reserve Period the requested amount of chargeback reserve is dynamically calculated and adjusted on each remittance. See Reserves definition for additional information.
References: MerchantChargebacksReserve.rate
|
|
Period
|
Time period in days, used to determine the requested amount of the reserve. See Reserves definition for additional information.
References: MerchantChargebacksReserve.period
|
ACH Reserve |
|
Includes information about the reserve used to cover ACH returns.
|
|
Enabled
|
Indicates whether return reserve is enabled. If not enabled, money will not be withheld in the reserve.
References: MerchantReturnsReserve.isEnabled
|
|
Required Amount
|
Amount of money for ACH returns that must be maintained as chargebacks reserve. Requested amount gets dynamically adjusted as time progresses and processing volume changes. The requested amount should never drop below the minimum amount. See Reserves definition for additional information.
References: MerchantReturnsReserve.requiredAmount
|
|
Collected Amount
|
Note: This field is read-only and cannot be modified.
Amount of money for ACH returns available in the reserve after the last remittance happened. See Reserves definition for additional information.
References: MerchantReturnsReserve.collectedAmount
|
|
Minimum Amount
|
Minimum amount of money for ACH returns that must be held in reserve at all times. See Reserves definition for additional information.
References: MerchantReturnsReserve.minimumAmount
|
|
Rate
|
Percentage of total transaction volume that should be retained as reserve for ACH returns. Using this rate and the Return Reserve Period the requested amount of return reserve is dynamically calculated and adjusted on each remittance. See Reserves definition for additional information.
References: MerchantReturnsReserve.rate
|
|
Period
|
Time period in days, used to determine the requested amount of the reserve. See Reserves definition for additional information.
References: MerchantReturnsReserve.period
|
Refund Reserve |
|
Includes information about the reserve used to limit refund.
|
|
Enabled
|
Indicates whether refund reserve is enabled. If not enabled, limited refunds are allowed.
References: MerchantRefundsReserve.isEnabled
|
|
Maximum Amount
|
Amount of the reserve that the system needs to maintain. See Reserves definition for additional information.
References: MerchantRefundsReserve.requiredAmount
|
|
Collected Amount
|
Note: This field is read-only and cannot be modified.
Amount of the reserve that the system managed to collect at the time of the last remittance. See Reserves definition for additional information.
References: MerchantRefundsReserve.collectedAmount
|
| 