Skip to main content
Open in Explorer

cancelPayment

Cancels a payment of the current account before it is captured. PENDING payments and Bizum payments are canceled directly; other methods are voided through the processor. Already-captured payments cannot be canceled (use refundPayment). A payment already canceled is returned as it is. A payment canceled directly gets statusCode E222, whether the customer or the merchant canceled it. Read cancellationReason for the reason that cancelPayment saved. Arguments: - input: The payment to cancel.

cancelPayment(
  input: CancelPaymentInput!
): Payment

Arguments​

cancelPayment.input ● CancelPaymentInput! non-null input​

Type​

Payment object​

A payment as the payment mutations return it (createPayment, refundPayment, capturePayment, cancelPayment and the send mutations). Amounts are integers in the smallest unit of the currency: cents for EUR, whole yen for JPY. To read a payment later, use charge.

Last updated on