API Reference
  1. Customer Portal
  2. Merchants

Create a merchant

post
https://{hostname}/api/v1/onboard/merchant

Creates a merchant under your platform. Include your own externalId
to link it to your system; sending that same externalId again later
updates the merchant instead of creating a duplicate.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The writable fields of a merchant.

string
required

The merchant's display name.

string

The merchant's identifier in your system. Send it again on a later request to update the same record.

uri

A URL to the merchant's logo.

string

The merchant's primary brand color (e.g. a hex value).

string
^[a-z0-9-]+$

A lowercase alphanumeric/hyphen slug for the merchant's portal URL.

Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?