Payment request cancellation reasons

Using the Vitesse API or Vitesse portal, an authorised user can cancel a payment while it is in the payment request phase of the payment lifecycle. After the payment enters the transaction phase, the payment cannot be cancelled.

Each cancellation request must include a valid cancellation reason, detailed below:

ReasonId	Name	When to use
`claim-status-change`	Change in claim status	Following a change in claim or case status, the business has determined that the associated payment instruction is no longer required.
`client-request`	Client requested cancellation	The client or authorised party has explicitly requested that the payment is cancelled.
`duplicate`	Duplicate payment	The payment request was submitted more than once for the same obligation or amount.
`expired`	Expired request	For Payee Choice and Vendor Pay payments only. The payment request is no longer valid because the recipient failed to take action within a designated time period.
`incorrect-payee-details`	Incorrect payee details	The recipient’s identity or beneficiary information was entered incorrectly.
`incorrect-payment-details`	Incorrect payment details	The payment amount, currency, or other details were entered incorrectly.
`paid-via-alternate-means`	Paid via alternate means	The payment has already been settled through another payment method or channel.
`system-issue`	System issue	A technical issue prevented the payment from proceeding as intended.
`other`	Other	Use when none of the predefined reasons apply. You must include a clear description explaining the cancellation.