Skip to main content

paymentUpdate

Update an existing payment's information.

Modifies payment details including status, amounts, transaction information, and processing details. Only provided fields will be updated, others remain unchanged. Supports partial updates for flexible payment management throughout the payment lifecycle.

Possible errors:

  • UPDATE_PAYMENT_ERROR: Failed to update the payment due to system error
  • PAYMENT_NOT_FOUND_ERROR: Payment with the specified search criteria does not exist
  • PAYMENT_ALREADY_EXISTS_ERROR: Updated payment data conflicts with existing payment
  • FORBIDDEN: Insufficient permissions to update payments

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

paymentUpdate(
  searchBy: SearchByInput!
  input: UpdatePaymentInput!
): Payment!

Arguments​

paymentUpdate.searchBy ● SearchByInput! non-null input​

Search criteria for finding the payment to update.

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

paymentUpdate.input ● UpdatePaymentInput! non-null input​

Updated payment information.

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

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.