From Onboarding to Configuration: Manage Everything via API

The Merchant Onboarding API now extends beyond basic merchant, store, and TPN creation to support full lifecycle management and configuration. While onboarding (merchant + first store + TPN) was already supported, this update introduces new capabilities for TPN parameter retrieval, dynamic configuration, and feature enablement—reducing dependency on the iPOSpays Portal and enabling end-to-end automation from your CRM.

For example, ISVs can now retrieve AUTH-TOKEN and SPIn credentials (Registered ID, AUTH-KEY) directly via API and use them within their CRM, eliminating manual copy-paste from the portal. They can also whitelist merchant domains (e.g., for Freedom to Design) directly through the API, without requiring merchants to log in to the iPOSpays Portal.

Key Capabilities

• Expand Existing Merchants

Add new stores and configure additional TPNs programmatically.

• Retrieve TPN Parameters

Fetch OTP, AUTH-TOKEN, and SPIn credentials (Registered ID, AUTH-KEY) without manual portal access.

• Dynamic TPN Configuration

Enable or disable parameters like SPIn and configure processor settings, including ACH support.

• Feature Enablement via API

Configure merchant-level features (e.g., whitelisting) and store-level features (e.g., ACH) directly via API.

• End-to-End Onboarding (Existing Capability)

Create a merchant with their first store and TPN in a single API flow.

Key Highlights

• REST-based APIs following standard conventions

• Secure authentication and authorization

• Standardized input validation and error handling

• Idempotent operations for safe retries

• Postman and Swagger documentation available

Additional Updates

• The Merchant module now includes Merchant ID, Store ID, and TPN ID for API usage

• IDs are available in the UI and downloadable reports for integration

Refer to the Merchant Onboarding API to onboard merchants and manage TPN configuration: