Request API Access
Guides
Start typing to search…

Submit merchant

The Submit Merchant API allows partners to onboard new merchants by creating a merchant profile and submitting all relevant business data. This API is the most comprehensive method for registering merchant information and ensures that all necessary details are collected for a complete merchant onboarding process.

Key Features:

  • Supports submitting all merchant-related information, including business details, sales data, and owner information.
  • Allows partners to input site inspection reports, service acceptance data, and details on fees and equipment.
  • Can be used for both new merchant registrations and updates to existing profiles by including an optional merchantProfileId.

Benefits:

  • Complete Merchant Data Submission: This API covers every aspect of the merchant's profile, ensuring that all required data is captured for compliance, risk management, and service setup.
  • Customizable for Merchant Updates: By submitting an optional merchantProfileId, partners can use this API to update existing merchants as well.
  • Seamless Integration: The API is designed to integrate easily with your system, enabling automated merchant onboarding and management.
    - Direct Integration with TSYS: All submitted merchant data is seamlessly transmitted to the TSYS platform for processing, ensuring smooth and compliant onboarding within the TSYS ecosystem.
  1. **[POST] /api/v2/merchant/submit **- A basic method for boarding clients. When this method is called, a merchant is created and data about the merchant is entered. This is the most complete method for completing the merchant data.

  1. Example submit
  2. Examples blocks fees

Request [POST] /api/v2/merchant/submit:


 SubmitMerchantRequest { merchantProfile(TsysMerchant), businessAndOwnerInformation(TsysParameters), salesAndBusinessProfile(TsysMerchantAccount), siteInspection(TsysSiteInspection), serviceAcceptance(TsysProductSetup), fees(TsysFees,optional), equipment(TsysEquipment), merchantProfileId(integer,optional) }

SubmitMerchantRequest

Parameter NameTypeRequiredDescriptionValidationExample Example Values
MerchantProfileTsysMerchantRequiredTechnical information about the merchant boarding
BusinessAndOwnerInformationTsysParametersRequiredBasic information about the merchant
SalesAndBusinessProfileTsysMerchantAccountRequiredInformation about Sales and Merchant's Business
SiteInspectionTsysSiteInspectionRequiredMerchant Site Inspections are used by merchant acquirers as a preliminary assessment and investigation before underwriting a merchant account. The inspection provides information to mitigate risk and fraud and to determine the legitimacy of a business when establishing a new account, or if following up on suspicious activity with an existing merchant.
TsysProductSetupServiceAcceptanceRequiredSelection of payment systems and products for the merchant
FeesTsysFeesOptionalThe main block of fees of the merchant, for transactions and performing actions and using the system.
EquipmentTsysEquipmentOptionalBlock for adding terminals for the merchant
MerchantProfileIdintOptional

TsysMerchant

Parameter NameTypeRequiredDescriptionValidationExample Example Values
AgentProfileIdintRequiredId AgentRrofile in Netevia HQ System
CashDiscountCashDiscountEnumRequiredCashDiscount service for Merchant'No', 'Yes''No', 'Yes'
POSAptitoStatusRequiredPOS System in Netevia HQ'None', 'Retail', 'Restaurant', 'Clover', 'Aldelo', 'Restoactive', 'PoyntPOS', 'CloverGo', 'UnifiedMpos', 'CustomPos', 'RetailCloud', 'EHopper', 'FreedomPos', 'ClubPos', 'SelfLane'
BoardingSettingsIdintOptional
MIDstringOptional

TsysParameters

Parameter Name Type Required Description Validation Example Example Values

CustomerServicePhoneNum

string

Required

Max Length: 10 Min Length: 10

5027320123

FederalTaxId

string

Required

Sets the federal tax ID of the business partner.

Regular Expression: "^(d|*){9}$"

Sets the federal tax ID of the business partner.

DateOfStartBusiness

DateTime

Required

Date Range: "1/1/1900", "now"

01-01-2022

MerchantEmail

string

Optional

Max Length:60
Email Validation
Error Message:
Email validation error. You can't use two '-' characters together.
Error Message:
Email validattion error. Replace '–' with '-'.

[email protected]

MerchantWebsite

string

Optional

Max Length:60
Uri Validation
Error Message: Invalid URL format.

Netevia.com

MultipleLocations

bool

Optional

bool

True

NumOfLocations

int

Optional

2

LegalAddress

AddressBase

Required

The legal address of the merchant shall be the address entered in the Commercial Register

123 Avenue

DbaAddress

AddressBase

Required

The DBA would be filed in the county or state of the registered office and principal address of the business location.

321 Avenue

PrimaryOwner

Owner

Required

Information about primary Owner of merchant

SecondaryOwner

SecondaryOwner

Optional

Information about SecondaryOwner of merchant

Owner3

SecondaryOwner

Optional

Information about Owner3 of merchant

Owner4

SecondaryOwner

Optional

Information about Owner4 of merchant

ControllingOfficer1

ControllingOfficer

Optional

ControllingOfficer2

ControllingOfficer

Optional

📘

Additional: Equity Ownership: Sum of ownership of all owners must be more or equal 76% and less or equal 100%

