Skip to main content

payMethodUpdate

Update an existing payment method's configuration.

Modifies payment method details including localized names, external integration codes, and branding elements. Only provided fields will be updated, others remain unchanged. Supports partial updates for flexible payment method management.

Validation requirements:

  • Names array must contain unique languages if provided
  • External code must follow SCREAMING_SNAKE_CASE format and be unique if provided
  • Logo URL must be valid if provided (maximum 255 characters)

Possible errors:

  • PAY_METHOD_NOT_FOUND_ERROR: Payment method with the specified ID does not exist
  • PAY_METHOD_EXTERNAL_CODE_ALREADY_EXISTS: Updated external code already exists for another payment method
  • PAY_METHOD_UNKNOWN_ERROR: Unknown error occurred during payment method update
  • UNAUTHENTICATED: Invalid or missing authentication
  • FORBIDDEN: Insufficient permissions to update payment methods

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

payMethodUpdate(
  id: Int!
  input: PayMethodUpdateInput!
): PayMethod!

Arguments​

payMethodUpdate.id ● Int! non-null scalar​

Unique identifier of the payment method to update.

Must be a positive integer representing a valid payment method ID in the system.

payMethodUpdate.input ● PayMethodUpdateInput! non-null input​

Updated payment method information.

Contains the payment method properties to update. Only provided fields will be changed, others remain unchanged.

Type​

PayMethod object​

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.