For the complete documentation index, see llms.txt. This page is also available as Markdown.

Merchant Onboarding API Result Codes

The following are the result codes returned by the Merchant Onboarding APIs.

Value
HTTP Status Code
Message

9001

200

Approved

9002

401

Unauthorized

9003

500

System Error Other

9004

400

Invalid Request

9005

400

Valid Content-Type Header Required for PUT or POST

9006

400

Missing or Invalid Accept Type Header. Accept Type Header must be of type ‘application/json’

9007

400

Required request body content is missing, malformed, or datatype usage (ex- boolean, number) is invalid

9008

405

Http Method not supported

9009

404

Not Found

9010

400

Current merchant status cannot be updated to the requested status

9011

403

Forbidden

9012

400

Merchant is locked for editing

4000

400

Merchant number is required for this Bank Account request

4001

400

No bank account provided

4002

400

Bank account not found

4010

400

Bank name is required

4015

400

Bank Account Type Id is required

4016

400

Bank Account Type Id must be equal to or greater than 1 and less than or equal to 3

4020

400

Bank Account Name Type Id must be greater than 0

4025

400

Bank Account Other Name must be less than 100 characters

4030

400

Bank Account ABA/Routing number is required

4031

400

Bank Account ABA/Routing number must be all digits

4032

400

Bank Account ABA/Routing number is invalid

4040

400

Bank Account – Account Number is required

4041

400

Bank Account – Account Number must be all digits

4050

400

Bank Account name is required. Please provide either the NameOnAccount or the AccountHolderFirstName with the AccountHolderLastName

4051

400

Bank Account Only AccountHolderFirstName and AccountHolderLastName or NameOnAccount can be supplied, but not both

4052

400

When using AccountHolderFirstName on Bank Account, AccountHolderLastName is required

4053

400

When using AccountHolderLastName on Bank Account, AccountHolderFirstName is required

4060

400

Business bank accounts are required to cover fees, funds, and chargebacks.

4090

400

Bank account defaults not found

4091

400

File format must be valid image or pdf

4092

400

File must be smaller than 5MB

4093

400

The name on the bank account listed for deposits must match merchant’s legal name or DBA name.

4100

404

Business Contacts Not Found

4110

400

Merchant number is required for Business Contacts request

4120

400

A business contact must be added for every individual who owns at least 25% of a merchant.

4121

404

A disclosure for this merchant that every individual who owns at least 25% of a merchant has not been found

4200

404

Business Contact Not Found with that MerchantNumber supplied

4201

400

Phone Contact Type is Required

4202

405

Duplicate contact found

4203

400

Contact not found for this merchant number

4204

400

Merchant number was not provided for this request

4205

400

At least one Business Contact must be listed as a signer.

4210

400

Email Address is required for a business contact

4211

400

Email Address is invalid for a business contact

4212

400

Must have either a valid phone or a valid email address

4220

400

Ownership Amount is required for a business owner

4221

400

Business Ownership amount must be greater than 0 and less than 101

4230

400

Date of Birth is Required for a business contact

4231

400

Date of Birth is invalid. Date of Birth must be in the past and less than 200 years ago.

4240

400

First name is required for business contact

4241

400

First name is required for business contact

4250

400

One Phone number is required for business contact

4251

400

Area Code is Required for Business Contact Phone number

4252

400

Area Code Must be Three Digits for Business Contact Phone number

4253

400

Phone number prefix and line number for the Business Contact Phone Number are required

4254

400

Phone Number's prefix and line number must match the format 123-4567 when combined

4255

404

Phone Number not found

4260

400

Business Contact social security number is required

4261

400

Business Contact social security number is invalid

4270

400

Line 1 is required for Business Contact's Address

4275

400

City is required for Business Contact's Address

4280

400

State is required for Business Contact's Address

4285

400

Zip Code is required for Business Contact's Address

4290

400

Country Code is required for Business Contact's Address

4291

404

Business Contact's Address Not Found

4292

400

Contact Not Found

4293

400

One or more Contact Types are required.

4295

400

Country of citizenship is required for Business Contact

4296

400

Title is required for Owners and Signers

4297

400

Total Ownership Amount cannot exceed 100%.

4300

404

Contact Address Not Found

4400

404

Contact Not Found

4401

405

Found a duplicate contact and cannot save

4402

400

The contact Id provided is not associated with the merchant number provided

4403

400

Merchant number is required for this request

4410

400

Date of Birth is Required for a general contact

4411

400

