PaymentGatewayConfigGql

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

type PaymentGatewayConfigGql {
  configuredSecretKeys: [String!]!
  enabledMethods: [String!]!
  environment: PaymentGatewayEnvironment!
  id: ID!
  isEnabled: Boolean!
  nonSecretValues: [CredentialValueGql!]!
  provider: PaymentGatewayProvider!
  updatedAt: DateTime!
  verification: PaymentGatewayVerificationGql!
}

Fields

PaymentGatewayConfigGql.configuredSecretKeys ● [String!]! non-null scalar

The secret credential fields that have a stored value. The values themselves are never returned.

PaymentGatewayConfigGql.enabledMethods ● [String!]! non-null scalar

The payment methods offered through this gateway.

PaymentGatewayConfigGql.environment ● PaymentGatewayEnvironment! non-null enum

The provider environment the credentials belong to.

PaymentGatewayConfigGql.id ● ID! non-null scalar

The unique ID of this record.

PaymentGatewayConfigGql.isEnabled ● Boolean! non-null scalar

True when the gateway is offered at checkout.

PaymentGatewayConfigGql.nonSecretValues ● [CredentialValueGql!]! non-null object

The non-secret credential fields with their values.

PaymentGatewayConfigGql.provider ● PaymentGatewayProvider! non-null enum

The payment provider.

PaymentGatewayConfigGql.updatedAt ● DateTime! non-null scalar

When the record was last changed.

PaymentGatewayConfigGql.verification ● PaymentGatewayVerificationGql! non-null object

The result of the last verification.

Returned By

paymentGatewayConfigs query ● setPaymentGatewayEnabled mutation ● upsertPaymentGatewayConfig mutation