Skip to main content

payMethodDelete

Permanently delete a payment method from the system.

Removes the payment method and all associated configuration including localized names, external integration codes, and branding elements. This action cannot be undone and will affect any checkout processes that depend on this payment method.

Possible errors:

  • PAY_METHOD_NOT_FOUND_ERROR: Payment method with the specified ID does not exist
  • PAY_METHOD_UNKNOWN_ERROR: Unknown error occurred during payment method deletion
  • UNAUTHENTICATED: Invalid or missing authentication
  • FORBIDDEN: Insufficient permissions to delete payment methods

AUTH: Role=[configuration.OWNER]

payMethodDelete(
  id: Int!
): Boolean!

Arguments​

payMethodDelete.id ● Int! non-null scalar​

Unique identifier of the payment method to delete.

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

Type​

Boolean scalar​

The Boolean scalar type represents true or false.