Users and access

Learn how your merchants' users get access, and how to show the merchant dashboard in your own UI.


Your merchants' users sign in to the merchant portal. When you create a merchant and Datman creates a new user for the owner's email address, the response contains a signup_link. Your merchant uses this link to complete sign-up. When sign-up is complete, the user becomes active.

In the merchant portal, your merchants can see their balance, payouts, transactions and reports. This means you do not need to build your own app for your merchants to see their payments. You can also use the Datman APIs and webhooks to build these lists and ledgers for each merchant yourself.

User management

Each merchant can have several portal users, each with a role on that merchant, for example Owner or Manager.

To see who has access to a merchant, make a List merchant users request. For each user, the response contains:

  • name and email.
  • roles: the user's role on this merchant.
  • status: Active when the user has completed sign-up, Pending when they have not.

The list contains only users with an active role on the merchant. It is not paginated.

To change the email address or phone number of a user who has not completed sign-up, or to extend their signup link, see Update a merchant.

Embedded dashboard

You can show Datman's merchant dashboard inside your own UI, so that your merchants can follow their payments and payouts without leaving your platform.

Available pages

Pagepage value
Overviewoverview
Paymentspayment
Payoutspayout

How it works

  1. Your server requests a session for the merchant with your partner API key:
  2. You load the URL in your UI, for example in an iframe.
  3. The session is valid for 10 minutes. expiresAt in the response is the expiry time, as a Unix timestamp in seconds. Request a new session when it expires.

You can only request sessions for merchants that belong to you. For any other merchant, the response is HTTP 404.

Keep your API key on your server. Request the session from your server, and pass only the URL or token to the browser.

See also

On this page

Need help?

Questions about your integration, credentials or going live?

Contact supportRequest a sandbox