Update
POST/updateMerchant/:merchantGuid
Update the given merchant.
Request
Path Parameters
Identifier of the merchant.
- application/json
Body
required
Fields of a merchant to update, omit fields that should remain the same.
Possible values: >= 3 characters
Administrative email.
Whether the merchant is archived.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
ID of merchant's default risk rule set.
ID of merchant's default virtual terminal risk rule set.
Whether the merchant is disabled.
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.
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.
Responses
- 200
- 401
- 422
- 500
The updated merchant.
- application/json
- Schema
- Example (from schema)
Schema
Whether the request was successful or not.
merchant
object
Additional fields might be mandatory depending on tenant settings.
Identifier.
Possible values: >= 3 characters
Administrative email.
Whether the merchant is archived.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
Possible values: Value must match regular expression ^[A-Z]{3}$
ISO 4217 three-letter currency code.
ID of merchant's default risk rule set.
ID of merchant's default virtual terminal risk rule set.
Whether the merchant is disabled.
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.
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.
{
"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"
}
}
Unauthorized, see authentication.
- application/json
- Schema
- Example (from schema)
- 1000
Schema
1000- Unauthorized, e.g. invalid credentials1001- The request is invalid1002- The value does not comply to the requirements, e.g. pre-defined values1003- The format is invalid1004- The value contains invalid characters1005- Mandatory parameters are missing1006- Some parameters are not applicable in given request scenario1007- The provided entity does not exist9999- Internal system error
true if successful.
Error code.
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.
:::
{
"success": true,
"errorCode": 1004,
"errorMessage": "name: nameInvalid characters"
}
Unauthorized (1000)
{
"success": false,
"errorCode": 1000,
"errorMessage": "Unauthorized"
}
Unprocessable entity.
- application/json
- Schema
- Example (from schema)
- 1001
Schema
1000- Unauthorized, e.g. invalid credentials1001- The request is invalid1002- The value does not comply to the requirements, e.g. pre-defined values1003- The format is invalid1004- The value contains invalid characters1005- Mandatory parameters are missing1006- Some parameters are not applicable in given request scenario1007- The provided entity does not exist9999- Internal system error
true if successful.
Error code.
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.
:::
{
"success": true,
"errorCode": 1004,
"errorMessage": "name: nameInvalid characters"
}
Unprocessable entity (1001)
{
"success": false,
"errorCode": 1001,
"errorMessage": "Unauthorized"
}
Internal server error.
- application/json
- Schema
- Example (from schema)
- 1001
Schema
1000- Unauthorized, e.g. invalid credentials1001- The request is invalid1002- The value does not comply to the requirements, e.g. pre-defined values1003- The format is invalid1004- The value contains invalid characters1005- Mandatory parameters are missing1006- Some parameters are not applicable in given request scenario1007- The provided entity does not exist9999- Internal system error
true if successful.
Error code.
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.
:::
{
"success": true,
"errorCode": 1004,
"errorMessage": "name: nameInvalid characters"
}
Internal server error (9999)
{
"success": false,
"errorCode": 9999,
"errorMessage": "Internal server error"
}