setPaymentGatewayEnabled

Requires permission settings:integration:update.

Enables or disables one payment gateway. Enabling is refused until the API keys have been verified (testPaymentGatewayConnection) and a verified webhook event has been received from the provider. Gateways are independent: enabling one does not disable another.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation SetPaymentGatewayEnabled($enabled: Boolean!, $provider: PaymentGatewayProvider!) {
  setPaymentGatewayEnabled(enabled: $enabled, provider: $provider) {
    id
    configuredSecretKeys
    enabledMethods
    environment
    isEnabled
    provider
    nonSecretValues {
      key
      value
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetPaymentGatewayEnabled($enabled: Boolean!, $provider: PaymentGatewayProvider!) {\n  setPaymentGatewayEnabled(enabled: $enabled, provider: $provider) {\n    id\n    configuredSecretKeys\n    enabledMethods\n    environment\n    isEnabled\n    provider\n    nonSecretValues {\n      key\n      value\n    }\n  }\n}",
  "variables": {
    "enabled": true,
    "provider": "PEACH"
  }
}
EOF

Variables:

{
  "enabled": true,
  "provider": "PEACH"
}

Response:

{
  "data": {
    "setPaymentGatewayEnabled": {
      "id": "id",
      "configuredSecretKeys": [
        "string"
      ],
      "enabledMethods": [
        "string"
      ],
      "environment": "LIVE",
      "isEnabled": true,
      "provider": "PEACH",
      "nonSecretValues": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  }
}

setPaymentGatewayEnabled(
  enabled: Boolean!
  provider: PaymentGatewayProvider!
): PaymentGatewayConfigGql!

Arguments

setPaymentGatewayEnabled.enabled ● Boolean! non-null scalar

True to enable the gateway, false to disable it. Enabling needs valid keys and a reachable webhook.

setPaymentGatewayEnabled.provider ● PaymentGatewayProvider! non-null enum

The payment provider to enable or disable.

Type

PaymentGatewayConfigGql object

The organization's setup for one payment provider. Secret credentials are never returned.