TsysMerchantAccount

Parameter Name Type Required Description Validation Example Example Values

DateOpened

DateTimeOffset

Optional

Date of Opened account

date

01-01-2020

SIC

string

Required

SIC is an acronym for the Standard Industrial Classification system

5812

SellingRegulatedSubstances

bool

Optional

MassageServices

bool

Optional

SellingGasFuel

bool

Optional

TypeOfOwnership

TypeBusiness

Required

'Corporation', 'Unknown', 'SoleProprietorship', 'Partnership', 'AssociationEstateTrust', 'TaxExempt501C', 'International', 'LimitedLiabilityLlc', 'GovernmentAgency'

BusinessType

TsysDirectBusinessType

Required

'Other', 'Internet', 'Lodging', 'MailOrder', 'Restaurant', 'Retail', 'QSR', 'Supermarket', 'Petroleum', 'Utilities', 'Healthcare', 'Education', 'Government', 'Charity_NonProfit', 'B2B', 'Service'

AccountType

DdaAccountType

Optional

C=Checking
S=Saving
G=General

'C', 'S', 'G'

AccountNumber

string

Required

Bussines Account Number

Integer
Length:17

BusinessCheckingRoutingNumber

string

Required

Integer
Length:9

123123123

AchMethod

TsysAchMethod

Required

'Combine', 'Individual'

AverageTicket

long

Required

Average ticket is a metric that provides details on the average amount spent per customer per visit.

Range(1, 9999999999)

100

HighTicket

int

Optional

The maximum amount a customer spends on merchants' services or goods

Range(1, 999999)

200

SalesToConsumers

double

Optional

Percentage of sales attributable to Business to Consumers (B2C) segment

Range(0, 100)

"If one of fields 'SalesToConsumers', 'SalesToBusiness' or 'SalesToGovernment' has value, sum of them should be 100%.

10

SalesToBusiness

double

Optional

Percentage of sales attributable to Business to Business (B2B) segment

Range(0, 100)

"If one of fields 'SalesToConsumers', 'SalesToBusiness' or 'SalesToGovernment' has value, sum of them should be 100%."

20

SalesToGovernment

double

Optional

Percentage of sales attributable to Business to Government (B2G) segment

Range(0, 100)

"If one of fields 'SalesToConsumers', 'SalesToBusiness' or 'SalesToGovernment' has value, sum of them should be 100%."

70

BankName

string

Optional

Information about Bank Name of merchant

JP Morgan

GoodsAndServices

String

Optional

NextDayFunding

bool

Optional

"Next-Day Funding" is a financial service or feature that enables businesses to receive the funds from their transactions within one business day. This expedited funding process is commonly used in payment processing and merchant services, providing quicker access to the revenue generated from sales or transactions.

true

SameDayFunding

bool

Optional

"Same-Day Funding" is a financial service or feature that allows businesses to receive the funds from their transactions on the same day. This expedited funding process is often used in payment processing and merchant services, providing quick access to the revenue generated from sales or transactions conducted within that business day.

false

IsVsMcDsNetwork

bool

Optional

Are you currently accepting VISA/MASTERCARD/DISCOVER® NETWORK?

true

MonthlyVolume

long

Required

Monthly Volume of Merchant's funds

Range(1, 9999999999)

100

AnnualVolume

long

Optional

Annual Volume of Merchant's funds

Range(1, 9999999999)

200

Retail

int

Required

Retail chip/swipe % of merchant sales

Range(0, 100)

10

Imprint

int

Required

Card Present Keyed % of merchant sales

Range(0, 100)

20

Moto

int

Required

Mail/Phone % of merchant sales

Range(0, 100)

30

Internet

int

Required

Internet % of merchant sales

Range(0, 100)

50

CardNotPresentInformation

TsysCnpInformation

Optional

📘

Additional:

  1. The sum of Sales Split fields must be 100%: Retail, Imprint, Moto, Internet
  2. Transaction Information fields are optional, but if at least one is filled in, their sum must be 100%: SalesToConsumers, SalesToBusiness, SalesToGovernment

TsysSiteInspection

Parameter Name Required Type Description Validation Example

InventoryMaintainedType

InventoryMaintainedType

Optional

Optional
Type of Inventory maintained

'OnSite', 'WarehouseOffSite', 'FulfillmentCenter'

FulfillmentCenterNameAndAddress

Optional

Fulfillment Center Name & Address

"Required if 'InventoryMaintainedType' is '"Models.Enum.InventoryMaintainedType.FulfillmentCenter'."

123 Avenue street

Question1

bool

Optional

Was the off site location visited?

Question1Explanation

string

Optional

If No, Explain

"Required if 'Question1' is 'False'."

Question2

bool

Optional

Does the amount of inventory on shelves, floor and in warehouse appear consistent with this type of business and credit card volume?

Question2Explanation

string

Optional

If No, Explain

"Required if 'Question2' is 'False'."

Question3

bool

Optional

Does location have sufficient staff, telephone lines and other equipment to meet anticipated sales volume?

Question3Explanation

string

Optional

If No, Explain

Does the signage inside and outside match the goods or services sold listed on the application?

Question4

