Merchant Onboarding APIs

The Boarding APIs provide a complete solution for onboarding merchants. It allows integrators to manage the merchant sign-up experience and ensure a smooth process.

Boarding Management API

Merchant Application	PUT: Update Properties GET: Get Properties POST: Create Application POST: Default Pricing Plan POST: Submit Signatures POST: Submit Application

Merchant Demographics API

Bank Account	GET: Get Bank Account POST: Create Bank Account PUT: Update Bank Accounts DELETE: Delete Bank Accounts PUT: Update Bank Account DELETE: Delete Bank Account
Business Contact	GET: Get Business Contact PUT: Update Business Contact DELETE: Delete Business Contact GET: Get Business Contacts POST: Create Business Contact POST: Create Ownership Disclosure PUT: Update Ownership Disclosure GET: Get Ownership Disclosure
Documents	GET: Get Voided Checks POST: Upload Voided Checks POST: Upload Voided Checks - Base64Format POST: Upload Voided Checks - MultipleDocuments - Base64Format POST: MultipleDocuments POST: Base64Format POST: Upload Document GET: Get Documents By Category POST: Upload Signed Application - Base64Format POST: Upload Signed Application GET: Get Documents By MerchantNumber GET: Get Documents By DocumentId DELETE: Delete Document DELETE: Delete Voided Checks POST: Update VoidedCheck's bank account number
Merchant:	GET: Merchants POST: Creates Merchant GET: Gets Merchant PUT: Updates Merchant DELETE: Deletes Merchant GET: Gets Physical Address PUT: Updates Physical Address GET: Gets Mailing Address PUT: Updates Mailing Addres
References	GET: Get Country Codes using Address Type GET: Returns a list of state options GET: Get MCC Codes GET: Get Company Types GET: Get Compensation Types GET: Get Previous Processors GET: Get Businesses Under User GET: Search For Businesses Under User GET: Get Phone Types GET: Get Contact Types GET: Get Relationship Origin Types GET: Get Document Categories GET: Get Signature Sections GET: Get Signature Source Types GET: Get Site Types GET: Get Future Delivery Type
Sales Profile	GET: Get SalesProfile - v2.0 PUT: Update SalesProfile - v2.0
Site Survey	GET: Get Site Survey PUT: Update Site Survey
Tax Payer	GET: Get Taxpayer - v2.0 PUT: Update Taxpayer - v2.0

Merchant Legal Documents API

Signatures	GET: Get Signatures - Legal Documents PUT: Update Signatures - Legal Documents DELETE: Delete Signatures - Legal Documents GET: Get Signatures - Demographics PUT: Update Signatures - Demographics DELETE: Delete Signatures - Demographics
Types	GET: Returns Types of Terms and Conditions - Demographics GET: Returns Types of Terms and Conditions - Legal Documents
Terms And Conditions	GET: Returns Terms and Conditions applicable to merchant identified by MerchantNumber - Demographics GET: Returns Terms and Conditions applicable to merchant identified by MerchantNumber - Legal Documents GET: Returns Terms and Conditions entry for specified Type ID - Demographics GET: Returns Terms and Conditions entry for specified Type ID - Legal Documents

Pricing Plan API

Pricing Plan V2	GET: Returns a pricing plan POST: Creates a pricing plan DELETE: Deletes a pricing plan GET: Returns all pricing plans of the merchant PUT: Updates a pricing plan DELETE: Deletes a pricing plan GET: Templates GET: Eligibility GET: EmpowerAttributes
Reference	GET: PayInMonth GET: DisplayTypeCode

Equipment Order API

Equipment Order	POST: Post Equipment Order GET: Get a merchant's existing order DELETE: Delete a merchant's existing order GET: Get a merchant's existing order by order id GET: Get a merchant's existing order by merchant and status

Equipment Configuration Survey API

Equipment Configuration Survey	GET: Get Equipment Configuration Survey

Equipment Terminal Loader API

Equipment Terminal Loader	GET: Get All Products (devices) that match search criteria GET: Get One Product (device)

eDocs Reporting API

eDocs Reporting	GET: Get Document from eDocs GET: Get Document Types GET: Get Documents By Type GET: Get Statements by Year GET: Get Statements by Year and Month

Launch Integrator Setup API

Launch Integrator Setup	GET: Retrieves a merchant POST: Creates a new merchant