v1

latestOpenAPI 3.0.0Forter License2026-07-1333204516.7 KB
Merchants

Merchant

Create a new merchant within your Forter account. The response will include a Forter-assigned merchant subsite ID to be included in the API header on future requests.

post/merchants

Headers

api-versionstring required
Example:10.1

Specify the version of the API to target.

x-forter-siteidstring required
Example:a1b2c3d4e5f6

Forter-assigned ID for your account. Note that your Site ID for your test site is different from your production site.

Authorizationstring required
Example:Basic <base64-encoded-api-key:>

Basic Authentiation in the form of a username and password. Use the API Key as the username and leave the password empty.

Request body

defaultMerchantCategoryCodestring required

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides

merchantIdstring required

The merchant's internal ID in the PSP's systems

namestring required

The merchant's name in the PSP's systems. The name needs to be unique within the PSP's portfolio, and can include only letters (A-Z, a-z), numbers (0-9), spaces, and the following special characters: . _ & , ^ -.

Example request

{
  "defaultMerchantCategoryCode": "5655",
  "merchantAccountCreation": {
    "ip": "10.0.0.128",
    "timestamp": 1415273179
  },
  "merchantId": "eh629dK9",
  "name": "T-Shirts Express"
}

Response

Example merchantCreationResponse

defaultMerchantCategoryCodestring required

A Merchant Category Code (MCC) is a four-digit number listed in ISO 18245 for retail financial services. MCC is used to classify the business by the type of goods or services it provides

idstring required

The merchant's Site-ID in Forter's systems. Should be used for each call related to the merchant

merchantIdstring required

The merchant's internal ID in the PSP's systems

namestring required

The merchant's Site Name

Example response

{
  "defaultMerchantCategoryCode": "5655",
  "id": "aab42345bba2",
  "merchantAccountCreation": {
    "ip": "10.0.0.128",
    "timestamp": 1415273179
  },
  "merchantId": "eh629dK9",
  "name": "T-Shirts Express"
}