GOgocardless
Outbound Payment

Cancel an outbound payment

Cancels an outbound payment. Only outbound payments with either verifying, pending_approval, or scheduled status can be cancelled. Once an outbound payment is executing, the money moving process has begun and cannot be reversed.

post/outbound_payments/{outbound_payment_id}/actions/cancel

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Path parameters

outbound_payment_idstring required

The outbound payment id

Headers

GoCardless-Versionstring required

Request body

Response

Action completed successfully

Example response

{
  "outbound_payments": {
    "id": "OUT123",
    "created_at": "2024-01-01T12:00:00.001Z",
    "status": "cancelled",
    "amount": 1000,
    "scheme": "faster_payments",
    "currency": "GBP",
    "execution_date": "2024-08-31",
    "description": "Reward Payment (August 2024)",
    "reference": "GC-QC2FI7GBEW7VCXL",
    "is_withdrawal": true,
    "links": {
      "creditor": "CR123",
      "customer": "CU123",
      "recipient_bank_account": "BA123",
      "outbound_payment_import": "IM123"
    },
    "verifications": {
      "recipient_bank_account_holder_verification": {
        "type": "confirmation_of_payee",
        "result": "partial_match",
        "actual_account_name": "Jo Doe"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.