bool

Optional

Does the signage inside and outside match the goods or services sold listed on the application?

Question4Explanation

string

Optional

If No, Explain

"Required if 'Question4' is 'False'."

Zoning

Zoning

Optional

Area Zoned

'Comml', 'Industrial', 'Residential'

SquareFootageType

TsysSquareFootageType

Optional

Square Footage

'From_0_To_500', 'From_501_To_1000', 'From_1001_To_2000', 'From_2001_To_4000', 'Other'

SquareFootageTypeOther

int

Optional

Other

"Required if 'SquareFootageType' is 'TsysSquareFootageType.Other'."

3003

Merchant

TsysMerchantType

Optional

Type of Merchant zone

'Owns', 'Leases'

NameAddressLandlord

string

Optional

Name & address Landlord/ Mgt. Co

John Jones 123 Avenue street

TsysProductSetup - Types of payment systems for merchant

Parameter Name Type Required Description Validation Example Values

Visa

bool

Optional

Default(true)

MasterCard

bool

Optional

Default(true)

AmexESA

bool

Optional

Select between AmexESA and Amex OptBlue

True

AmexOptBlue

bool

Optional

Select between AmexESA and Amex OptBlue

True

Discover

bool

Optional

Requires Discover

True

PayPal

bool

Optional

Requires Discover

True

JCB

bool

Optional

True

EBT

bool

Optional

True

DebitCard

bool

Optional

True

AmexNumber

string

Optional

Required if AmexESA. Consist of 10 digits.

Digits
Length: 10, ErrorMessage: The AmexNumber field must consist of 10 digits.

1212121212

FCSNumber

string

Optional

Consist of 7 digits.

Digits
Length: 7 ErrorMessage: The FCSNumber field must consist of 7 digits.

1212121

📘

Additional:

  1. Select between AmexESA and AmexOptBlue
  2. The AmexNumber field is required if AmexESA is selected

TsysFees

Parameter Name Type Required Description Validation Example Values

MinimumDiscountAmount

decimal

Required

A minimum indicates the minimum amount in fees that a processor will collect in any given. If actual fees resulting from processing activity don’t meet or exceed the minimum amount, the processor will charge however much is necessary to meet the minimum.

Range(0, 500)
Regular Expression:"^d+(.d{0,4})?$

ErrorMessage: "Maximum four decimal points."

100

MinimumDiscountStartDate

DateTimeOffset

Required

2023-06-16

MinimumDiscountType

DiscountType

Required

Type of Minimum Discount

'Daily', 'Monthly'

EarlyTerminationFeeAmount

decimal

Optional

Early Termination Fee Amount

Range(0, 999999)

Default(750)

EarlyTerminationFeeContractMonths

int

Optional

Early Termination Fee Contract Months

Range(0, 60)

Default(36)

Amex

AmexFees

Required

One of the “AmexFees” block values

VisaMasterCardDiscover

VisaMasterCardDiscoverFees

Required

One of the “VisaMasterCardDiscoverFees” block values

AuthorizationMonthlyAndSpecialProgram

AuthorizationMonthlyAndSpecialProgramFees

Optional

Standard

StandardFees

Optional

DebitPinAndEBT

DebitPinAndEBTFees

Optional

GatewayProducts

GatewayProductsFees

Optional

MiscFees

Array(TsysMiscFee)

Optional

MiscFeesVolume

Array(TsysMiscFee)

Optional

AmexFees

Parameter NameTypeRequiredDescriptionValidationExample Values
InterchangePlusAmexInterchangePlusOptionalInterchangePlus represents "cost/interchange plus" pricing, meaning cost of the interchange plus specified $ and or % per transaction. See structure for details.
TieredDiscountsAmexTieredDiscountsOptional
NoSurchargeAmexNoSurchargeOptional
AmexInterchangePlusPlusAmexInterchangePlusPlusOptional

VisaMasterCardDiscoverFees

Parameter NameTypeRequiredDescriptionValidationExample Values
BillBackIntrDifferentialBillBackIntrDifferentialOptional
InterchangePlusInterchangePlusOptionalInterchangePlus represents "cost/interchange plus" pricing, meaning cost of the interchange plus specified $ and or % per transaction. See structure for details.
NoSurchargeNoSurchargeOptional
TieredDiscountsMOTOEcommTieredDiscountsMOTOEcommOptional
TieredDiscountsRetailTieredDiscountsRetailOptional
CustomInterchangeCustomInterchangeOptional
CustomInterchangeDurbinCustomInterchangeDurbinOptional
InterchangePlusPlusInterchangePlusPlusOptional

AuthorizationMonthlyAndSpecialProgramFees

Parameter Name Type Required Description Validation Example Values

VSMCDISCAuth

TsysFee

Optional

Fee for VISA/MasterCard/Discover authorizations

FeePercentRange("0", "0")
FeePerItemRange("0", "1")

AmexAuth

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("0", "1")

AVS

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("0", "1")

Batch

TsysFee

Optional

A batch fee may be set up as a Data Capture Trxns item. The merchant may be charged $0.015 for each deposit batch.

FeePercentRange("0", "0")
FeePerItemRange("0", "1")

