Changes the customer details recorded against a bank account and sends them to the bank provider. Use this rather than PUT /bank-accounts/{id} once an account's customer details have already been registered with the provider.
Only accounts held with a bank provider can be patched. An external account you registered yourself has no provider behind it and is rejected.
Send one or two change items. Each item changes exactly one thing, chosen from the account holder's company name, the account holder's individual name (first and last together), or the address (lines 1 to 3), and each item must carry a reason that matches what it changes. Two items cannot change the same thing, so a valid pair is a name change plus an address change. Changing an individual name is only possible on an account that already holds an individual first and last name.
The values follow the same rules as POST /bank-accounts: at most 35 characters, letters, digits, / - ? : ( ) . ' and spaces only, no leading space, and an uppercase ISO 3166-1 alpha-2 country code in addressLine3.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Invalid request, in one of two shapes. A changes array that is absent, empty, longer than two items, contains a null, or carries a reason outside the allowed values is rejected by the gateway with {"message":"Invalid request body"} and no messageKey. Everything else is rejected by the service with messageKey bank_account.invalid_customer_details and a message naming the offending item, for example "changes[0].reason: reason is required", "changes[0]: must contain exactly one category", "changes[1]: contains a duplicate address change", or a field rule such as "changes[0].accountHolderFirstName: max_length_exceeded". An account with no bank provider behind it is rejected with messageKey bank_account.do_not_allow_on_different_type_issuer_or_platform_bank_account_or_deposit_bank_account.
Unauthorized. The bearer token is missing, expired or invalid.
Forbidden. The account belongs to another company. The messageKey is bank_account.do_not_allow_on_different_type_issuer_or_platform_bank_account_or_deposit_bank_account, the same key used for an ineligible account on a 400, so use the status code to tell the two apart.
Bank account not found, with messageKey bank_account.bank_account_not_found.
Internal server error
The bank provider rejected the customer-details update.