Merchant Onboarding
Create and manage merchants on the Scan to Pay platform via API. For PSPs, aggregators, and acquirers loading merchants at scale.
If you're a PSP, an aggregator, or an acquirer who needs to bring merchants onto Scan to Pay at scale, this section is for you. The Merchant Onboarding API lets you create, suspend, update, and manage merchants from your own systems — instead of clicking through the Portal one merchant at a time.
If you're a single merchant integrating Scan to Pay for your own business, you don't need this section. Your onboarding is handled directly through the Portal during initial setup — see Sandbox and test cards for getting credentials.
When to use the onboarding API
| ✅ Good fit | ❌ Wrong fit |
|---|---|
| PSP onboarding many merchants over time | Single-merchant integration |
| Aggregator running a marketplace where merchants self-serve | Manual one-off setup |
| Acquirer loading bank-acquired merchants programmatically | Updating your own merchant profile (use the Portal) |
| Automated provisioning during signup on your platform | Test / pre-production merchant setup (use the Portal) |
Two integrator audiences
The API has two slightly different surface areas depending on who you are:
- PSP / Aggregator flows — PSPs onboarding their own merchants. Authenticate with your PSP credentials (PSP ID + API password). You own the merchant relationship.
- Acquirer flows — Acquiring banks loading merchants on behalf of merchant accounts they already manage. Authenticate with acquirer-specific credentials issued by EFT Corp directly (not generated in the Portal).
Both call the same /portal/restful/merchant/* endpoints; the difference is in credential type and which sub-operations apply.
In this section
- Onboarding overview — the 11 operations, auth setup, base URL, end-to-end onboarding lifecycle
- Acquirer flows — request shape for acquirers
- PSP / Aggregator flows — request shape for PSPs
- Business rules — credentials, notification URLs, password rotation, auto-activation, audit
- Testing — sandbox onboarding, SIT process, UAT acceptance test pack
What's next
- Authentication for the onboarding API → Authentication
- What happens after a merchant is onboarded → Quickstart for the merchant
- Sandbox-test the onboarding flow → Testing
- Pre-go-live checklist → Going live
Updated 3 days ago