VoiceAuthorization

TsysFee

Optional

Fee for Authorization with voice

FeePercentRange("0", "0")
FeePerItemRange("0", "2")

Retrieval

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("5", "50")

Chargeback

TsysFee

Optional

Chargeback Fee

FeePercentRange("0", "0")
FeePerItemRange("10", "50")

ChargebackViolation

TsysFee

Optional

ACHReject

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("25", "100")

MerchAnnual

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("0", "200")

Statement

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("0", "100")

Reporting1099K

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("0", "10")

TINMismatch

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("0", "25")

PCIAnnual

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("0", "200")

PCINonCompliance

TsysFee

Optional

FeePercentRange("0", "0"),
eePerItemRange("21.95", "21.95")

PCIMonthly

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("0", "200")

PCIQuarterly

TsysFee

Optional

FeePercentRange("0", "0")
FeePerItemRange("0", "200")

StandardFees

Parameter NameTypeRequiredDescriptionValidationExample Values
DialPayTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "5")
OnlinePortalTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "100")
MOTOEcommSurchargePITsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "1")
NextDayFundingTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "100")
SameDayFundingTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("9.95", "100")

DebitPinAndEBTFees

Parameter NameTypeRequiredDescriptionValidationExample Values
PinDebitMonthlyTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "25")
PinDebitQualifiedDiscountTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "1")
PinDebitAuthTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "1")
PinDebitAnnualTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "100")
EBTTransTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "1")

GatewayProductsFees

Parameter NameTypeRequiredDescriptionValidationExample Values
MicrosTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0.0590", "0.0590")
GatewayAccessTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "1")
WirelessAndMobilePOSPITsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "100")
GatewayPerItemTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "1")
WirelessActivationTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "100")
WirelessAccessTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "100")
UnifiedmPOSActivationTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "100")
UnifiedmPOSAccessTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "100")
UnifiedmPOSTransactionsTsysFeeOptionalFeePercentRange("0", "0") FeePerItemRange("0", "1")

TsysMiscFee

Parameter NameTypeRequiredDescriptionValidationExample Values
NameTsysFeeRequired
StopDateTsysFeeOptionalDateRange(minValue: "now")
StartDateTsysFeeOptionalDefult(Curent Date Time)
FrequencyTsysFeeOptional'Annual', 'SemiAnnual', 'Quarterly', 'Monthly', 'OneTime'
MonthTsysFeeOptional
YearTsysFeeOptional
PerItemTsysFeeRequired
PercentTsysFeeRequired

AmexInterchangePlus

Parameter NameTypeRequiredDescriptionValidationExample Values
QualifiedDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

AmexTieredDiscounts

Parameter NameTypeRequiredDescriptionValidationExample Values
QualifiedDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MidQualTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
NonQualTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

AmexNoSurcharge

Parameter NameTypeRequiredDescriptionValidationExample Values
QualDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

AmexInterchangePlusPlus

Parameter NameTypeRequiredDescriptionValidationExample Values
QualifiedDiscountTsysFeeOptional
MidQualTsysFeeOptional
NonQualTsysFeeOptional

BillBackIntrDifferential

Parameter NameTypeRequiredDescriptionValidationExample Values
VSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")
VSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")
MCQualCrDiscountTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")
MCQualDbDiscountTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")
DSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")
DSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")
VSNonQualICDiffTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")
MCNonQualICDiffTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")
DSNonQualICDiffTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")
AXNonQualICDiffTsysFeeOptionalFeePercentRange("0", "3") FeePerItemRange("0", "2")

InterchangePlus

Parameter NameTypeRequiredDescriptionValidationExample Values
VSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
VSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

NoSurcharge

Parameter NameTypeRequiredDescriptionValidationExample Values
VSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
VSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

TieredDiscountsMOTOEcomm

Parameter NameTypeRequiredDescriptionValidationExample Values
VSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
VSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MidMOTOTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
NonQualTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

TieredDiscountsRetail

Parameter NameTypeRequiredDescriptionValidationExample Values
VSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
VSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MidQualTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
NonQualTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

CustomInterchange

Parameter NameTypeRequiredDescriptionValidationExample Values
VcMcDsInterSurchargeTsysFeeOptional
VSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
VSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

CustomInterchangeDurbin

Parameter NameTypeRequiredDescriptionValidationExample Values
InterSurchargeTsysFeeOptional
InterNonSurchargeTsysFeeOptional
RegulatedDbSurchargeTsysFeeOptional
VSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
VSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MCQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualCrDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
DSQualDbDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

InterchangePlusPlus

Parameter NameTypeRequiredDescriptionValidationExample Values
QualifiedDiscountTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
MidQualTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")
NonQualTsysFeeOptionalFeePercentRange("0", "10") FeePerItemRange("0", "2")

ITsysFee

Parameter NameTypeRequiredDescriptionValidationExample Values
PerItemdecimalRequiredFee per item (fixed fee)
PercentdecimalRequiredFee per item (fixed fee)

TsysEquipment

Parameter NameTypeRequiredDescriptionValidationExample Values
TerminalsArray(TsysTerminal)Required

TsysTerminal

Parameter NameTypeRequiredDescriptionValidationExample Values
TerminalTypeTerminalsRequired'HYPERCOM_M4230_SPOSDCC', 'HYPERCOM_T4230_SPOSDCC', 'INGENICO_ICT220_INGEMV4', 'INGENICO_ICT220CTL_INGEMV4', 'INGENICO_ICT250_INGEMV4', 'INGENICO_IWL220_INGEMV4', 'INGENICO_IWL250_INGEMV4', 'INGENICO_IPP320_INGEMV4', 'VERIFONE_VX520_XEVA440', 'VERIFONE_VX680_XEVA440', 'CLSBPLUS_PAX', 'MULTIPASS', 'HCSTAGE', 'DIAL_PAY', 'NETEVIA_GATEWAY', 'AUTH_NET_GATEWAY', 'NMI_Unified_Gateway', 'USAePay_Gateway', 'Aldelo_EDC', 'Cardflight_mPOS', 'Dejavoo_Z8', 'Dejavoo_Z9', 'Dejavoo_Z11', 'Pax_S80', 'Pax_S300', 'Poynt', 'EHopper', 'Freedom_POS', 'Netevia_Light_POS', 'STGENCR', 'HCSTGEN', 'ValorVP100', 'ValorVP300', 'DejavooQD2', 'DejavooQD4', 'DejavooQD3', 'DejavooQD5', 'DejavooP1', 'DejavooP3', 'DejavooP5', 'ValorVL100', 'ValorVL300', 'ValorVL110'

AddressBase

Parameter Name Type Required Description Validation Example Values

Name

string

Required

Max Length:40

John Jones

Address

string

Required

Max Length:32

123 Avenue street

PostalCode

string

Required

Max Length:10

10010

City

string

Required

Max Length:25

New York

State

AmericanState

Required

'Alaska', 'Alabama', 'Arkansas', 'Arizona', 'California', 'Colorado', 'Connecticut', 'DistrictOfColumbia', 'Delaware', 'Florida', 'Georgia', 'Hawaii', 'Iowa', 'Idaho', 'Illinois', 'Indiana', 'Kansas', 'Kentucky', 'Louisiana', 'Massachusetts', 'Maryland', 'Maine', 'Michigan', 'Minnesota', 'Missouri', 'Mississippi', 'Montana', 'NorthCarolina', 'NorthDakota', 'Nebraska', 'NewHampshire', 'NewJersey', 'NewMexico', 'Nevada', 'NewYork', 'Ohio', 'Oklahoma', 'Oregon', 'Pennsylvania', 'PuertoRico', 'RhodeIsland', 'SouthCarolina', 'SouthDakota', 'Tennessee', 'Texas', 'Utah', 'Virginia', 'VirginIslands', 'Vermont', 'Washington', 'Wisconsin', 'WestVirginia', 'Wyoming'

Phone

string

Required

Regular Expression:"^d{10}$"
Numeric
Error Message:"Phone number must consist of 10 digits."
Error Message:"Phone number must consist of 10 digits, can't begin 0 or 1."

1231231231

Fax

string

Optional

Regular Expression:"^d{10}$"
Numeric
Error Message:"Phone number must consist of 10 digits."
Error Message:"Phone number must consist of 10 digits, can't begin 0 or 1."

3213213213

📘

Additional: The city and state must match the ZIP code.

Owner

Parameter Name Type Required Description Validation Example Values

FirstName

string

Required

Max Length:25 Min Length:2
Regular Expression:"^s_[A-Za-z]+s_$
Error Message: "The First Name field must be 1 word without digits

John

LastName

string

Required

Max Length:25 Min Length:2
Regular Expression:"^s_[A-Za-z]+s_$"
Error Message: The Last Name field must be 1 word without digits

Jones

DateOfBirth

DateTimeOffset

Required

DateRange("1/1/1900", "now")

01-01-2000

SSN

string

Required

TSYSSSN

123123123

Address

string

Required

Max Length:40
Regular Expression:"^[A-Za-zds]+$"Error Message: Please, use only letters and digits

123 Avenue street

City

string

Required

Max Length:13
Min Length: 2

New York

State

AmericanState

Required

'Alaska', 'Alabama', 'Arkansas', 'Arizona', 'California', 'Colorado', 'Connecticut', 'DistrictOfColumbia', 'Delaware', 'Florida', 'Georgia', 'Hawaii', 'Iowa', 'Idaho', 'Illinois', 'Indiana', 'Kansas', 'Kentucky', 'Louisiana', 'Massachusetts', 'Maryland', 'Maine', 'Michigan', 'Minnesota', 'Missouri', 'Mississippi', 'Montana', 'NorthCarolina', 'NorthDakota', 'Nebraska', 'NewHampshire', 'NewJersey', 'NewMexico', 'Nevada', 'NewYork', 'Ohio', 'Oklahoma', 'Oregon', 'Pennsylvania', 'PuertoRico', 'RhodeIsland', 'SouthCarolina', 'SouthDakota', 'Tennessee', 'Texas', 'Utah', 'Virginia', 'VirginIslands', 'Vermont', 'Washington', 'Wisconsin', 'WestVirginia', 'Wyoming'

