Replace a Merchant

put

https://api.sandbox.eu.ppro.com/v1/merchants/{merchant-id}

Path Params

merchant-id

string

required

^([A-Z0-9]{5,32}|merchant_[a-zA-Z0-9-]{21})$

Unique identifier for the merchant

Body Params

legalEntityName

string

required

^(?=.{1,255}$).*\S.*

The officially registered name of the business as recorded in legal or governmental registries.

legalEntityType

string

enum

required

Classification of the business structure. Allowed values: COMPANY, PARTNERSHIP, SOLE_TRADER, INDIVIDUAL, NON_PROFIT.

Allowed:

tradeName

string

^(?=.{1,255}$).*\S.*

The name the business operates under in public-facing contexts. This is the "doing business as" (DBA) name and may differ from the legal name.

registrationNumber

string

^[A-Za-z0-9]{1,255}$

A unique identifier assigned to the business upon incorporation by a government or regulatory authority.

incorporationDate

date

The date the business was legally registered or incorporated.

address

object

required

phoneNumber

string

^[\+]?[0-9\s\-]{7,20}$

simpleApiWebhooksUrl

uri

length ≤ 255

The endpoint where Simple API (v1) event webhooks should be sent.

platformId

string

^([A-Z0-9]{5,32}|platform_[a-zA-Z0-9-]{21})$

Unique identifier for the platform

url

uri

required

length ≤ 255

An e-commerce website or public-facing digital storefront.

mcc

string

required

^[0-9]{4}$

Merchant Category Code assigned to the business, indicating the type of goods or services sold.

averageTransactionValue

number

The typical value of a single transaction. Major units, example 50.00

monthlyTransactionCount

int64

The expected or historical number of transactions processed per month.

currency

string

^[A-Z]{3}$

ISO-4217 currency code (e.g., EUR, USD)

paymentDescriptor

string

^[A-Za-z0-9.',& /+\-]{0,255}$

The text customers see on their bank statement for transactions from this store.

Responses

200Merchant replaced successfully

400Bad Request

403Forbidden

404Resource not found

405Method not allowed

409Resource conflict

429Too many requests

500Internal Server Error

504Gateway Timeout