Skip to main content

Create

POST 

/createMerchant/:tenantGuid

Create a merchant for the given tenant.

Request

Path Parameters

    tenantGuid stringrequired

    Identifier of the tenant.

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.

    city string
    country Country (string)

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

    ISO 3166-1 alpha-2 country code.

    defaultCurrency Currency (string)

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

    ISO 4217 three-letter currency code.

    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)[]

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

    Transaction types that are disabled for the merchant.

    externalId string
    homepage urlrequired
    isPciEnabled boolean
    riskAlertEmail emailnullable
    schedulerAlertEmail emailnullable
    technicalEmail emailnullable
    eventNotificationUrl uri

    Possible values: <= 65535 characters

    Merchant event notification URL.

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

    timezone stringrequired
    zipCode string

Responses

The created merchant.

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.

    city string
    country Country (string)

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

    ISO 3166-1 alpha-2 country code.

    createdAt date-time
    defaultCurrency Currency (string)

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

    ISO 4217 three-letter currency code.

    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)[]

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

    Transaction types that are disabled for the merchant.

    externalId string
    homepage urlrequired
    isPciEnabled boolean
    riskAlertEmail emailnullable
    schedulerAlertEmail emailnullable
    technicalEmail emailnullable
    eventNotificationUrl uri

    Possible values: <= 65535 characters

    Merchant event notification URL.

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

    timezone stringrequired
    zipCode string
    property name* any
Loading...