OnBoard API

Merchant Onboarding API enable ISOs to programmatically onboard and manage merchants, stores, and TPNs directly from external systems (CRM/portal), eliminating manual portal interaction.

With this API, all data entered in your CRM or portal is automatically synced with the iPOSpays portal, enabling you to onboard merchants conveniently and efficiently.

Supported Operations

Key Capabilities

• Onboard a completely new merchant along with their first store and TPN.
• Enable merchant-level add-on features (e.g., Whitelisting)
• Expand an existing merchant’s setup by adding a new store and TPN.
• Request and retrieve required TPN parameter information like OTP, AUTH-TOKEN, SPIN details (i.e., Registered Id, AUTH-KEY)
• Enable or disable specific TPN parameters like SPIn
• Enable store-level add-on features (e.g., ACH)

Prerequisites

Before invoking any API in this document, the following conditions must be satisfied:

• The ISO (Independent Sales Organization) must already be onboarded in the iPOSpays portal.
• The following entities must be created and active, except the onboard API call:
  • Merchant
  • Store
  • TPN (Terminal Profile Number)
• The integrator must possess:
  • API Key
  • Secret Key

These are required to generate an Access Token, which must be included in all subsequent API calls.