Zip

string

Required

ZipCode

10010

HomePhone

string

Required

Regular Expression:"^d{10}$"
Numeric
Error Message:"Phone number must consist of 10 digits."
Error Message:"Phone number must consist of 10 digits, can't begin 0 or 1."

1231231231

Title

OwnerTitle

Required

'President', 'VPresident', 'Owner', 'Partner', 'Manager', 'Treasurer', 'Secretary', 'ExecDirector']

Ownership

int

Required

Range(25, 100)

100

Email

string

Required

Max Length:75
EmailAddress
ErrorMessage: The Email field is invalid.")

[email protected]

Guarantor

bool

Optional

true

TypeOfIssuedID

IssuedIdType

Optional

'USPassport', 'PermanentRegistrationCard', 'DriversLicense', 'USMilitaryCard', 'USCostGuardMerchantMarinerCard', 'USCitizenIdCard'

IDNumber

string

Optional

12312312

IDExpirationDate

DateTime

Optional

12-12-2030

📘

Additional: The city and state must match the ZIP code.

SecondaryOwner

Parameter Name Type Required Description Validation Example Values

FirstName

string

Required

Max Length:25 Min Length:2
Regular Expression:"^s_[A-Za-z]+s_$
Error Message: "The First Name field must be 1 word without digits

John

LastName

string

Required

Max Length:25 Min Length:2
Regular Expression:"^s_[A-Za-z]+s_$"
Error Message: The Last Name field must be 1 word without digits

Jones

DateOfBirth

DateTimeOffset

Required

DateRange("1/1/1900", "now")

01-01-2000

SSN

string

Required

Regular Expression:"d{9}$"
ErrorMessage: "Invalid SSN number, it must be true SSN 9 digits number"

123123123

Address

string

Required

Max Length:40
Regular Expression:"^[A-Za-zds]+$"Error Message: Please, use only letters and digits

123 Avenue street

City

string

Required

Max Length:13
Min Length: 2

New York

State

AmericanState

Required

'Alaska', 'Alabama', 'Arkansas', 'Arizona', 'California', 'Colorado', 'Connecticut', 'DistrictOfColumbia', 'Delaware', 'Florida', 'Georgia', 'Hawaii', 'Iowa', 'Idaho', 'Illinois', 'Indiana', 'Kansas', 'Kentucky', 'Louisiana', 'Massachusetts', 'Maryland', 'Maine', 'Michigan', 'Minnesota', 'Missouri', 'Mississippi', 'Montana', 'NorthCarolina', 'NorthDakota', 'Nebraska', 'NewHampshire', 'NewJersey', 'NewMexico', 'Nevada', 'NewYork', 'Ohio', 'Oklahoma', 'Oregon', 'Pennsylvania', 'PuertoRico', 'RhodeIsland', 'SouthCarolina', 'SouthDakota', 'Tennessee', 'Texas', 'Utah', 'Virginia', 'VirginIslands', 'Vermont', 'Washington', 'Wisconsin', 'WestVirginia', 'Wyoming'

Zip

string

Required

Regular Expression: "^d{5}(-d{4})?$"

Error Message: "Invalid Zip."

10010

HomePhone

string

Required

Regular Expression:"^d{10}$"
Numeric
Error Message:"Phone number must consist of 10 digits."
Error Message:"Phone number must consist of 10 digits, can't begin 0 or 1

1231231231

Title

OwnerTitle

Required

'President', 'VPresident', 'Owner', 'Partner', 'Manager', 'Treasurer', 'Secretary', 'ExecDirector']

Ownership

int

Required

Range(25, 100)

100

Guarantor

bool

Optional

true

TypeOfIssuedID

IssuedIdType

Optional

'USPassport', 'PermanentRegistrationCard', 'DriversLicense', 'USMilitaryCard', 'USCostGuardMerchantMarinerCard', 'USCitizenIdCard'

IDNumber

string

Optional

12312312

IDExpirationDate

DateTime

Optional

12-12-2030

📘

Additional: The city and state must match the ZIP code.

ControllingOfficer

Parameter Name Type Required Description Validation Example Values

DateOfBirth

DateTimeOffset

Required

DateRange("1/1/1900", "now")

01-01-2000

SSN

string

Required

Regular Expression: "d{9}$"
Error Message: "Invalid SSN number, it must be true SSN 9 digits number"

01-01-2000

FirstName

string

Required

Max Length:25 Min Length: 2
Regular Expression:"^s_[A-Za-z]+s_$"
Error Message: "The First Name field must be 1 word without digits"

John

LastName

Required

Required

Max Length:25 Min Length:2
Regular Expression:"^s_[A-Za-z]+s_$"
Error Message: "The Last Name field must be 1 word without digits"

Jones

Title

OwnerTitle

Required

'President', 'VPresident', 'Owner', 'Partner', 'Manager', 'Treasurer', 'Secretary', 'ExecDirector']

Address

string

Required

Max Length:40
Regular Expression:"^[A-Za-zds]+$"
Error Message: "Please, use only letters and digits"

123 Avenue street

Zip

