API Reference

Update Merchant

patch
https://api.prahsys.com/merchant/n1/merchant/

Update an existing merchant from Prahsys

Path Params
string
required

The merchant id

Body Params
string
length ≥ 1

DBA of the merchant

string
string
length ≥ 1

Phone number in E.164 format (any country). Extensions are not accepted.

uri

Website of the merchant

string
length ≥ 1

Id of the merchant's user.

salesAgentIds
array of strings

Ids of the merchant's sales agents.

salesAgentIds
businessAddress
object

Business address of the merchant.

mailingAddress
object

Mailing address of the merchant.

string
enum

Status of the merchant (Only for SANDBOX merchant)

boolean

Ready for processing status of the merchant (Only for SANDBOX merchant)

string
enum

Default CNP gateway for the merchant (Only for Prahsys Admin)

Allowed:
string
enum

Pricing rate type for the merchant (Only for Prahsys Admin)

Allowed:
string
enum

Dashboard profile controlling order verbiage/layout (Prahsys Admin only)

Allowed:
boolean | null

Show the Orders sidebar shortcut (null resets to the profile default; admin only).

boolean | null

Show the Order Templates sidebar shortcut (null resets to the profile default; admin only).

boolean | null

Show the Subscriptions sidebar shortcut (null resets to the profile default; admin only).

boolean | null

Show the Payment Plans sidebar shortcut (null resets to the profile default; admin only).

boolean | null

Show the one-time (Invoices) sidebar shortcut (null resets to the profile default; admin only).

string | null
enum

Dashboard home page the merchant lands on (null resets to the profile default; admin only).

Allowed:
availableDashboards
array of strings | null

Dashboard tabs offered, in display order (null resets to the profile default; admin only). An empty array is rejected — use null to clear the override, so 'no tabs' can never be expressed.

availableDashboards
Allowed:
boolean

Whether to include simulated terminals when accessed via sandbox API keys

Responses

Updated 6 months ago

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

Updated 6 months ago

Did this page help you?