Skip to main content

AppPaymentGatewayGql

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

type AppPaymentGatewayGql {
  config: AppPaymentGatewayConfigGql
  installationId: ID!
  notPaymentAppReason: String
  paymentApp: Boolean!
  supportedCurrencies: [String!]!
}

Fields​

AppPaymentGatewayGql.config ● AppPaymentGatewayConfigGql object​

The app's gateway configuration; null until it is connected.

AppPaymentGatewayGql.installationId ● ID! non-null scalar​

The installed app.

AppPaymentGatewayGql.notPaymentAppReason ● String scalar​

Why the app cannot take payments; null when it can.

AppPaymentGatewayGql.paymentApp ● Boolean! non-null scalar​

True when the installed version can take payments: an https appUrl and supportedCurrencies in its manifest.

AppPaymentGatewayGql.supportedCurrencies ● [String!]! non-null scalar​

The currencies the app's manifest declares.

Returned By​

appPaymentGateway query