GC Logo Dark
Developer Docs

Guides

Bank Payments
Overview
Setting up mandatesDirect Debit Mandates Verified Mandates PayTo Agreements and Payments Build a client to create mandates offline Supporting mandates set up outside of your product Importing Mandates Blocking mandates
One-off paymentsTaking an Instant Bank Payment Taking a one off payment
Recurring paymentsTaking Subscription payments Taking Instalment payments Variable Recurring Payments
Combining one-off and recurring paymentsTake a first Instant Payment with mandate
 set up
Responding to eventsResponding to Mandate Events Responding to Billing Requests Events
FX Payments Reconciling Payouts ACH and PAD Consent Types
Send money
Introduction to Outbound Payments Payment Account API request signing
Send an outbound paymentAdding a new recipient Initiate an outbound payment Approve an outbound payment Cancel an outbound payment
Tracking outbound payments Bank Account Holder Verification Strong Customer Authentication
Optimise and increase revenue
Prevent fraud with Protect+ Retain customers with fallbacks Reduced failed payments with Success+
Prefill customer detailsNew customer record Existing customer record Populate Billing Request Flow
Tutorials
Taking Direct Debit payments using Billing Requests and Custom Payment Pages Handling tax Handling Customer Notifications
GoCardless Embed
Introduction Creating a creditor Adding a creditor bank account OptionalSetting a scheme identifer Optional
Setting up mandates / collecting paymentsBilling Request with Actions: Setting up a Direct Debit mandate Collecting a Direct Debit payment Billing Request with Actions: Taking an Instant Bank Payment Billing Request with Actions Dual Flow: Taking an Instant Bank Payment and setting up a Direct Debit mandate
Handling webhooks
Reconciling payoutsPayout Items API Automated Payout Reporting Optional
Setting Up Branding OptionalAPI request signing OptionalBank Details Access Optional
Bank Account Data
Overview Quickstart Guide Endpoints Bank Selection UI Sandbox Statuses and Error code Output: Account Details Output: Balances Output: Transaction Details Postman Collection FAQs

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?
Connect as a partner