Skip to main content

payMethodCreate

Create a new payment method in the system.

Establishes a new payment method with localized names, external integration codes, and branding elements. The payment method becomes immediately available for checkout processes and payment workflows.

Validation requirements:

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

Possible errors:

  • PAY_METHOD_EXTERNAL_CODE_ALREADY_EXISTS: External code already exists for another payment method
  • PAY_METHOD_UNKNOWN_ERROR: Unknown error occurred during payment method creation
  • UNAUTHENTICATED: Invalid or missing authentication
  • FORBIDDEN: Insufficient permissions to create payment methods

AUTH: Role=[configuration.OWNER]

payMethodCreate(
  input: PayMethodCreateInput!
): PayMethod!

Arguments​

payMethodCreate.input ● PayMethodCreateInput! non-null input​

Payment method creation data including configuration and processing settings.

Contains payment method details, integration configuration, and all information needed to create a functional payment method.

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.