Create
POST/createConnector/:merchantGuid
Create a connector for the given merchant.
A meta-connector can only be either a routingMetaConnector or a multiMethodMetaConnector, not both.
- To create a classic routing meta-connector, add
routingMetaConnectorand the corresponding properties. - To create a multi-method meta-connector, add
multiMethodMetaConnectorand the corresponding properties.
Request
Query Parameters
Identifier of the merchant.
- application/json
Body
required
The connector to create.
Array [
]
Possible values: >= 3 characters
Adapter identifier.
Method identifier.
Connector API key.
Connector public integration key, user for payment.js.
Possible values: <= 50 characters
Connector shared secret.
If left empty the sharedSecret will be generated automatically.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
config
object
Connector configuration.
extraData
object
Configuration values.
To obtain valid configuration values, use the /api/provisioning/getConnectorSettings/:adapterId endpoint.
This endpoint provides the necessary configuration values tailored to the specific adapter.
Configuration values.
To obtain valid configuration values, use the /api/provisioning/getConnectorSettings/:adapterId endpoint.
This endpoint provides the necessary configuration values tailored to the specific adapter.
Possible values: Value must match regular expression ^[a-z]{2}$
ISO 639-1 language code.
Whether the connector is in test mode.
vault
object
Configuration values for vault connectors.
To obtain valid configuration values, use the /api/provisioning/getConnectorSettings/:adapterId/:merchantGuid endpoint.
This endpoint provides the necessary configuration values tailored to the specific adapter and merchant in use.
Configuration values for vault connectors.
To obtain valid configuration values, use the /api/provisioning/getConnectorSettings/:adapterId/:merchantGuid endpoint.
This endpoint provides the necessary configuration values tailored to the specific adapter and merchant in use.
Connector configuration.
Customer profile Container ID.
Possible values: [initial_debit, initial_preauthorize, capture, partial_capture, refund, partial_refund, register, deregister, payout, recurring_debit, recurring_preauthorize]
List of transaction type disabled for this connector.
Possible values: [inherit, json, xml]
Default value: inherit
Provider identifier.
Whether the scheduler is enabled.
Whether the virtual terminal is enabled.
Identifier of risk rule profile for virtual terminal.
settings
object
Set connector alias for global routing.
terminals
object[]
Unique terminal identifier.
Set current STAN.
Set current capture reference.
routingMetaConnector
object
On create/update add this to create a classic routing meta-connector (adapter and method must be set to MetaConnector).
Identifier of the default connector to route to.
Whether to re-route recurring transactions to the original connector.
multiMethodMetaConnector
object
On create/update add this to create a multi-method meta-connector (adapter and method must be set to MetaConnector).
If no action is configured (rules), the default action is to disable the connector.
Possible values: <= 9
How many retries should be allowed if possible.
Expiry time in hours.
Responses
- 200
- 401
- 422
- 500
The created connector.
- application/json
- Schema
- Example (from schema)
- Example
Schema
Array [
]
Whether the request was successful or not.
connector
object
Identifier.
Possible values: >= 3 characters
Adapter identifier.
Method identifier.
Connector API key.
Connector public integration key, user for payment.js.
Possible values: <= 50 characters
Connector shared secret.
If left empty the sharedSecret will be generated automatically.
Possible values: Value must match regular expression ^[A-Z]{2}$
ISO 3166-1 alpha-2 country code.
config
object
Connector configuration.
extraData
object
Configuration values.
To obtain valid configuration values, use the /api/provisioning/getConnectorSettings/:adapterId endpoint.
This endpoint provides the necessary configuration values tailored to the specific adapter.
Configuration values.
To obtain valid configuration values, use the /api/provisioning/getConnectorSettings/:adapterId endpoint.
This endpoint provides the necessary configuration values tailored to the specific adapter.
Possible values: Value must match regular expression ^[a-z]{2}$
ISO 639-1 language code.
Whether the connector is in test mode.
vault
object
Configuration values for vault connectors.
To obtain valid configuration values, use the /api/provisioning/getConnectorSettings/:adapterId/:merchantGuid endpoint.
This endpoint provides the necessary configuration values tailored to the specific adapter and merchant in use.
Configuration values for vault connectors.
To obtain valid configuration values, use the /api/provisioning/getConnectorSettings/:adapterId/:merchantGuid endpoint.
This endpoint provides the necessary configuration values tailored to the specific adapter and merchant in use.
Connector configuration.
Customer profile Container ID.
Possible values: [initial_debit, initial_preauthorize, capture, partial_capture, refund, partial_refund, register, deregister, payout, recurring_debit, recurring_preauthorize]
List of transaction type disabled for this connector.
Merchant identifier.
Whether the connector is a meta-connector.
Possible values: [inherit, json, xml]
Default value: inherit
Provider identifier.
Whether the scheduler is enabled.
Whether the virtual terminal is enabled.
Identifier of risk rule profile for virtual terminal.
settings
object
Set connector alias for global routing.
terminals
object[]
Unique terminal identifier.
routingMetaConnector
object
On create/update add this to create a classic routing meta-connector (adapter and method must be set to MetaConnector).
Identifier of the default connector to route to.
Whether to re-route recurring transactions to the original connector.
multiMethodMetaConnector
object
On create/update add this to create a multi-method meta-connector (adapter and method must be set to MetaConnector).
If no action is configured (rules), the default action is to disable the connector.
Possible values: <= 9
How many retries should be allowed if possible.
Expiry time in hours.
{
"success": true,
"connector": {
"guid": "CO-1234-1234-1234-1234-1234-1234",
"name": "SimulatorConnector A",
"adapter": "Simulator",
"method": "Credit Card",
"apiKey": "sim-connector-a",
"publicIntegrationKey": "4nhDxztY3bBeozkyd7Zs",
"sharedSecret": "OsEPpNrSr8hxYR3BO0F73YXMvMdDsM",
"archived": true,
"businessCountry": "AT",
"config": {
"username": "asmith",
"password": "supersecure1",
"apiSecret": "ljkllLkklmKLlk3",
"extraData": null,
"language": "de",
"testMode": true,
"vault": {}
},
"createdAt": "2001-02-03T04:05:06+02:00",
"customerProfileContainer": 0,
"defaultRiskRuleSet": 0,
"description": "string",
"disabled": false,
"disabledTransactionTypes": [
"initial_debit"
],
"merchantGuid": "ME-1234-1234-1234-1234-1234-1234",
"isMetaConnector": false,
"postbackFormat": "inherit",
"provider": "string",
"scheduleApiAvailable": true,
"virtualTerminalAvailable": true,
"vtRiskRuleSet": 0,
"settings": {
"tx:expiration-minutes": "900",
"refund:ui-enabled": "1"
},
"alias": "string",
"terminals": [
{
"terminalId": "string",
"disabled": true
}
],
"routingMetaConnector": {
"defaultConnector": "string",
"reRouteRecurring": false
},
"multiMethodMetaConnector": {
"defaultActionDisableConnector": true,
"retries": 0,
"expiry": 0
}
}
}
{
"success": true,
"connector": {
"guid": "CO-4321-4321-4321-4321-4321-4321",
"name": "SimulatorConnector B",
"Adapter": "Simulator",
"method": "Creditcard",
"apiKey": "sim-Connector-b",
"publicIntegrationKey": "XTcSyLgJ04b7cHkvKScG",
"sharedSecret": "V0WkgQPsHAUH4iXCsqWGYDeFKc4O6G",
"archived": false,
"businessCountry": "DE",
"config": {
"username": "uname",
"password": "pw",
"apiSecret": "sikret",
"extraData": {
"setting": "test"
},
"language": "de",
"testMode": false
},
"createdAt": "2020-12-16T09:57:14+00:00",
"customerProfileContainer": 8,
"defaultRiskRuleSet": 213,
"description": "My test Connector",
"disabled": false,
"disabledTransactionTypes": [
"payout",
"register"
],
"merchantGuid": "ME-1234-1234-1234-1234-1234-1234",
"isMetaConnector": false,
"PostbackFormat": "inherit",
"provider": "PR-1234-1234-1234-1234-1234",
"alias": "default",
"ScheduleApiAvailable": true,
"virtualTerminalAvailable": true,
"vtRiskRuleSet": null,
"terminals": [
{
"terminalId": "ID-0001",
"disabled": false
}
],
"settings": {
"tx:expiration-minutes": 900,
"refund:ui-enabled": 1
}
}
}
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"
}
{
"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"
}
{
"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"
}
{
"success": false,
"errorCode": 9999,
"errorMessage": "Internal server error"
}