Tapaya

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.

DetailValue
Base URLhttps://api.sandbox.tapaya.com for sandbox, https://api.tapaya.com for production
AuthenticationServer Secret Token in Authorization. See Authentication.
AmountsMinor units: 2500 with EUR is 25.00 EUR. Relative fees in basis points: 100 is 1%.
Related guideMerchant Onboarding

All operations

OperationUse it to
Read a saved onboardingContinue a merchant's onboarding form where they left it.
Save channel selectionsStore the payment channels a merchant chose, without submitting.
List membersSee who already has access to a merchant.
List terminalsShow a merchant's terminals and their devices.
List email invitesTrack single-use invites sent to known recipients.
List reusable linksTrack campaign links and whether they are paused.
Create a reusable linkStart a campaign that many merchants can register through.
Change an invite's expiryExtend or shorten an invite, including an expired one.
Pause or resume a reusable linkStop new registrations for a while without revoking the link.
List pricing setsFind the pricing sets your organization may build profiles from.
List commission profilesChoose a profile to assign to an invite.
Create a commission profileOffer merchants a price list built from a pricing set.
Update a commission profileRename a profile or change its rates.
Delete a commission profileRemove a profile you no longer offer.
Set the default profileChoose the profile that invites use when they name none.
Read merchant pricingShow 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.

CodeDescription
400Invalid channel data, profile selection, filters or expiry, or deleting a default or assigned profile.
401The Server Secret Token is missing or invalid.
404The resource is not available to your organization, or the saved onboarding or pricing does not exist.
409A stale profile revision, conflicting onboarding state, or an invite that was used or revoked.
Missing something on this page?Request a feature. We attach this page so the team sees the context.