GoCardless API API Documentation
Disable a Creditor Bank Account
POST {{url}}/creditor_bank_accounts/{{creditor_bank_account}}/actions/disable
Immediately disables the bank account, no money can be paid out to a disabled account. 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
| {
"creditor_bank_accounts": {
"id": "BA000ZP65KHX04",
"created_at": "2024-03-22T21:46:27.780Z",
"account_number_ending": "44",
"account_holder_name": "HOME LOAN ACCOUNT",
"account_type": null,
"bank_name": "BARCLAYS BANK PLC",
"currency": "GBP",
"country_code": "GB",
"metadata": {},
"enabled": false,
"links": {
"creditor": "CR00007SRS79RW"
},
"verification_status": "successful"
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/creditor_bank_accounts/https://api-sandbox.gocardless.com/actions/disable'
ENDPOINTS