appPaymentGateway

Requires permission settings:integration:read.

Whether an installed app can take payments, and its payment gateway configuration if it is connected.

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 AppPaymentGateway($installationId: ID!) {
  appPaymentGateway(installationId: $installationId) {
    installationId
    notPaymentAppReason
    paymentApp
    supportedCurrencies
    config {
      id
      environment
      isEnabled
      secretIssued
      unavailableReason
      updatedAt
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query AppPaymentGateway($installationId: ID!) {\n  appPaymentGateway(installationId: $installationId) {\n    installationId\n    notPaymentAppReason\n    paymentApp\n    supportedCurrencies\n    config {\n      id\n      environment\n      isEnabled\n      secretIssued\n      unavailableReason\n      updatedAt\n    }\n  }\n}",
  "variables": {
    "installationId": "id"
  }
}
EOF

Variables:

{
  "installationId": "id"
}

Response:

{
  "data": {
    "appPaymentGateway": {
      "installationId": "id",
      "notPaymentAppReason": "string",
      "paymentApp": true,
      "supportedCurrencies": [
        "string"
      ],
      "config": {
        "id": "id",
        "environment": "LIVE",
        "isEnabled": true,
        "secretIssued": true,
        "unavailableReason": "string",
        "updatedAt": "2025-01-15T00:00:00Z"
      }
    }
  }
}

appPaymentGateway(
  installationId: ID!
): AppPaymentGatewayGql!

Arguments

appPaymentGateway.installationId ● ID! non-null scalar

The installed app.

Type

AppPaymentGatewayGql object

Whether an installed app can take payments, and its connection.