PrivatbankInstall

Summary

Cancel a payment invoice fully or partially by specifying either the Invoice ID or Order ID; optionally include an external reference and a partial cancel amount.

Inputs

• Invoice ID — The ID of the invoice to cancel; either this or Order ID must be provided.
• Order ID (Reference) — The order reference to cancel; either this or Invoice ID must be provided.
• Cancel Amount — The amount to cancel in the smallest currency units; set to 0 for full cancellation.
• External Reference — An optional external reference to associate with the cancellation.

Output shape

a single record containing the result of the cancellation request

The output reflects the success or failure of the cancellation operation. Exactly one of Invoice ID or Order ID must be provided. Partial cancellation is supported by specifying a cancel amount greater than zero.