Clearent API
Clearent (now Xplor Pay) is an embedded payments platform that lets software vendors process card-present and card-not-present transactions, tokenize cards, run recurring billing, board merchants, and manage disputes. An unofficial API lets you programmatically pull transactions, settlement batches, merchant boarding records, recurring schedules, and dispute cases—and push sales, refunds, voids, tokens, and new merchant applications back into Clearent.
What is Clearent?
Clearent, now operating as Xplor Pay, is an embedded payments and payment-processing platform built primarily for software vendors and SaaS companies. Having evolved from a traditional credit card processor into a consultative embedded-payments partner, Clearent lets software providers accept card-present and card-not-present payments across omnichannel environments, tokenize and store cards, run recurring billing, board merchants through a PayFac-as-a-Service model, and manage disputes—all through a REST-based payment gateway and developer center.
Core product areas include:
- Payment Processing Solutions (POS, mobile payment app, Virtual Terminal, Text-to-Pay, Hosted Payments pages)
- Developer APIs (Transaction, Reporting, Boarding, Recurring Payments, Marketing, and Dispute Management)
- PayFac as a Service platform with white-label payment options and low-code components
- Mobile Payments SDK for iOS, Android, and Windows with plug-and-play card readers
- Merchant Services (cash discounting, smart invoicing, gift cards and loyalty, recurring billing, merchant financing)
Common data entities:
- Transactions, Sales, Authorizations, Captures, Refunds, Voids
- Payment Tokens, Card-on-File Vault entries, Customers
- Settlement Batches, Deposits, Funding records
- Merchant Boarding applications, Merchant Accounts (MIDs)
- Recurring Payment schedules, Plans, Invoices
- Disputes, Chargebacks, Retrieval requests
The Clearent Integration Challenge
Software platforms rely on Clearent to move money daily, but turning its portals, gateway, and PayFac workflows into reliable end-to-end automation is non-trivial:
- Multiple API surfaces: Transaction, Reporting, Boarding, Recurring Payments, Marketing, and Dispute Management each have their own object models, IDs, and lifecycle states to stitch together
- PCI scope and tokenization: Card data must flow through tokenization, P2PE, and PCI-validated encryption, which complicates headless automation against the gateway
- Partner and boarding gates: PayFac-as-a-Service onboarding and merchant boarding require credentials, sub-merchant entitlements, and approval flows before programmatic access
- Portal-only data: Settlement, funding, and dispute detail often live in the Partner and Merchant portals rather than a single clean API feed
- Rebrand and version drift: The Clearent-to-Xplor-Pay transition spans developer.clearent.com and docs.xplorpay.com, and endpoint coverage differs across legacy and current references
- Reconciliation precision: Matching sales, refunds, chargebacks, and deposits requires careful batch, reason-code, and idempotency handling to avoid double-posting
How Supergood Creates Clearent APIs
Supergood reverse-engineers authenticated gateway calls, the Clearent / Xplor Pay developer center, and Partner and Merchant portal flows to deliver a resilient API layer for your Clearent account—across transactions, recurring billing, boarding, and disputes.
- Handles API key authentication and managed sessions against the gateway and portals securely
- Preserves tokenization and PCI-scope-reducing flows so card data stays in the vault, not your stack
- Normalizes responses across Transaction, Reporting, Boarding, Recurring, and Dispute surfaces so you integrate once and rely on consistent objects
- Adds retry, backoff, and idempotency keys for sales, refunds, and settlement reconciliation
Use Clearent with AI agents: Clearent MCP Server →
Getting Started
- Schedule Integration Assessment
Book a 30-minute session to confirm your Clearent products, gateway endpoints, and authentication model.
- Supergood Generates and Validates Your API
We deliver a hardened, production-ready Clearent adapter tailored to your merchant configuration and entitlements.
- Deploy with Monitoring
Go live with continuous monitoring and automatic adjustments as Clearent and Xplor Pay evolve.
API Endpoints
Authentication
/authenticateAuthenticate to a Clearent / Xplor Pay account using an API key and obtain a session for downstream gateway and portal calls.
Transactions
/transactionsList card-present and card-not-present transactions with filters for merchant, status, card type, and date range.
Transactions
/create_saleSubmit a sale or authorization through the REST payment gateway using a card token, with optional capture.
Transactions
/refundIssue a refund or void against an existing transaction with amount and reason details.
Tokens
/create_tokenTokenize a card into the card-on-file vault for PCI-scope-reducing recurring and stored-card payments.
Settlement
/settlementsRetrieve settlement batches, deposits, and funding records from the reporting surface for reconciliation.
Recurring
/recurring_paymentsList recurring payment schedules and plans tied to vaulted tokens and customers.
Disputes
/disputesPull disputes, chargebacks, and retrieval requests with case status and merchant filters.
Use Cases
Embed payments and sync transaction data
- Submit sales, authorizations, captures, refunds, and voids through the REST payment gateway - Stream transaction and approval events into your ledger, BI, and customer dashboards - Tokenize cards into the vault so card data never touches your stack
Reconcile settlement and funding
- Pull settlement batches, deposits, and funding records into accounting and GL systems - Match sales, refunds, and chargebacks against deposits with idempotent reconciliation - Surface funding delays and exceptions to finance workflows
Automate recurring billing and card-on-file
- Create and manage recurring payment schedules tied to vaulted tokens - Update card-on-file entries and retry failed recurring charges automatically - Sync recurring plan and invoice status into your subscription system
Streamline merchant boarding and disputes
- Submit and track merchant boarding applications through PayFac-as-a-Service - Pull merchant account (MID) status and entitlements for sub-merchant management - Monitor chargebacks and retrieval requests and route them to dispute-response workflows
Technical Specifications
Authentication
API key authentication against the gateway and developer center, handled in a managed session
Connectivity
REST-based payment gateway API plus authenticated Partner and Merchant portal flows where data is portal-only
Response format
Normalized JSON across Transaction, Reporting, Boarding, Recurring, and Dispute objects
Rate limits
Adaptive throttling tuned to your merchant account to stay within Clearent gateway limits
Session management
Automatic key rotation, session refresh, and credential vaulting
Data freshness
Near real-time transaction reads with scheduled batch syncs for settlement and funding
Security
Tokenization, P2PE, PCI-validated encryption, scoped tokens, and audit logging keep card data in the vault
Webhooks
Event-style callbacks for transaction approval, settlement, recurring charges, and dispute status changes
Latency
Sub-second reads on cached entities; gateway-bound latency on live sale and refund posts
Throughput
Horizontally scaled workers sized to high-volume omnichannel transaction flows
Reliability
Retry, backoff, and idempotency keys for sales, refunds, and settlement reconciliation
Adaptation
Continuous monitoring of Clearent / Xplor Pay developer-center changes and gateway version drift
Frequently asked questions
Yes. Clearent now operates as Xplor Pay, and the developer surfaces span developer.clearent.com and docs.xplorpay.com. Supergood works against both legacy Clearent and current Xplor Pay gateway and portal surfaces, so the rebrand and version drift are handled for you.
Supergood preserves Clearent's tokenization, P2PE, and PCI-validated encryption flows. Cards are vaulted as tokens through the gateway, so raw card data never lands in your stack and your PCI scope stays reduced.
Yes. We normalize Clearent's Transaction, Reporting, Boarding, Recurring Payments, and Dispute Management surfaces into a single consistent API so you integrate once across all of them.
Supergood works with your existing Clearent merchant credentials and entitlements. PayFac-as-a-Service boarding approvals are only required when you specifically want to board sub-merchants or consume that workflow programmatically.
We pull settlement batches, deposits, and funding records and match them against sales, refunds, and chargebacks using idempotency keys and reason-code handling to avoid double-posting.