Cancel an outbound payment

Eligibility

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

Instant outbound payments can only be cancelled when they are in the verifying or pending_approval states. These payments are processed immediately upon approval.

The future-dated outbound payments (with an execution date in the future) are eligible for cancellation while still in the verifying, pending_approval or scheduled states.

Use Cases for Cancellation

  1. The most common use case for cancellation is when the outbound payment is no longer necessary, such as when the recipient no longer requires the funds, or a business decision changes the need for the payment.

  2. Another common one is when you have some concerns regarding the verification results and do not wish to proceed with the payment.

  3. Since there is no process for directly updating an outbound payment, cancellation is required if any attributes need to be changed. E.g., if you need to modify the amount, description, or other parameters, you will need to cancel the existing outbound payment and create a new one.

No Recall Process

It’s important to note that once an outbound payment is processed and executed, it cannot be recalled. If a mistake is made, such as entering the wrong amount or recipient details, the funds are sent to the recipient's bank account, and we no longer have access to them.

Example

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

Need help?