string

Required

Regular Expression: "^d{5}(-d{4})?$"

Error Message: "Invalid Zip."

10010

City

string

Required

Max Length:25 Min Length:2

New York

State

AmericanState

Required

'Alaska', 'Alabama', 'Arkansas', 'Arizona', 'California', 'Colorado', 'Connecticut', 'DistrictOfColumbia', 'Delaware', 'Florida', 'Georgia', 'Hawaii', 'Iowa', 'Idaho', 'Illinois', 'Indiana', 'Kansas', 'Kentucky', 'Louisiana', 'Massachusetts', 'Maryland', 'Maine', 'Michigan', 'Minnesota', 'Missouri', 'Mississippi', 'Montana', 'NorthCarolina', 'NorthDakota', 'Nebraska', 'NewHampshire', 'NewJersey', 'NewMexico', 'Nevada', 'NewYork', 'Ohio', 'Oklahoma', 'Oregon', 'Pennsylvania', 'PuertoRico', 'RhodeIsland', 'SouthCarolina', 'SouthDakota', 'Tennessee', 'Texas', 'Utah', 'Virginia', 'VirginIslands', 'Vermont', 'Washington', 'Wisconsin', 'WestVirginia', 'Wyoming'

HomePhone

string

Required

Regular Expression:"^d{10}$"
Numeric
Error Message:"Phone number must consist of 10 digits."
Error Message:"Phone number must consist of 10 digits, can't begin 0 or 1."

1231231231

TypeOfIssuedID

IssuedIdType

Optional

'USPassport', 'PermanentRegistrationCard', 'DriversLicense', 'USMilitaryCard', 'USCostGuardMerchantMarinerCard', 'USCitizenIdCard'

IDNumber

string

Optional

Max Length:20

12312312

IDExpirationDate

DateTime

Optional

12-12-2030

Guarantor

bool

Optional

true

Email

string

Required

Max Length:75
EmailAddress
Error Message: "The Email field is invalid."

[email protected]

📘

Additional: The city and state must match the ZIP code.

TsysCnpInformation

Parameter NameTypeRequiredDescriptionValidationExample Values
IsWebHostingboolOptionalWeb Hostingfalse
IsDomainRegistrationboolOptionalDomainRegistrationfalse
IsWebPageDesignboolOptionalWeb Page Designfalse
IsAuctionboolOptionalAuctionfalse
IsInternetServiceGatewayboolOptionalInternet Service Gatewayfalse
IsSellingDigitalServiceboolOptionalSelling Digital Servicefalse
IsAdvertisementboolOptionalAdvertisementfalse
IsSellingHardGoodsboolOptionalSelling Hard Goodsfalse
IsOtherboolOptionalOther Business Typetrue
OtherInternetBusinessTypestringOptionalHow will the product be advertised or promoted?SMM
AdvertiseOrPromotionstringOptionalPromotion
SecureTransactionInformationstringOptionalIf you’re an e-commerce business or if you’re selling online, list the encryption methods, vendors and controls used to secure transaction informationPCI DSS
VendorsstringOptionalList the name(s) and address(es) of the vendor(s) from which supplies are purchasedWalmart
ProductFulfillmentstringOptionalWho performs product/service fulfillment? If direct from vendor, please provide Vendor Name, address and phone number in fullWalmart
SaleDescriptionstringOptionalPlease describe how a sale takes place from beginning of order until completion of fulfillment
MonthlyintOptional100
YearlyintOptional2000
QuarterlyintOptional30000
OneTimeintOptional10
HourlyintOptional1
IsMonthlyboolOptionalMonthlytrue
IsYearlyboolOptionalYearlyfalse
IsQuarterlyboolOptionalQuarterlyfalse
IsOneTimeboolOptionalOne Timefalse
IsHourlyboolOptionalHourlyfalse

📘

Additional: It's a block about Card Not Present information.

Response [POST] /api/v1/merchant/submit:

{  
  "data": {  
    "merchantProfileId": 123 - Internal merchant Profile ID in Netevia HQ  
  },  
  "status": 200, - Status of request  
  "requestId": 456 - Internal request ID in Netevia HQ  
}

Example submit

