setAppPaymentGatewayEnabled

Requires permission settings:integration:update.

Offer or stop offering a payment app at checkout. Enabling needs a passed connection test and an app ARC can use.

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 SetAppPaymentGatewayEnabled($configId: ID!, $enabled: Boolean!) {
  setAppPaymentGatewayEnabled(configId: $configId, enabled: $enabled) {
    id
    environment
    isEnabled
    secretIssued
    unavailableReason
    updatedAt
    verification {
      keysCheckedAt
      keysValid
      needsReverification
      testPaymentAt
      webhookReachable
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation SetAppPaymentGatewayEnabled($configId: ID!, $enabled: Boolean!) {\n  setAppPaymentGatewayEnabled(configId: $configId, enabled: $enabled) {\n    id\n    environment\n    isEnabled\n    secretIssued\n    unavailableReason\n    updatedAt\n    verification {\n      keysCheckedAt\n      keysValid\n      needsReverification\n      testPaymentAt\n      webhookReachable\n    }\n  }\n}",
  "variables": {
    "configId": "id",
    "enabled": true
  }
}
EOF

Variables:

{
  "configId": "id",
  "enabled": true
}

Response:

{
  "data": {
    "setAppPaymentGatewayEnabled": {
      "id": "id",
      "environment": "LIVE",
      "isEnabled": true,
      "secretIssued": true,
      "unavailableReason": "string",
      "updatedAt": "2025-01-15T00:00:00Z",
      "verification": {
        "keysCheckedAt": "string",
        "keysValid": true,
        "needsReverification": true,
        "testPaymentAt": "string",
        "webhookReachable": true
      }
    }
  }
}

setAppPaymentGatewayEnabled(
  configId: ID!
  enabled: Boolean!
): AppPaymentGatewayConfigGql!

Arguments

setAppPaymentGatewayEnabled.configId ● ID! non-null scalar

The payment app's configuration.

setAppPaymentGatewayEnabled.enabled ● Boolean! non-null scalar

True to offer it, false to stop.

Type

AppPaymentGatewayConfigGql object

An installed payment app's gateway configuration. Its signing secret is never returned after it is issued.