Skip to main content

AppPaymentGatewayConfigGql

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

type AppPaymentGatewayConfigGql {
environment: PaymentGatewayEnvironment!
id: ID!
isEnabled: Boolean!
secretIssued: Boolean!
unavailableReason: String
updatedAt: DateTime!
verification: PaymentGatewayVerificationGql!
webhookUrl: String!
}

Fields​

AppPaymentGatewayConfigGql.environment ● PaymentGatewayEnvironment! non-null enum​

TEST or LIVE payments.

AppPaymentGatewayConfigGql.id ● ID! non-null scalar​

The configuration's id: the configId buyers' checkouts select it by.

AppPaymentGatewayConfigGql.isEnabled ● Boolean! non-null scalar​

True when buyers are offered this payment app.

AppPaymentGatewayConfigGql.secretIssued ● Boolean! non-null scalar​

True when a signing secret has been issued.

AppPaymentGatewayConfigGql.unavailableReason ● String scalar​

Why ARC would not offer this payment app right now, word for word; null when it can take payments.

AppPaymentGatewayConfigGql.updatedAt ● DateTime! non-null scalar​

When the configuration last changed.

AppPaymentGatewayConfigGql.verification ● PaymentGatewayVerificationGql! non-null object​

The result of the last connection test.

AppPaymentGatewayConfigGql.webhookUrl ● String! non-null scalar​

Where the app sends its signed payment webhooks.

Returned By​

setAppPaymentGatewayEnabled mutation ● testAppPaymentGateway mutation

Member Of​

AppPaymentGatewayConnectionGql object ● AppPaymentGatewayGql object