GoCardless API API Documentation
Disable a Customer Bank Account
POST {{url}}/customer_bank_accounts/{{customer_bank_acct}}/actions/disable
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.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"customer_bank_accounts": {
"id": "BA000ZP5SP5WJ0",
"created_at": "2024-03-22T20:44:08.380Z",
"account_number_ending": "11",
"account_holder_name": "SHARON LYNCH",
"account_type": null,
"bank_name": "BARCLAYS BANK PLC",
"currency": "GBP",
"country_code": "GB",
"metadata": {
"key": "value"
},
"enabled": false,
"links": {
"customer": "CU0014DQPR6JJP"
}
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/customer_bank_accounts/https://api-sandbox.gocardless.com/actions/disable' -d '{"customer_bank_accounts":{"metadata":{"key":"value"}}}'
ENDPOINTS