ProductsMerchant Management API
For Independent Sales Organizations (ISOs), Independent Software Vendors (ISVs), and payment service providers, the Merchant Management API enables you to build dashboards for both merchants and sales agents. Give your merchants an exceptional self-service experience, while putting comprehensive portfolio management at your team's fingertips.
Overview
End User | Use Case | Language | Functions |
|---|---|---|---|
ISOs, ISVs, PayFacs | Build merchant account management dashboards for both sales agents and merchants. | Any server-side language with REST calls, JSON | Create and Update Disputes, Create and Update Business Data, Update Pricing Data, Create and Update Equipment Data, Update Contact Data, and more |
Merchant Dashboard
View some of the ways this API can be leveraged to build a powerful self-service dashboard for your merchants.
Business
Update business tax ID and corporate data, update business address, update business contact information
Banking and Processing
Update bank account data, manage split funding, view transaction parameters, view processing statements
Disputes and Chargebacks
View chargebacks, upload supporting documents, add notes to disputes, track dispute statuses and deadlines
Compliance
Track PCI compliance status, monitor TIN/tax validation status, access compliance documentation
Payment Hardware
View payment hardware inventory, track serial numbers and deployment statuses, update terminal features such as tips and EBT
1/3
Merchant and Agent Dashboards
Create two powerful dashboard experiences: A merchant portal where businesses can manage their banking details, handle disputes, track equipment, and update business information. Plus a sales agent portal with advanced functionality to adjust fees and pricing, configure processing parameters, and oversee all merchant-accessible features across an entire portfolio.Comprehensive Portfolio Management
Empower sales agents with tools to manage their merchant accounts through a single interface. Agents can configure pricing settings, manage fee schedules, update transaction parameters, and handle everything merchants can access.Self-Service Merchant Tools
Enable merchants to manage their own account data including banking details, business information, dispute handling, and equipment settings. Merchants get direct access to upload documents, track dispute statuses, update contact information, and monitor their processing equipment — all without requiring agent assistance.1/3
Agent Dashboard
View some of the ways this API can be leveraged to build a comprehensive account-management dashboard for your sales agents.
Portfolio Management
View merchant underwriting status, track sales volumes and metrics, add notes to merchant accounts, handle merchant inquiries, view merchant documentation
Pricing and Processing
Manage fee schedules and rates, adjust discount frequencies, set merchant transaction parameters, control batch processing parameters
Risk Management
Review chargeback cases, monitor merchant transaction volumes and average transaction amounts, configure processing limits, set high ticket override parameters
Compliance
Manage compliance billing tiers, monitor PCI compliance status, track TIN/tax status
Payment Hardware
Deploy and activate payment terminals, configure terminal settings, manage terminal serial numbers and tracking
1/3
Release Notes
Changes to this API are released to the Sandbox environment approximately one month before the Production environment. This is intended to provide developers with enough time to implement and test the changes before the Production environment is affected. Two versions of the specification are published to reflect the current state of each environment. Toggle between the Production and Sandbox versions on the API specification page.