Remove an existing bank account from a person.
Remove a Bank Account from a Person
Removes an existing bank account from a person's record.
A developer calls this endpoint to delete a bank account that is no longer valid or in use, for example after a person closes an account or provides updated bank account details.
The person is located via reference or externalIdentifier, at least one of which must be supplied.
The bank account itself is identified by bankAccountNumber, which must match an account already registered for the person. An account currently marked as preferred can only be removed if it is the person's only bank account; if other accounts exist, another account must first be made preferred (via Add a Bank Account or Update a Bank Account), which automatically transfers the preferred status, before the original account can be removed.
Request Fields
Field | Type | Required | Description |
|---|---|---|---|
reference | string | Required (at least one of reference or externalIdentifier must be given) | The internal identifier (Reference/Code) of the person whose bank account should be removed. |
externalIdentifier | string | Required (at least one of reference or externalIdentifier must be given) | The external API identifier of the person whose bank account should be removed. |
bankAccountNumber | string, max 34 | Required | The bank account number identifying which existing account to remove. Must match an account already registered for the person; if it does not, the request fails with an error stating the bank account was not found. If the account is marked preferred and other bank accounts exist for the person, the request fails with the error "Bank account cannot be deleted when marked as 'Preferred'." If the account is marked preferred but is the person's only bank account, removal succeeds and the person is left with no bank accounts. |
Response Fields
This endpoint returns no response body on success. A 200 response confirms the bank account was removed from the person.
Field | Type | Required | Description |
|---|---|---|---|
(none) | No fields are returned on success. |
The internal identifier of the model (i.e. Reference, Code, Name, depends on model).
The external API identifier of the model.
The bank account was removed from the person
The bank account data has validation issues