Date of Birth is invalid. Date of Birth must be in the past and less than 200 years ago.

4500

400

Merchant number is required for this request

4501

400

Business information is required

4502

400

Business DBA (Doing Business As) name is required

4503

400

Business Hierarchy Node Key is required

4504

400

Business information is required

4505

400

Merchant Business’ was not found

4520

400

Merchant Business’ email address is invalid

4525

400

Merchant Business’ website is invalid

4530

400

Merchant Business’ phone number is required

4531

400

Merchant Business’ phone number phone contact type is required

4532

400

Merchant Business’ phone number area code is required

4533

400

Merchant Business’ phone number area code must be 3 digits

4534

400

Merchant Business’ phone number must have a line number and prefix. They are required

4535

400

Merchant Business’ phone number must match the format 123-4567

4540

400

Merchant Business’ Company Type is required

4545

400

Merchant Business’ Sales Information is required

4600

400

PageSize is required for this request

4601

400

PageSize must have a value no less than 1

4605

400

PageNumber is required for this request

4606

400

PageNumber must have a value no less than 1

4800

400

Merchant number is required for this request

4801

404

Merchant business mailing address not found

4802

400

Merchant business mailing address information is required

4803

400

Merchant business mailing address Line 1 is required

4804

400

Merchant business mailing address City is required

4805

400

Merchant business mailing address State Code is required

4806

400

Merchant business mailing address Zip is required

4807

400

Merchant business mailing address Country Code is required

4900

400

Merchant number is required for this request

4901

400

Merchant business physical address information is required for this request

4902

404

Merchant business physical address not found

4903

400

Merchant business physical address Line 1 is required

4904

400

Merchant business physical address City is required

4905

400

Merchant business physical address State Code is required

4906

400

Merchant business physical address Zip is required

4907

400

Merchant business physical address Country Code is required

5000

404

Sales information not found

5001

400

Merchant number is required for this request

5010

400

Sales Information has an invalid Business Id

5100

404

Sales profile not found

5101

400

Sales Profile’s Merchant Category Code (MCC) was not found

5102

400

Sales Profile’s Merchant Category Code (MCC) is required

5103

400

Sales Profile’s Merchant Category Code (MCC) must be all digits

5104

400

Sales Profile’s Category Code (MCC) must be 4 digits

5105

400

Merchant Number is required for this request

5106

400

Sales Profile’s Moto Keyed Percentage and E-Commerce Percentage do not total 100

5107

400

Sales Profile’s Card Present Percentage is required

5108

400

Sales Profile’s Card Present Percentage must be either 0, 100, or between 0 and 100

5110

400

Sales Profile’s eCommerce Percentage is required

5111

400

Sales Profile’s eCommerce Percentage is must be either 0, 100, or between 0 and 100

5115

400

Sales Profile’s Moto Keyed Percentage is required

5116

400

Sales Profile’s Moto Keyed Percentage must be either 0, 100, or between 0 and 100

5120

400

Sales Profile’s Refund/Return Policy is required

5125

400

Sales Profile’s Products Sold is required

5130

400

Sales Profile’s Previously Accepted Payment Cards is required

5135

400

Sales Profile’s CompetitorId is required

5136

400

Sales Profile’s CompetitorId is invalid

5140

400

Sales Profile’s Previously Terminated Or Identified By Risk Monitoring is required

5145

400

Sales Profile’s Reason Previously Terminated Or Identified By Risk is required

5150

400

Sales Profile’s Currently Open For Business is required

5155

400

Sales Profile’s annual volume is required

5160

400

Sales Profile’s average ticket is required

5161

400

Sales Profile’s high ticket is required

5165

400

Sales Profile’s Owns Product is required

5170

400

Sales Profile’s Orders Product is required

5175

400

Sales Profile’s Sells Firearms is required

5176

400

Sales Profile Fire Arms License Must be no more than 15 characters

5180

400

Sales Profile’s Sells Firearm Accessories is required

5181

400

Sales Profile’s Sells Firearm License is required

5185

400

Sales Profile’s Future Delivery Type Id is required when Future Delivery Percentage is greater than 0.

5186

400

Sales Profile’s Future Delivery Percentage must be either 0, 100, or between 0 and 100

5187

400

Sales Profile’s Amex MID is required when American Express ESA Direct is selected

5188

400

Sales Profile’s EBT Number is required when EBT is selected

5190

400

Sales Profile: At Least One Card Brand Is Required

5191

400

