Skip to main content

List

GET 

/listConnectors/:merchantGuid

Returns the connectors of the given merchant.

Request

Path Parameters

    merchantGuid stringrequired

    Identifier of the merchant.

Responses

The connectors of the given tenant.

Schema

    success booleanrequired

    Whether the request was successful or not.

    connectors

    object[]

    List of connectors of a merchant.

  • Array [

  • guid string

    Identifier.

    name stringrequired

    Possible values: >= 3 characters

    adapter stringrequired

    Adapter identifier.

    method stringrequired

    Method identifier.

    apiKey stringrequired

    Connector API key.

    publicIntegrationKey string

    Connector public integration key, user for payment.js.

    sharedSecret string

    Possible values: <= 50 characters

    Connector shared secret.

    If left empty the sharedSecret will be generated automatically.

    archived boolean
    businessCountry Country (string)

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

    ISO 3166-1 alpha-2 country code.

    config

    object

    Connector configuration.

    username string
    password string
    apiSecret string

    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.

    language Language (string)

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

    ISO 639-1 language code.

    testMode boolean

    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.

    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
    customerProfileContainer int64nullable

    Customer profile Container ID.

    defaultRiskRuleSet int64nullable
    description string
    disabled boolean
    disabledTransactionTypes TransactionType (string)[]

    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.

    merchantGuid string

    Merchant identifier.

    isMetaConnector boolean

    Whether the connector is a meta-connector.

    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.

    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

    Possible values: <= 9

    How many retries should be allowed if possible.

    expiry int64

    Expiry time in hours.

  • ]

  • property name* any
Loading...