v1

latestOpenAPI 3.1.02026-07-24153164.0 KB
merchant-portal-api-controller

Merchant and Terminal Registration

Registers a new merchant along with its first terminal on the TECS Platform. The caller must supply all required merchant details, including the package ID (supplied by TECS) and merchant address information. On success, the response includes a unique package order UUID (packageorderuuid) that must be stored and used for subsequent registrations (such as additional terminals or acquirers). If the merchant username or password are omitted, TECS will generate and return them.

post/merchantportalws/registerNewMerchant

Headers

Authorizationstring required

Authorization credentials (Bearer token or Basic authentication). Example: "Bearer AT-2359-DFYpOWfDFSls4DeKDmGOXDyynx0a8Trwk"

Request body

account_numberinteger

Account number provided by the acquirer.

additional_dataobject

Arbitrary merchant-specific data related to enabling acquiring or terminal registration. This object can contain key-value pairs where the value is a string.

business_reg_numberstring required

Merchant business registration number as stated in the company registry. Typically a 9-character alphanumeric string.

citystring required

Merchant's address: city.

corporateuuidstring

Unique identifier for the corporate entity (UUID format).

countrystring required

Merchant's address: country (must be in 'ISO-3166 ALPHA-3' format).

currencystring required

Transaction currency (must be in "ISO 4217" format).

merchant_category_codeinteger required

Merchant category code as defined by the payment network.

merchant_emailstring email

Merchant's email address for receiving notifications.

merchant_namestring required

The officially incorporated company name of the merchant.

merchant_phone_numberstring

Merchant's phone number for notifications. Must be in international format (e.g., +421910711234).

packageidstring required

Identifier of the package in the TECS processing engine provided by TECS. Typically a UUID.

passwordstring

Merchant password for MPOS. If not provided, TECS will generate a password and return it in the response.

productidstring

Identifier of the product for which terminal registration is being performed.

productid_acquirerstring

Identifier of the product for which acquiring is enabled.

sorting_codeinteger

Sorting code provided by the acquirer.

statestring

Merchant's address: state. May be null if not applicable.

streetstring required

Merchant's address: street and house number.

terminal_country_codestring required

Terminal country code (must be in "ISO-3166 ALPHA-3" format).

terminal_language_codestring required

Terminal language code (must be in "ISO 639-1" format).

terminal_locationstring required

Physical or logical location of the terminal.

terminal_serial_numberstring required

Terminal serial number.

terminalid_acquirerstring

Terminal ID as provided by the acquirer (if applicable).

user_emailstring email

Email address of the user acting on behalf of the merchant.

user_phone_numberstring

Phone number of the user acting on behalf of the merchant. Must be in international format (e.g., +421910711234).

usernamestring

Merchant username for MPOS. If not provided, TECS will generate a username and include it in the response.

vu_nummerstring required

Merchant contract number with the acquirer.

web_shop_urlstring uri

URL of the merchant's web shop.

zipcodestring required

Merchant's address: postal code.

Example request

{
  "account_number": 123456,
  "additional_data": {
    "firstname": "John",
    "surname": "Doe",
    "type": "tx-300",
    "version": "v1.2.3"
  },
  "business_reg_number": "345345345",
  "city": "Bratislava",
  "corporateuuid": "123e4567-e89b-12d3-a456-426614174000",
  "country": "SVK",
  "currency": "EUR",
  "merchant_category_code": 5999,
  "merchant_email": "testemail@tecs.at",
  "merchant_name": "Test merchant",
  "merchant_phone_number": "+421910876567",
  "packageid": "87055654-3158-42fc-9838-74f1fc77f42b",
  "password": "testpassword",
  "productid": "d8af7e4f-a04f-42ea-91ac-bed20c5eebfe",
  "productid_acquirer": "874d84a8-a6f4-47fa-b594-944593fc394b",
  "sorting_code": 123456,
  "state": "null",
  "street": "Palisady 12",
  "terminal_country_code": "SVK",
  "terminal_language_code": "EN",
  "terminal_location": "Palisady 12 BA",
  "terminal_serial_number": "325-320-924",
  "terminalid_acquirer": "66000001",
  "user_email": "testemail12@tecs.at",
  "user_phone_number": "+421910876568",
  "username": "testuser",
  "vu_nummer": "9034520",
  "web_shop_url": "https://www.tecs.at",
  "zipcode": "81106"
}

Response

Successful merchant and terminal registration.