This endpoint is only available for Virtual Accounts of types POBO and COBO.
You can update one or more existing Virtual Accounts and uniquely assign them to your underlying customer. Use the endpoint to provide the required customer and Ultimate Beneficial Owner (UBO) details.
The customerDetailsList property accepts an array of 1 to 1,000 Virtual Account numbers and customer details.
The endpoint only accepts update requests for Virtual Account numbers without customer details assigned. It is not possible to use the endpoint to update existing customer details.
All the customer detail parameters, except customerType, accept a string of up to 35 characters. The allowed characters are:
a b c d e f g h i j k l m n o p q r s t u v w x y z
A B C D E F G H I J K L M N O P Q R S T U V W X Y Z
0 1 2 3 4 5 6 7 8 9
/ - ? : ( ) . ' +
Space (except leading spaces)
Address field 3 - Country code, ISO-2/Alpha-2 standard.
In this field, we require the country code to be present using the ISO-2 Alpha-2 standard. This standard uses two-letter country codes. For example,
'US' for the United States and 'GB' for the United Kingdom. Please use the correct
country code per the ISO-2 Alpha-2 standard. Please find all country codes here
Limit of number of Virtual Accounts per update
There is a limit of 1,000 Virtual Accounts in an update request.
Error codes and descriptions
| Error code & error message | Additional descriptions |
|---|---|
| ExceedsAllowedAmountException The maximum allowed number of virtual accounts per request is 1000 | |
| CompanyNumber The company number has to be exactly 9 digits | |
| CustomerDetailsList[X].VirtualAccountNumber Virtual account number has to be only digits | Element number X in the customer details array contains an invalid virtual account number. |
| UpdateCustomerDetailsErrors Characters not allowed | Element number X of the customer details array field Y contains invalid characters. |
| CustomerDetailsList[X].CustomerDetails.Y Exceeding field length of 35 characters | Element number X of the customer details array field Y contains more than the allowed 35 characters. |
| DuplicateVirtualAccountException There is a duplicate virtual account number. | |
| ExistingCustomerDetailsException Customer details already exist for this virtual account: | |
| NoCustomerDetailsForReconciliationOrderException Customer details cannot be saved for reconciliation virtual account type | At least one of the virtual accounts in the request is of reconciliation type. |
| CustomerDetailsList[X].CustomerDetails The CustomerDetails field is required. | The CustomerDetails element is missing from element number X in the customer details array. |
| CustomerDetailsList[X].CustomerDetails.Y Empty mandatory field | In element number X of the customer details array field Y is an empty mandatory field. |