Sign in

v1

latestOpenAPI 3.1.02026-07-2663312285.4 KB
Merchants

Create a Merchant

post/v1/merchants

Request body

externalMerchantReferencestring required

Unique reference, assigned by external client.

legalEntityNamestring required

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

legalEntityType'COMPANY' | 'PARTNERSHIP' | 'SOLE_TRADER' | 'INDIVIDUAL' | 'NON_PROFIT' required

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

tradeNamestring

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.

registrationNumberstring

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

incorporationDatestring date

The date the business was legally registered or incorporated.

phoneNumberstring
simpleApiWebhooksUrlstring uri

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

platformIdstring

Unique identifier for the platform

pspIdstring

Unique identifier for the PSP

urlstring uri required

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

mccstring required

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

averageTransactionValuenumber

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

monthlyTransactionCountinteger

The expected or historical number of transactions processed per month.

currencystring

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

paymentDescriptorstring

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

Example request

{
  "externalMerchantReference": "ENTITY1234567890",
  "legalEntityName": "Example LLC",
  "legalEntityType": "COMPANY",
  "tradeName": "Example LLC",
  "incorporationDate": "2020-01-01",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "region": "CA",
    "postalCode": "12345",
    "country": "US"
  },
  "phoneNumber": "+1 234-567-8900",
  "people": [
    {
      "relationshipType": "ULTIMATE_BENEFICIAL_OWNER",
      "person": {
        "externalPersonReference": "REF123",
        "firstName": "John",
        "lastName": "Doe",
        "middleName": "Michael",
        "nativeName": "道",
        "birthDate": "2000-01-01",
        "address": {
          "street": "123 Main St",
          "city": "Anytown",
          "region": "CA",
          "postalCode": "12345",
          "country": "US"
        },
        "email": "john.doe@example.com"
      }
    }
  ],
  "simpleApiWebhooksUrl": "https://www.example.com/webhook",
  "platformId": "PLATFORMID123456",
  "pspId": "psp_abcdefghijklmno123456",
  "url": "https://www.example.com",
  "mcc": "5411",
  "averageTransactionValue": 50,
  "monthlyTransactionCount": 1000,
  "currency": "EUR",
  "paymentDescriptor": "Example LLC Store"
}

Response

Merchant created successfully

idstring required

Unique identifier for the merchant

pspIdstring

Unique identifier for the PSP

externalMerchantReferencestring required

Unique reference, assigned by external client.

legalEntityNamestring required

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

legalEntityType'COMPANY' | 'PARTNERSHIP' | 'SOLE_TRADER' | 'INDIVIDUAL' | 'NON_PROFIT' required

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

tradeNamestring

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.

registrationNumberstring

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

incorporationDatestring date

The date the business was legally registered or incorporated.

phoneNumberstring
emailstring email

An email address.

simpleApiWebhooksUrlstring uri

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

platformIdstring

Unique identifier for the platform

createdAtstring date-time required

Timestamp when the resource was created. UTC timezone. Format YYYY-MM-DDTHH:MM:SS.ssssssZ

updatedAtstring date-time required

Timestamp when the resource was last updated. UTC timezone. Format YYYY-MM-DDTHH:MM:SS.ssssssZ

urlstring uri required

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

mccstring required

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

averageTransactionValuenumber

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

monthlyTransactionCountinteger

The expected or historical number of transactions processed per month.

currencystring

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

paymentDescriptorstring

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

Example response

{
  "id": "MERCHANTID456",
  "pspId": "psp_abcdefghijklmno123456",
  "externalMerchantReference": "ENTITY1234567890",
  "legalEntityName": "Example LLC",
  "legalEntityType": "COMPANY",
  "tradeName": "Example LLC",
  "incorporationDate": "2020-01-01",
  "address": {
    "street": "123 Main St",
    "city": "Anytown",
    "region": "CA",
    "postalCode": "12345",
    "country": "US"
  },
  "phoneNumber": "+1 234-567-8900",
  "email": "john.doe@example.com",
  "simpleApiWebhooksUrl": "https://www.example.com/webhook",
  "platformId": "PLATFORMID123456",
  "url": "https://www.example.com",
  "mcc": "5411",
  "averageTransactionValue": 50,
  "monthlyTransactionCount": 1000,
  "currency": "EUR",
  "paymentDescriptor": "Example LLC Store",
  "people": [
    {
      "relationshipType": "ULTIMATE_BENEFICIAL_OWNER",
      "person": {
        "id": "person_abcdefghijklmno123456",
        "externalPersonReference": "REF123",
        "firstName": "John",
        "lastName": "Doe",
        "address": {
          "street": "123 Main St",
          "city": "Anytown",
          "region": "CA",
          "postalCode": "12345",
          "country": "US"
        },
        "birthDate": "2000-01-01",
        "email": "john.doe@ppro.com",
        "createdAt": "2023-01-01T00:00:00Z",
        "updatedAt": "2023-01-01T00:00:00Z"
      }
    }
  ]
}