API Reference

Create a Merchant

post
https://api.sandbox.eu.ppro.com/v1/merchants
Body Params
string
required
^[A-Z0-9]{1,32}$

Unique reference, assigned by external client. Note that the same reference cannot be used for both a Merchant and a Platform.

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

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

string
enum
required

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

Allowed:
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.

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

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

date

The date the business was legally registered or incorporated.

address
object
required
string
^[\+]?[0-9\s\-\(\)]{7,20}$
people
array of objects
people
uri
length ≤ 255

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

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

Connect the merchant to a platform.

string
^([a-zA-Z0-9]{3,41}|psp_[a-zA-Z0-9-]{21})$

Connect the merchant to a PSP. Only for PSP customers.

uri
required
length ≤ 255

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

string
required
^[0-9]{4}$

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

number

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

int64

The expected or historical number of transactions processed per month.

string
^[A-Z]{3}$

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

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

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

Responses

Updated 3 months ago

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

Updated 3 months ago

Did this page help you?