GoCardlessDeveloper Docs
Create a sandbox account

Cancel an outbound payment#

View as Markdown

Eligibility#

Once an outbound payment moves to the executing state or beyond, the payment process has started and cancellation is no longer possible.

Payment typeCancellable states
Instant outbound paymentsverifying, pending_approval
Future-dated outbound paymentsverifying, pending_approval, scheduled

Use cases for cancellation#

  1. The payment is no longer necessary — for example, the recipient no longer requires the funds, or a business decision changes the need for the payment.
  2. You have concerns about the verification results and do not wish to proceed.
  3. Since outbound payments cannot be directly updated, cancellation is required if any attributes need to be changed. To modify the amount, description, or other parameters, cancel the existing payment and create a new one.

No recall process#

Example#

POST https://api.gocardless.com/outbound_payments/{outbound_payment_id}/actions/cancel HTTP/1.1

What's next?#