paymentGatewayConfigs

Requires permission settings:integration:read.

Lists your organization's saved payment gateway configurations, one per provider.

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

query PaymentGatewayConfigs {
  paymentGatewayConfigs {
    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": "query PaymentGatewayConfigs {\n  paymentGatewayConfigs {\n    id\n    configuredSecretKeys\n    enabledMethods\n    environment\n    isEnabled\n    provider\n    nonSecretValues {\n      key\n      value\n    }\n  }\n}"
}
EOF

Response:

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

paymentGatewayConfigs: [PaymentGatewayConfigGql!]!

Type

PaymentGatewayConfigGql object

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