Skip to main content

PayMethodUpdateInput

Input for updating an existing payment method with partial data.

Allows partial updates of payment method properties including localized names, external integration codes, and branding elements. Only provided fields will be updated, others remain unchanged.

Validation constraints:

  • Names array must contain unique languages if provided (minimum 1 item)
  • External code must follow SCREAMING_SNAKE_CASE format and be unique (maximum 64 characters)
  • Logo URL must be valid if provided (maximum 255 characters)
input PayMethodUpdateInput {
  names: [LocalizedStringInput!]
  externalCode: String
  logo: String
}

Fields​

PayMethodUpdateInput.names ● [LocalizedStringInput!] list input​

Localized payment method names for different languages.

Collection of payment method names in various languages for international checkout experiences. Each language must be unique and follow ISO 639-1 format. At least one localized name is required.

PayMethodUpdateInput.externalCode ● String scalar​

External system identifier in SCREAMING_SNAKE_CASE format.

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

PayMethodUpdateInput.logo ● String scalar​

Payment method logo URL for checkout display.

Optional URL pointing to the payment method's logo or icon for visual identification in checkout interfaces. Must be a valid URL format with maximum 255 characters.

Member Of​

payMethodUpdate mutation