Skip to main content

PaymentGatewayCredentialFieldGql

One credential a payment provider needs, such as an API key.

type PaymentGatewayCredentialFieldGql {
helpText: String
key: String!
label: String!
placeholder: String
secret: Boolean!
}

Fields​

PaymentGatewayCredentialFieldGql.helpText ● String scalar​

Guidance on where to find the value.

PaymentGatewayCredentialFieldGql.key ● String! non-null scalar​

The name of the credential field.

PaymentGatewayCredentialFieldGql.label ● String! non-null scalar​

The label to show for the field.

PaymentGatewayCredentialFieldGql.placeholder ● String scalar​

An example value to show in the empty field.

PaymentGatewayCredentialFieldGql.secret ● Boolean! non-null scalar​

True when the value is a secret and is never returned once saved.

Member Of​

PaymentGatewayProviderInfo object