Skip to main content

PayMethod

Payment method configuration for checkout and payment processing.

Represents a payment option available to customers during checkout including configuration details, branding, and integration settings. Used for payment processing, checkout flows, and financial transaction management.

type PayMethod {
  id: Int!
  createdAt: DateTime!
  lastModifiedAt: DateTime!
  names: [LocalizedString!]!
  externalCode: String!
  logo: String
}

Fields​

PayMethod.id ● Int! non-null scalar​

Unique identifier for the payment method.

Primary key used to reference this payment method throughout the system for payment processing operations and checkout workflows.

PayMethod.createdAt ● DateTime! non-null scalar​

Payment method creation timestamp.

Date and time when this payment method was initially created in the system, used for auditing and payment method lifecycle tracking.

PayMethod.lastModifiedAt ● DateTime! non-null scalar​

Payment method last modification timestamp.

Date and time when any payment method configuration was last updated, used for change tracking and synchronization purposes.

PayMethod.names ● [LocalizedString!]! non-null object​

Localized payment method names for different languages.

Collection of payment method names in various languages for international checkout experiences and multilingual storefronts. Each language must be unique within the collection.

PayMethod.externalCode ● String! non-null scalar​

External system identifier for payment processing integration.

Unique code used to identify this payment method in external payment processors, gateways, and financial systems. Must follow SCREAMING_SNAKE_CASE format and be unique across all payment methods. Maximum 64 characters.

PayMethod.logo ● String scalar​

Payment method logo URL for checkout display.

URL pointing to the payment method's logo or icon, used for visual identification in checkout interfaces and payment selection screens. Maximum 255 characters.

Returned By​

payMethod query ● payMethodCreate mutation ● payMethodUpdate mutation

Member Of​

PayMethodsResponse object