Skip to main content

paymentDelete

Permanently delete a payment from the system.

Removes the payment record and all associated transaction data. This action cannot be undone and will affect any orders or financial reports that depend on this payment. Use with caution as this permanently removes financial records from the system.

Possible errors:

  • DELETE_PAYMENT_ERROR: Failed to delete the payment due to system error
  • PAYMENT_NOT_FOUND_ERROR: Payment with the specified search criteria does not exist
  • FORBIDDEN: Insufficient permissions to delete payments

AUTH: Role=[order.OWNER]

paymentDelete(
  searchBy: SearchByInput!
): Payment!

Arguments​

paymentDelete.searchBy ● SearchByInput! non-null input​

Search criteria for finding the payment to delete.

Specifies how to identify the payment (by ID, payment ID, or order ID) for removal.

Type​

Payment object​

Payment record representing a financial transaction for order processing.

Manages payment lifecycle from creation through completion, including amount tracking, currency handling, and payment method processing. Supports multiple payment states and transaction history for comprehensive financial management.