List

GET 
/listConnectors/:merchantGuid

Returns the connectors of the given merchant.

Request

Path Parameters

merchantGuid stringrequired

Identifier of the merchant.

Responses

200

The connectors of the given tenant.

application/json

Schema

Schema

success booleanrequired

Whether the request was successful or not.

connectors

object[]

List of connectors of a merchant.

Array [

guid string

Identifier.

Example: CO-1234-1234-1234-1234-1234-1234

name stringrequired

Possible values: >= 3 characters

Example: SimulatorConnector A

adapter stringrequired

Adapter identifier.

Example: Simulator

method stringrequired

Method identifier.

Example: Credit Card

apiKey stringrequired

Connector API key.

Example: sim-connector-a

publicIntegrationKey string

Connector public integration key, user for payment.js.

Example: 4nhDxztY3bBeozkyd7Zs

sharedSecret string

Connector shared secret.

If left empty the sharedSecret will be generated automatically.

Possible values: <= 50 characters

Example: OsEPpNrSr8hxYR3BO0F73YXMvMdDsM

archived boolean

businessCountry Country (string)

ISO 3166-1 alpha-2 country code.

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

Example: AT

config

object

Connector configuration.

username string

Example: asmith

password string

Example: supersecure1

apiSecret string

Example: ljkllLkklmKLlk3

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.

property name* any

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.

Example: null

language Language (string)

ISO 639-1 language code.

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

Example: de

testMode boolean

Whether the connector is in test mode.

Example: true

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.

property name* any

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.

property name* any

Connector configuration.

createdAt date-time

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

customerProfileContainer int64nullable

Customer profile Container ID.

defaultRiskRuleSet int64nullable

description string

disabled boolean

Example: false

disabledTransactionTypes TransactionType (string)[]

List of transaction type disabled for this connector.

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

merchantGuid string

Merchant identifier.

Example: ME-1234-1234-1234-1234-1234-1234

isMetaConnector boolean

Whether the connector is a meta-connector.

Example: false

postbackFormat PostbackFormat (string)

Possible values: [inherit, json, xml]

Default value: inherit

provider string

Provider identifier.

scheduleApiAvailable boolean

Whether the scheduler is enabled.

virtualTerminalAvailable boolean

Whether the virtual terminal is enabled.

vtRiskRuleSet int64

Identifier of risk rule profile for virtual terminal.

settings

object

account-updater:connector-guid stringnullable

adapter-id:use-merchant-txid-as-customerid stringnullable

api:request-signing-enabled stringnullable

backdirect:loading-screen stringnullable

batch-capture:pessimistic stringnullable

batch-capture:time stringnullable

cb-reveral:inform-email stringnullable

cb-reversal:no-conflict stringnullable

cb:create-representment stringnullable

email:sender-address stringnullable

email:sender-name stringnullable

fees:calculate-register-for-combined-tx stringnullable

handler:anti-fraud-stack stringnullable

hooks:transaction-success stringnullable

intermediate-redirect:enabled stringnullable

kount:api_key stringnullable

kount:enable-update-call stringnullable

kount:fields stringnullable

kount:init-scripts-automatically stringnullable

kount:merchant_id stringnullable

kount:test-mode-enabled stringnullable

manipulation:prepend-uuid stringnullable

merchant-settlement:no-rolling-reserve stringnullable

meta-connector:reroute-refund stringnullable

migration:connector-guids stringnullable

postback-queue:max-retries stringnullable

postback-sharing:projects stringnullable

postback:old-service-name stringnullable

postback:override-api-key stringnullable

postback:send-on-capture stringnullable

postback:send-on-pending stringnullable

postback:send-test-plain-header stringnullable

postback:send-useragent-header stringnullable

postback:suppress-outgoing stringnullable

postback:use-rfc-compliant-tz stringnullable

postback:with-adapter-reference stringnullable

postback:with-auth-code stringnullable

postback:with-connector-info stringnullable

preemptive-rendering:enabled stringnullable

processing:convert-register-to-debit stringnullable

processing:copy-customer-data-from-customer-profile-transaction stringnullable

processing:copy-customer-data-from-related stringnullable

processing:overwrite-customer-billing-country stringnullable

processing:set-customer-identification stringnullable

reconciliation:returns-processor-id stringnullable

redirect:type-for-html stringnullable

refund:ui-enabled stringnullable

refund:with-chargeback stringnullable

registration-sharing:projects stringnullable

risk-engine:manual-review-delay stringnullable

risk-engine:manual-review-for-recurring stringnullable

risk-engine:review-requirements stringnullable

risk-engine:show-risk-check-data-in-api-result stringnullable

risk-engine:store-test-tx stringnullable

settlement:create-unknown-transaction stringnullable

threedsecure:check stringnullable

tx:expiration-minutes stringnullable

vault:external-vault-connector-guid stringnullable

view:allow-merchant-upload stringnullable

view:legacy stringnullable

view:merchant-defined stringnullable

view:no-country-dropdown stringnullable

view:no-expiration-dropdown stringnullable

virtual-terminal:pan-only stringnullable

alias string

Set connector alias for global routing.

terminals

object[]

Array [

terminalId string

Unique terminal identifier.

disabled boolean

]

routingMetaConnector

object

On create/update add this to create a classic routing meta-connector (adapter and method must be set to MetaConnector).

defaultConnector string

Identifier of the default connector to route to.

reRouteRecurring boolean

Whether to re-route recurring transactions to the original connector.

Default value: false

multiMethodMetaConnector

object

On create/update add this to create a multi-method meta-connector (adapter and method must be set to MetaConnector).

defaultActionDisableConnector boolean

If no action is configured (rules), the default action is to disable the connector.

retries int32

How many retries should be allowed if possible.

Possible values: <= 9

expiry int64

Expiry time in hours.

]

property name* any

Example (from schema)

{
  "success": true,
  "connectors": [
    {
      "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
      }
    }
  ]
}

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...