---
title: "Merchants:Create"
method: POST
path: "/merchants"
tags: ["Merchants"]
---

# Merchants:Create

`POST /merchants`

Register a merchant so that the merchant is able to use Pay. to process payments

## Request body

- object
  - `partner` object
    - `connectionType` 'BP' | 'ALLIANCE' | 'ISO' | 'FI' | 'SP' | 'CPSP' — Indicate which type of partner agreement you have with us
    - `referralProfileCode` string, required — Indicate under which package you want to create a merchant. You can retrieve a list of available package by calling Packages API endpoint (see: https://developer.pay.nl/reference/get_packages )
    - `accessToMerchant` boolean, nullable — Indicate if you want to have access to the merchant. Only applicable for connectionType BP and ISO. An alliance always have access to their submerchants
  - `merchant` object, required
    - `name` Name, required — unresolved $ref
    - `publicName` PublicName — unresolved $ref
    - `coc` Coc, required — unresolved $ref
    - `establishmentLegalRegistrationNumber` string — The legal registration number of the establishment/location of the merchant. If omitted and the country code is FR, this defaults to the CoC number.
    - `vat` Vat — unresolved $ref
    - `companyTypeId` CompanyTypeId, required — unresolved $ref
    - `countryCode` CountryCode, required — unresolved $ref
    - `contractLanguage` ContractLanguage, required — unresolved $ref
    - `contactPhone` string, phone — The primary contact phone number of the merchant.
    - `contactEmail` string, email — The primary contact email address of the merchant.
    - `website` string, uri — The website.
    - `clearingAccounts` object[]
      - `method` string
      - `iban` object
        - `iban` string
        - `bic` string
        - `owner` string
    - `visitAddress` object, required
      - `streetName` StreetName, required — unresolved $ref
      - `streetNumber` StreetNumber, required — unresolved $ref
      - `zipCode` ZipCode, required — unresolved $ref
      - `city` City, required — unresolved $ref
      - `countryCode` CountryCode — unresolved $ref
    - `authenticationTokens` object[]
      - `description` string, required
      - `authorisation` 'all' | 'specified', required — Specify which kind of authorisation is applicable for the token. all: all merchant rights specified: specify which authorisation groups should be enabled from the token. At least one authorisation group (in the authorisationGroups array) is mandatory
      - `authorisationGroups` string[]
      - `ipFilter` object
        - `type` 'DENY_FROM_ALL'
        - `exceptionList` string[]
    - `persons` object[], required
      - `gender` 'M' | 'F'
      - `firstName` FirstName, required — unresolved $ref
      - `lastName` LastName, required — unresolved $ref
      - `name` Name — unresolved $ref
      - `email` Email — unresolved $ref
      - `language` string
      - `phone` Phone — unresolved $ref
      - `newsletter` boolean
      - `visitAddress` object
        - `streetName` StreetName, required — unresolved $ref
        - `streetNumber` StreetNumber, required — unresolved $ref
        - `zipCode` ZipCode, required — unresolved $ref
        - `city` City, required — unresolved $ref
        - `countryCode` CountryCode — unresolved $ref
      - `notificationGroup` object
        - `technical` boolean
        - `financial` boolean
        - `operations` boolean
      - `complianceData` object
        - `dateOfBirth` DateOfBirth — unresolved $ref
        - `nationality` Nationality — unresolved $ref
        - `authorizedToSign` AuthorizedToSign — unresolved $ref
        - `pep` Pep — unresolved $ref
        - `pepDescription` PepDescription — unresolved $ref
        - `ubo` Ubo — unresolved $ref
        - `uboPercentage` UboPercentage — unresolved $ref
        - `relationshipDescription` RelationshipDescription — unresolved $ref
      - `roles` object
        - `primaryContactPerson` boolean
        - `internalAdministrator` boolean
      - `platform` object, required
        - `loginAccount` boolean
        - `loginTpa` boolean
        - `authorisation` 'all' | 'specified', required
        - `authorisationGroups` string[]
    - `service` Service — unresolved $ref
    - `usages` object — Indicates how the merchant intends to use Pay.
      - `onlineProductsOrServices` boolean
      - `mobilePinTerminal` boolean
      - `paymentRequests` boolean
      - `physicalStore` boolean
      - `acceptCreditCards` boolean
    - `amountOfTransactions` 1 | 2 | 3 | 4 | 5 — Expected number of transactions. 1 = up to 10,000, 2 = up to 50,000, 3 = up to 500,000, 4 = up to 1,000,000, 5 = more than 1,000,000.

## Response `201`

Ok.

- object — Basic Merchant
  - `merchant` object
    - `code` Code — unresolved $ref
    - `status` Status — unresolved $ref
    - `name` Name — unresolved $ref
    - `publicName` PublicName — unresolved $ref
    - `clearingAccounts` ClearingAccounts — unresolved $ref
    - `postalAddress` PostalAddress — unresolved $ref
    - `visitAddress` VisitAddress — unresolved $ref
    - `contactMethods` ContactMethods — unresolved $ref
    - `authenticationTokens` object[]
      - `code` string
      - `secret` string
      - `name` string
    - `trademarks` object[]
      - `code` Code — unresolved $ref
      - `type` Type — unresolved $ref
      - `name` Name — unresolved $ref
      - `status` Status — unresolved $ref
    - `licenses` object[]
      - `code` Code — unresolved $ref
      - `name` Name — unresolved $ref
      - `language` Language — unresolved $ref
    - `service` object
      - `code` Id — unresolved $ref
      - `secret` Secret — unresolved $ref
      - `name` Name — unresolved $ref
      - `description` Description — unresolved $ref
      - `categoryCode` string — The category (code) identifier
      - `integrationCode` string
      - `publication` string
    - `createdAt` CreatedAt — unresolved $ref
    - `createdBy` CreatedBy — unresolved $ref
    - `modifiedAt` ModifiedAt — unresolved $ref
    - `modifiedBy` ModifiedBy — unresolved $ref
    - `deletedAt` DeletedAt — unresolved $ref
    - `deletedBy` DeletedBy — unresolved $ref

## Other responses

- `400` — Bad request, see response body for more information
- `401` — Unauthorized. Supplied credentials are invalid
- `403` — Forbidden. Supplied credentials have no rights
- `405` — Used HTTP method is not allowed
- `406` — Not acceptable. The supplied content type in the accept parameter in the header is not supported
- `415` — Unsupported media. The supplied content type in the content-type parameter in the header is not supported
- `422` — Unprocessable Entity, see response body for more information
- `429` — Rate limit reached.
- `500` — An internal error occurred

---

[API](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api.md) · [All operations](https://skmtc.net/pay/apis/pay-transaction-gateway-unit-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pay/pay-transaction-gateway-unit-api/revisions/2bc260c7bdfc/schema)
