API Reference
  1. Customer Portal
  2. Merchants

Update a merchant

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

Updates an existing merchant, identified by its Outpave id or your externalId.

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

The record's Outpave id (a UUID), or your own externalId (any non-UUID value is treated as an externalId).

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?