Create

POST 
/createMerchant/:tenantGuid

Create a merchant for the given tenant.

Request

Path Parameters

tenantGuid stringrequired

Identifier of the tenant.

application/json

Body

required

The merchant to create.

name stringrequired

Possible values: >= 3 characters

address string
administrativeEmail string

Administrative email.

archived boolean
Whether the merchant is archived.
Example: false
city string
country Country (string)
ISO 3166-1 alpha-2 country code.
Possible values: Value must match regular expression ^[A-Z]{2}$
Example: AT
defaultCurrency Currency (string)
ISO 4217 three-letter currency code.
Possible values: Value must match regular expression ^[A-Z]{3}$
Example: EUR
defaultRiskRuleSet int64

ID of merchant's default risk rule set.

defaultVtRiskRuleSet int64

ID of merchant's default virtual terminal risk rule set.

disabled boolean

Whether the merchant is disabled.

disabledTransactionTypes TransactionType (string)[]

Transaction types that are disabled for the merchant.

Possible values: [initial_debit, initial_preauthorize, capture, partial_capture, refund, partial_refund, register, deregister, payout, recurring_debit, recurring_preauthorize]

externalId string
homepage urlrequired
isPciEnabled boolean
riskAlertEmail emailnullable
schedulerAlertEmail emailnullable
technicalEmail emailnullable
eventNotificationUrl uri
Merchant event notification URL.
Callback URL where a merchant will be notified about network token and account updater changes where no connector is available.
Possible values: <= 65535 characters
Example: https://api.example.org/event-notification
timezone stringrequired
zipCode string

Responses

200

The created merchant.

application/json

Schema

Schema

success booleanrequired

Whether the request was successful or not.

merchant

object

Additional fields might be mandatory depending on tenant settings.

guid stringrequired

Identifier.

name stringrequired

Possible values: >= 3 characters

address string

administrativeEmail string

Administrative email.

archived boolean

Whether the merchant is archived.

Example: false

city string

country Country (string)

ISO 3166-1 alpha-2 country code.

Possible values: Value must match regular expression ^[A-Z]{2}$

Example: AT

createdAt date-time

Example: 2001-02-03T04:05:06+02:00

defaultCurrency Currency (string)

ISO 4217 three-letter currency code.

Possible values: Value must match regular expression ^[A-Z]{3}$

Example: EUR

defaultRiskRuleSet int64

ID of merchant's default risk rule set.

defaultVtRiskRuleSet int64

ID of merchant's default virtual terminal risk rule set.

disabled boolean

Whether the merchant is disabled.

disabledTransactionTypes TransactionType (string)[]

Transaction types that are disabled for the merchant.

Possible values: [initial_debit, initial_preauthorize, capture, partial_capture, refund, partial_refund, register, deregister, payout, recurring_debit, recurring_preauthorize]

externalId string

homepage urlrequired

isPciEnabled boolean

riskAlertEmail emailnullable

schedulerAlertEmail emailnullable

technicalEmail emailnullable

eventNotificationUrl uri

Merchant event notification URL.

Callback URL where a merchant will be notified about network token and account updater changes where no connector is available.

Possible values: <= 65535 characters

Example: https://api.example.org/event-notification

timezone stringrequired

zipCode string
property name* any

Example (from schema)

{
  "success": true,
  "merchant": {
    "guid": "ME-1234-1234-1234-1234-1234-1234",
    "name": "Merchant A",
    "address": "Straße 1",
    "administrativeEmail": "[email protected]",
    "archived": false,
    "city": "Vienna",
    "country": "AT",
    "createdAt": "2020-12-18T13:53:07+00:00",
    "defaultCurrency": "EUR",
    "defaultRiskRuleSet": null,
    "defaultVtRiskRuleSet": null,
    "disabled": false,
    "disabledTransactionTypes": [
      "payout",
      "register"
    ],
    "externalId": "Id-0001",
    "homepage": "https://www.example.org",
    "isPciEnabled": false,
    "riskAlertEmail": "[email protected]",
    "schedulerAlertEmail": "[email protected]",
    "technicalEmail": "[email protected]",
    "eventNotificationUrl": "https://api.example.org/event-notification",
    "timezone": "UTC",
    "zipCode": "1180"
  }
}

401

Unauthorized, see authentication.

application/json

Schema

Schema

success booleanrequired

true if successful.

errorCode int64required
Error code.
• 1000 - Unauthorized, e.g. invalid credentials
• 1001 - The request is invalid
• 1002 - The value does not comply to the requirements, e.g. pre-defined values
• 1003 - The format is invalid
• 1004 - The value contains invalid characters
• 1005 - Mandatory parameters are missing
• 1006 - Some parameters are not applicable in given request scenario
• 1007 - The provided entity does not exist
• 9999 - Internal system error
Example: 1004
errorMessage stringrequired
Human readable error message.
:::info While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage. :::
Example: name: nameInvalid characters
property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 1004,
  "errorMessage": "name: nameInvalid characters"
}

1000

Unauthorized (1000)

{
  "success": false,
  "errorCode": 1000,
  "errorMessage": "Unauthorized"
}

422

Unprocessable entity.

application/json

Schema

Schema

success booleanrequired

true if successful.

errorCode int64required
Error code.
• 1000 - Unauthorized, e.g. invalid credentials
• 1001 - The request is invalid
• 1002 - The value does not comply to the requirements, e.g. pre-defined values
• 1003 - The format is invalid
• 1004 - The value contains invalid characters
• 1005 - Mandatory parameters are missing
• 1006 - Some parameters are not applicable in given request scenario
• 1007 - The provided entity does not exist
• 9999 - Internal system error
Example: 1004
errorMessage stringrequired
Human readable error message.
:::info While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage. :::
Example: name: nameInvalid characters
property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 1004,
  "errorMessage": "name: nameInvalid characters"
}

1001

Unprocessable entity (1001)

{
  "success": false,
  "errorCode": 1001,
  "errorMessage": "Unauthorized"
}

500

Internal server error.

application/json

Schema

Schema

success booleanrequired

true if successful.

errorCode int64required
Error code.
• 1000 - Unauthorized, e.g. invalid credentials
• 1001 - The request is invalid
• 1002 - The value does not comply to the requirements, e.g. pre-defined values
• 1003 - The format is invalid
• 1004 - The value contains invalid characters
• 1005 - Mandatory parameters are missing
• 1006 - Some parameters are not applicable in given request scenario
• 1007 - The provided entity does not exist
• 9999 - Internal system error
Example: 1004
errorMessage stringrequired
Human readable error message.
:::info While the errorMessage field provides useful context for understanding the nature of the error, it's important to note that the content of this message can vary based on specific circumstances. For consistent and reliable error handling in your application, always base your logic on the errorCode field, not the errorMessage. :::
Example: name: nameInvalid characters
property name* any

Example (from schema)

{
  "success": true,
  "errorCode": 1004,
  "errorMessage": "name: nameInvalid characters"
}

1001

Internal server error (9999)

{
  "success": false,
  "errorCode": 9999,
  "errorMessage": "Internal server error"
}

Loading...