Settings vault

GET 
/getConnectorSettings/:adapterId/:merchantGuid

Returns the connector settings of a given vault adapter.

Request

Path Parameters

adapterId stringrequired

Identifier of the adapter.

merchantGuid stringrequired

Identifier of the merchant.

Responses

200

The vault connector settings for the given adapter.

application/json

Schema

Schema

success booleanrequired

Whether the request was successful or not.

baseConfig

object

List of properties, json-schema style.

When creating a connector pass the key/value pairs in config.extraData.

property name* any

List of properties, json-schema style.

When creating a connector pass the key/value pairs in config.extraData.

vaultConfig

object

List of properties, json-schema style.

When creating a connector pass the key/value pairs in config.vault.

property name* any

List of properties, json-schema style.

When creating a connector pass the key/value pairs in config.vault.

property name* any

Example (from schema)

{
  "success": true,
  "baseConfig": {},
  "vaultConfig": {}
}

Example

{
  "baseConfig": [
    {
      "name": "integrationType",
      "type": "select",
      "required": false,
      "description": "Type of Integration"
    },
    {
      "name": "mergeCustomerDataFromRef",
      "type": "bool",
      "required": false,
      "description": "Merge Customer Data from Reference Transaction"
    },
    {
      "name": "collectMissing3DSecureData",
      "type": "bool",
      "required": false,
      "description": "Collect Missing 3DS Browser Data through Redirect"
    }
  ],
  "vaultConfig": [
    {
      "name": "dummyParam",
      "type": "string",
      "required": true,
      "description": "Dummy Parameter"
    },
    {
      "name": "enableTestMpi",
      "type": "boolean",
      "required": false,
      "description": "Enable Test MPI"
    },
    {
      "name": "threeDConfig",
      "type": "object",
      "required": false,
      "description": "3D-Secure Configuration (IXOPAY-hosted)",
      "properties": [
        {
          "name": "enabled",
          "type": "boolean",
          "required": true,
          "description": "Enabled"
        },
        {
          "name": "acquirers",
          "type": "array",
          "required": false,
          "description": "Acquiring BINs",
          "items": {
            "type": "object",
            "properties": [
              {
                "name": "scheme",
                "type": "string",
                "required": true,
                "description": "Scheme",
                "enum": [
                  "visa",
                  "mastercard",
                  "amex",
                  "jcb",
                  "discover",
                  "unionpay",
                  "diners"
                ]
              },
              {
                "name": "bin",
                "type": "string",
                "required": true,
                "description": "BIN"
              }
            ]
          }
        },
        {
          "name": "password",
          "type": "string",
          "required": false,
          "description": "Password"
        },
        {
          "name": "countryCode",
          "type": "string",
          "required": false,
          "description": "Merchant Country Code (ISO 3166 three digit)"
        },
        {
          "name": "MerchantID",
          "type": "string",
          "required": false,
          "description": "MerchantID"
        },
        {
          "name": "MerchantName",
          "type": "string",
          "required": false,
          "description": "MerchantName"
        },
        {
          "name": "MerchantURL",
          "type": "string",
          "required": false,
          "description": "Merchant Shop URL"
        }
      ]
    },
    {
      "name": "threeDV2Config",
      "type": "object",
      "required": false,
      "description": "3D-Secure 2 Configuration (IXOPAY-hosted)",
      "properties": [
        {
          "name": "enabled",
          "type": "boolean",
          "required": true,
          "description": "Enabled"
        },
        {
          "name": "acquirers",
          "type": "array",
          "required": false,
          "description": "Acquiring BINs"
        },
        {
          "items": {
            "type": "object",
            "properties": [
              {
                "name": "scheme",
                "type": "string",
                "required": true,
                "description": "Scheme",
                "enum": [
                  "visa",
                  "mastercard",
                  "amex",
                  "jcb",
                  "discover",
                  "unionpay",
                  "diners"
                ]
              },
              {
                "name": "bin",
                "type": "string",
                "required": true,
                "description": "BIN"
              },
              {
                "name": "MerchantID",
                "type": "string",
                "required": true,
                "description": "MerchantID"
              }
            ]
          }
        },
        {
          "name": "Merchant",
          "type": "object",
          "required": false,
          "description": "Merchant Data",
          "properties": [
            {
              "name": "mcc",
              "type": "string",
              "required": false,
              "description": "Merchant Category Code"
            },
            {
              "name": "country",
              "type": "string",
              "required": false,
              "description": "Merchant Country Code"
            },
            {
              "name": "name",
              "type": "string",
              "required": false,
              "description": "Merchant Name"
            }
          ]
        },
        {
          "name": "parameterConfig",
          "type": "object",
          "required": false,
          "description": "Parameter Configuration",
          "properties": [
            {
              "name": "challengeIndicator",
              "type": "string",
              "required": false,
              "description": "Force Challenge Indicator",
              "enum": [
                "---",
                "01 - No Preference",
                "02 - No Challenge requested",
                "03 - Challenge Requested",
                "04 - Challenge Mandated"
              ]
            }
          ]
        },
        {
          "name": "preferredProtocolVersion",
          "type": "string",
          "required": false,
          "description": "Preferred Protocol Version",
          "enum": "any 2.1.0 2.2.0 latest"
        }
      ]
    },
    {
      "name": "applePay",
      "type": "object",
      "required": false,
      "description": "Apple Pay",
      "properties": [
        {
          "name": "enabled",
          "type": "boolean",
          "required": false,
          "description": "Enabled"
        },
        {
          "name": "MerchantIdentifier",
          "type": "string",
          "required": false,
          "description": "MerchantIdentifier"
        },
        {
          "name": "privateKey",
          "type": "string",
          "required": false,
          "description": "Private Key"
        }
      ]
    },
    {
      "name": "googlePay",
      "type": "object",
      "required": false,
      "description": "Google Pay",
      "properties": [
        {
          "name": "enabled",
          "type": "boolean",
          "required": false,
          "description": "Enabled"
        },
        {
          "name": "MerchantIdentifier",
          "type": "string",
          "required": false,
          "description": "MerchantIdentifier"
        },
        {
          "name": "useTestEnvironment",
          "type": "boolean",
          "required": false,
          "description": "Test Environment Enabled"
        }
      ]
    },
    {
      "name": "enablePassthroughToken",
      "type": "boolean",
      "required": false,
      "description": "Enable Passthrough Tokens"
    }
  ],
  "success": true
}

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