{  
    "MerchantProfile": {  
        "AgentProfileId": 123,  
        "CashDiscount": "Yes",  
        "POS": "None"  
    },  
    "businessAndOwnerInformation": {  
        "customerServicePhoneNum": "7606051441",  
        "federalTaxId": "464025551",  
        "dateOfStartBusiness": "2003-06-26",  
        "merchantEmail": "[[email protected]](mailto:[email protected])",  
        "merchantWebsite": "web.com",  
        "legalAddress": {  
            "name": "1ST GENERATION RADIATOR SERVICES",  
            "address": "11598 BARTLETT AVE",  
            "postalCode": "32927",  
            "city": "COCOA",  
            "state": "Florida",  
            "phone": "7606051441"  
        },  
        "dbaAddress": {  
            "name": "This is Test Merchant",  
            "address": "11598 BARTLETT AVE",  
            "postalCode": "32927",  
            "city": "COCOA",  
            "state": "Florida",  
            "phone": "7606051441"  
        },  
        "primaryOwner": {  
            "firstName": "MORAN",  
            "lastName": "DENNIS",  
            "dateOfBirth": "1964-08-20",  
            "ssn": "666091323",  
            "address": "30 MOREHOUSE LN",  
            "city": "COCOA",  
            "state": "Florida",  
            "zip": "32927",  
            "homePhone": "2038555858",  
            "title": "President",  
            "ownership": 100,  
            "email": "[[email protected]](mailto:[email protected])",  
            "guarantor": true,  
            "typeOfIssuedID": "DriversLicense",  
            "idNumber": "000000000"  
        }  
    },  
    "salesAndBusinessProfile": {  
        "sic": "5541",  
        "sellingGasFuel": true,  
        "typeOfOwnership": "Corporation",  
        "businessType": "Petroleum",  
        "accountType": "C",  
        "accountNumber": "1",  
        "businessCheckingRoutingNumber": "123123123",  
        "achMethod": "Combine",  
        "averageTicket": 99,  
        "highTicket": 100,  
        "salesToConsumers": 50.0,  
        "salesToBusiness": 40.0,  
        "salesToGovernment": 10.0,  
        "bankName": "TS",  
        "goodsAndServices": "goods",  
        "nextDayFunding": false,  
        "sameDayFunding": false,  
        "isVsMcDsNetwork": false,  
        "monthlyVolume": 9000,  
        "annualVolume": 108000,  
        "retail": 80,  
        "imprint": 0,  
        "moto": 0,  
        "internet": 20,  
         },  
    "SiteInspection": {  
        "InventoryMaintainedType": "OnSite",  
        "FulfillmentCenterNameAndAddress": "Tests",  
        "Question1": true,  
        "Question1Explanation": null,  
        "Question2": true,  
        "Question2Explanation": null,  
        "Question3": true,  
        "Question3Explanation": null,  
        "Question4": true,  
        "Question4Explanation": null,  
        "Zoning": "Industrial",  
        "SquareFootageType": "From_2001_To_4000",  
        "SquareFootageTypeOther": null,  
        "Merchant": "Leases",  
        "NameAddressLandlord": "Testt"  
    },  
    "serviceAcceptance": {  
        "visa": false,  
        "masterCard": false,  
        "fcsNumber": "7938491"  
    },  
    "fees": {  
        "minimumDiscountAmount": 50.0000,  
        "minimumDiscountStartDate": "2019-12-12",  
        "minimumDiscountType": "Monthly",  
        "earlyTerminationFeeAmount": 999999.0000,  
        "earlyTerminationFeeContractMonths": 60,  
        "amex": {  
            "interchangePlus": {  
                "qualifiedDiscount": {  
                    "perItem": 2.0000,  
                    "percent": 0.0000  
                }  
            }  
        },  
        "visaMasterCardDiscover": {  
            "interchangePlus": {  
                "vsQualCrDiscount": {  
                    "perItem": 2.0000,  
                    "percent": 0.0000  
                },  
                "vsQualDbDiscount": {  
                    "perItem": 2.0000,  
                    "percent": 0.0000  
                },  
                "mcQualCrDiscount": {  
                    "perItem": 2.0000,  
                    "percent": 0.0000  
                },  
                "mcQualDbDiscount": {  
                    "perItem": 2.0000,  
                    "percent": 0.0000  
                },  
                "dsQualCrDiscount": {  
                    "perItem": 2.0000,  
                    "percent": 0.0000  
                },  
                "dsQualDbDiscount": {  
                    "perItem": 2.0000,  
                    "percent": 0.0000  
                }  
            }  
        },  
        "authorizationMonthlyAndSpecialProgram": {  
            "vsmcdiscAuth": {  
                "perItem": 1,  
                "percent": 0  
            },  
            "amexAuth": {  
                "perItem": 0.1000,  
                "percent": 0.0000  
            },  
            "retrieval": {  
                "perItem": 5.0000,  
                "percent": 0.0000  
            },  
            "chargeback": {  
                "perItem": 25.0000,  
                "percent": 0.0000  
            },  
            "achReject": {  
                "perItem": 25.0000,  
                "percent": 0.0000  
            },  
            "statement": {  
                "perItem": 7.0000,  
                "percent": 0.0000  
            },  
            "tinMismatch": {  
                "perItem": 25.0000,  
                "percent": 0.0000  
            },  
            "pciNonCompliance": {  
                "perItem": 21.9500,  
                "percent": 0.0000  
            }  
        },  
        "debitPinAndEBT": {  
            "pinDebitMonthly": {  
                "perItem": 5.0000,  
                "percent": 0.0000  
            },  
            "pinDebitAuth": {  
                "perItem": 0.2500,  
                "percent": 0.0000  
            }  
        },  
        "miscFees": [  
            {  
                "name": "SERVICE FEE",  
                "startDate": "2022-12-05T00:00:00",  
                "frequency": 5,  
                "month": 12,  
                "year": 2019,  
                "perItem": 25.0000,  
                "percent": 0.0000  
            }  
        ],  
        "miscFeesVolume": \[]  
    }  
}

📘

FEES

Updated about 1 month ago