Customer Bank Account

Disable a customer bank account

Immediately cancels all associated mandates and cancellable payments.

This will return a disable_failed error if the bank account has already been disabled.

A disabled bank account can be re-enabled by creating a new bank account resource with the same details.

post/customer_bank_accounts/{customer_bank_account_id}/actions/disable

Request

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

Path parameters

customer_bank_account_idstring required

The customer bank account id

Headers

GoCardless-Versionstring required

Response

Action completed successfully

Example response

{
  "customer_bank_accounts": {
    "id": "BA123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "account_holder_name": "Billie Jean",
    "account_number_ending": "1234",
    "account_type": "savings",
    "country_code": "GB",
    "currency": "EUR",
    "bank_name": "BARCLAYS BANK PLC",
    "bank_account_token": "bat_f975ab3c-ecee-47a1-9590-5bb1d56fa113",
    "enabled": true,
    "trusted_recipient": true,
    "payer_name_verification_result": "full"
  }
}

Changes

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