AppPayInstall

Summary

Cancel a pending payment by providing its Payment ID, optionally including a reason for the cancellation for record keeping.

Inputs

• Payment ID (required) — The unique identifier of the payment to cancel (e.g., pay_abc123, order_456).
• Cancellation Reason — Optional explanation for why the payment is being cancelled, for internal records (e.g., Customer requested, order cancelled).

Output shape

A single JSON object containing the cancellation result, including success status, payment ID, updated payment status, cancellation reason, and cancellation timestamp.

The operation returns a success flag along with the updated payment details after cancellation. No pagination or multiple records returned.

Examples

Example 1: Cancel a payment with ID 'pay_abc123' due to customer request.

Set Payment ID to 'pay_abc123' and Cancellation Reason to 'Customer requested'.