Update Merchant

patch

https://api.preczn.com/v1/merchants/{merchantId}

Use the Preczn MerchantID to update the merchant's business information.
To Update Owners, Update Bank Accounts, or Update Connection Details, utilize their respective endpoints IDs.

Path Params

merchantId

string

required

Merchant ID

Body Params

active

boolean

Defaults to true

Whether merchant is active or inactive in Preczn. Inactive merchants cannot perform transactions

plan

string

Plan ID

labels

array of strings

The labels array enables multiple labels to be added to a merchant record for enhanced categorization and filtering in the vault. Each label must be capital alphanumeric characters and spaces only. Note that any addition or removal of labels in the array requires all desired labels to be included in the request. Please be cautious when modifying merchants with existing labels; ensure that you include any existing labels you wish to keep along with any new labels in the array.

labels

name

string

length between 1 and 255

Merchant name (e.g. DBA). Up to 255 characters; content is otherwise unrestricted today (reserved for future tightening).

legalName

string

length ≤ 255

Merchant registered business name. Up to 255 characters; content is otherwise unrestricted today (reserved for future tightening).

address

object

Merchant physical address.

string

Merchant email address.

phone

string

^1?\d{10}$

Merchant phone number. Format: North American phone digits only, optionally prefixed with '1'. No spaces, parentheses, or hyphens. Example: 19991210123.

annualFinanceVolume

integer

≥ 0

The amount a merchant finances in a year.

tin

string

length between 9 and 15

^[a-zA-Z0-9]*$

Tax identification number. 9 to 15 alphanumeric characters only.

tinType

string

enum

Identification number type, value must be either ssn, ein, bn, or sin.

Allowed:

website

uri

URL to merchant's website.

mailingAddress

object

Mailing address.

billingContact

object

Billing address.

businessType

string

enum

Business type.

Allowed:

publicCompany

boolean

Defaults to true

Publically traded company flag.

isBusinessAddress

boolean

Flag indicating whether the merchant address is a business address.

stateIncorporated

string

State in which business was incorporated.

countryIncorporated

string

enum

Country in which business was incorporated.

dateEstablished

string

Date which merchant business was established.

customerServicePhone

string

^1?\d{10}$

Merchant business customer service phone number. Format: North American phone digits only, optionally prefixed with '1'. No spaces, parentheses, or hyphens. Example: 19991210123.

productServiceDescription

string

Description of merchant's products or services provided.

mcc

string

Merchant category code.

annualSaleVolume

integer

≥ 0

The total sales volume for the year, represented as a whole number without decimals. For example, an annual sales volume of $100,000.50 should be entered as 10000050. This field is intended to avoid decimal representation by scaling the actual dollar amount to a whole number (i.e., multiplying the dollar amount by 100).

averageTicket

integer

≥ 0

The average sales ticket dollar amount, represented as a whole number without decimals. For example, an amount of $13.50 should be entered as 1350. This field is intended to avoid decimal representation by scaling the actual dollar amount to a whole number (i.e., multiplying the dollar amount by 100).

highTicket

integer

≥ 0

The highest sales ticket dollar amount collected by the merchant, represented as a whole number without decimals. For example, an amount of $2,500.75 should be entered as 250075. This field is intended to avoid decimal representation by scaling the actual dollar amount to a whole number (i.e., multiplying the dollar amount by 100).

shipToDays

number

0 to 30

Number of days required to ship sold items.

externalId

string

length ≤ 50

A unique identifier used to reference the merchant in your external system. This value must be unique across the same mode (test or live).

saasData

object

Vertical SaaS platform data for this merchant, including start date and billing configuration.

transactionVolumeSnapshot

object

Snapshot of the merchant transaction volume, including date and aggregated payment method totals.

walletSettings

object

Digital wallet payment settings for this merchant. Configure Google Pay and Apple Pay payment methods.

primaryLocationId

string | null

Id of this merchant's primary location. Send null to clear it, which makes the merchant itself the primary site. Must name an existing location of this merchant.

Headers

idempotency-key

string

Unique key to ensure idempotency of requests. If provided, the server will return the same response for subsequent requests with the same key.

Responses

Update Merchant

What’s Next

What’s Next

200Merchant Updated.

400The request body failed validation. message lists one entry per rule that was broken, naming the offending field. The example shows a phone number sent with formatting characters, which the phone format rule rejects.

401Invalid API key.

403Resource Forbidden.

404Merchant not found.

500Unable to service request due to server-side error. Please reattempt request.

What’s Next

What’s Next