This endpoint is only relevant to Fully Hosted and Custom integrations.
If you’re building with a Forage SDK, then use the Payments endpoints.
Learn more about the high-level phases of an SDK integration in the Forage JS Quickstart, or check out the Payments API introduction for a list of resources by integration type.
Cancel a payment to prevent it from being submitted for capture in future API calls.
Only Payments in the requires_confirmation or failed states can be cancelled.
This endpoint has no financial side effects because it only affects payments which have not processed successfully.