Sales Profile: Cannot Have American Express Opt Blue Card Brand along with American Express ESA, please choose one or the other

5192

400

Sales Profile: Cannot have more than one American Express ESA Card Brand

5193

400

Sales Profile: Cannot have more than one American Express Opt Blue Card Brand

5194

400

Sales Profile: Cannot have more than one Debit Network Card Brand

5195

400

Sales Profile: Cannot have more than one Discover Card Brand

5196

400

Sales Profile: Cannot have more than one EBT Card Brand

5197

400

Sales Profile: Cannot have more than one MasterCard Card-Brand

5198

400

Sales Profile: Cannot have more than one Visa Card Brand

5199

400

Sales Profile: Future Delivery Percentage is required.

5200

400

Sales Profile: If Future Delivery Type ID is ‘Other’ the Other Delivery Type field should be used to indicate the time period in which deliveries will be fulfilled.

5201

400

Sales Profile: Invalid Future Delivery Type ID.

5202

400

Sales Profile’s AmexMid must be a numeric value containing less than 10 digits.

5203

400

Sales Profile’s EBTNumber must be a numeric value containing less than 20 digits.

5300

404

Site survey not found

5301

400

Merchant Number is required for this request

5310

400

Site survey Site Type ID must be 1, 2, 3, or 4

5311

400

Site survey Site Type ID is required

5312

400

Site survey Agreement Accepted must be true

5313

400

Site survey Site Survey Conducted in Person is required

5314

400

Site survey Merchant Acquisition Type ID is required when Site Survey Conducted in Person is false

5315

400

Site survey Merchant Acquisition Type ID must be between 1 and 3

5317

400

Site survey Inventory Matches Product Sold is required

5318

400

Site survey Inventory Matches Product Sold comments are required when Inventory Matches Product Sold is False

5320

400

Site survey valid verified id is required

5330

400

Site survey’s Other Site Type Description valid verified id is required

5400

404

Tax payer not found

5401

400

Merchant number is required for this request

5405

400

TIN is required for this request

5410

400

TIN must be 9 digits and must be a valid sequence of numbers

5415

400

TINTypeID is required for this request

5420

400

TINTypeID must be between 1 and 3

5425

400

Business Legal Name is required for this request

5500

404

Electronic Document not found

5501

404

Electronic Document content not found

5510

400

Electronic Document category is invalid

5600

400

Merchant number is required

5601

404

Application Progress Section Not Found

5700

400

Required signature missing. Signature information is required for each section of the application: MerchantAgreement, PersonalGuarantee, BankDisclosure, and W-9. For signatures provided electronically, AgreementToSignElectronically and ElectronicConfirmation are also required.

5701

400

Duplicate signature. Only a single signature can be provided for each section of the application.

5702

400

All signatures must be linked to a BusinessContactID.

5703

400

Selected BusinessContactID does not exist in system.

5704

400

IPAddress and TimeStamp are required for signatures collected via an online form.

5705

400

DocumentID is required for signatures collected via document upload.

6000

400

Fee is required for selected template.

6001

400

Fee MasterCard Qualified CheckCard is required for selected template.

6002

400

Fee Visa Qualified CheckCard is required for selected template.

6003

400

Fee MasterCard Qualified Credit is required for selected template.

6004

400

Fee Visa Qualified Credit is required for selected template.

6005

400

Fee American Express is required for selected template.

6006

400

Fee Discover is required for selected template.

6007

400

Fee IC Plus: Interchange, Dues, Fees and Assessments is required for selected template.

6008

400

Fee PIN-Debit Conveyance is required for selected template.

6009

400

Fee EBT is required for selected template.

6010

400

Fee Mid Qualified Surcharge is required for selected template.

6011

400

Fee Non Qualified Surcharge is required for selected template.

6012

400

Fee Interchange Passthrough is required for selected template.

6013

400

Fee Authorization Fee is required for selected template.

6014

400

Fee AVS Transactions (Surcharge) is required for selected template.

6015

400

Fee Voice Authorization is required for selected template.

6016

400

Fee Chargeback Item Processing is required for selected template.

6017

400

Fee Retrieval Item Processing is required for selected template.

6018

400

Fee Monthly Account Fee is required for selected template.

6019

400

Fee Monthly Minimum Discount is required for selected template.

6020

400

Fee Gross Settlement Fee is required for selected template.

6021

400

Fee Debit Access Fee is required for selected template.

6022

400

Fee Monthly Compass Online Reporting is required for selected template.