Merchant Management
Manage onboarding drafts, registration invites, merchant access and contractual pricing from your backend.
Manage the merchants in your organization from your backend. Every call uses your Server Secret Token, so keep it on your server.
| Detail | Value |
|---|---|
| Base URL | https://api.sandbox.tapaya.com for sandbox, https://api.tapaya.com for production |
| Authentication | Server Secret Token in Authorization. See Authentication. |
| Amounts | Minor units: 2500 with EUR is 25.00 EUR. Relative fees in basis points: 100 is 1%. |
| Related guide | Merchant Onboarding |
All operations
| Operation | Use it to |
|---|---|
| Read a saved onboarding | Continue a merchant's onboarding form where they left it. |
| Save channel selections | Store the payment channels a merchant chose, without submitting. |
| List members | See who already has access to a merchant. |
| List terminals | Show a merchant's terminals and their devices. |
| List email invites | Track single-use invites sent to known recipients. |
| List reusable links | Track campaign links and whether they are paused. |
| Create a reusable link | Start a campaign that many merchants can register through. |
| Change an invite's expiry | Extend or shorten an invite, including an expired one. |
| Pause or resume a reusable link | Stop new registrations for a while without revoking the link. |
| List pricing sets | Find the pricing sets your organization may build profiles from. |
| List commission profiles | Choose a profile to assign to an invite. |
| Create a commission profile | Offer merchants a price list built from a pricing set. |
| Update a commission profile | Rename a profile or change its rates. |
| Delete a commission profile | Remove a profile you no longer offer. |
| Set the default profile | Choose the profile that invites use when they name none. |
| Read merchant pricing | Show the rates a merchant signed up with. |
Onboarding drafts
Members and terminals
Registration invites
Use an email invite for a known recipient, or a reusable link for a campaign. Both can restrict channels and assign commission profiles.
Commission profiles
A commission profile is the price list you offer merchants. Build it from a pricing set your organization is authorized for.
Merchant pricing
Errors
Every operation answers with these status codes when a request fails.
| Code | Description |
|---|---|
400 | Invalid channel data, profile selection, filters or expiry, or deleting a default or assigned profile. |
401 | The Server Secret Token is missing or invalid. |
404 | The resource is not available to your organization, or the saved onboarding or pricing does not exist. |
409 | A stale profile revision, conflicting onboarding state, or an invite that was used or revoked. |