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. The endpoint only accepts updates for Virtual Account numbers without customer details assigned. It is not possible to use the endpoint to update existing customer details.
The endpoint only accepts CSV files as body content. You may leave optional fields empty, but they cannot be skipped if they are followed by fields with content. Headers cannot be skipped, neither the optional nor the mandatory ones. Each Virtual Account and its associated customer details must be on separate rows.
The table below specifies the content and format of the file. It is mandatory to put headers in the first row of the file. 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)
| Field (*mandatory) | Header | Description |
|---|---|---|
| 1* | CompanyNumber | Company number of the company owning the accounts. Example: 000012345 (always 9 digits) |
| 2* | VirtualAccountNumber | The Virtual Account number the customer details get assigned to. Example: 0099876543 (always 10 digits) |
| 3 | CustomerIdentifier | Specifies your end customer identification in your systems. Maximum 35 characters. |
| 4* | CustomerType | P or C (Private or Company) |
| 5* | Name | Maximum 35 characters. |
| 6* | Address1 | Maximum 35 characters. |
| 7* | Address2 | Maximum 35 characters. |
| 8* | Address3 | This is reserved for country code following the ISO-2 Alpha-2 standard. For example, 'US' is for the United States, and 'GB' is for the United Kingdom. This standard uses two-letter country codes found here. |
| 9* | UBOfirstname1 | Maximum 35 characters. |
| 10* | UBOlastname1 | Maximum 35 characters. |
| 11 | UBOfirstname2 | Maximum 35 characters. |
| 12 | UBOlastname2 | Maximum 35 characters. |
| 13 | UBOfirstname3 | Maximum 35 characters. |
| 14 | UBOlastname3 | Maximum 35 characters. |
| 15 | UBOfirstname4 | Maximum 35 characters. |
| 16 | UBOlastname4 | Maximum 35 characters. |
| 17 | UBOfirstname5 | Maximum 35 characters. |
| 18 | UBOlastname5 | Maximum 35 characters. |
Limit of number of Virtual Accounts per update
There is a limit of 1,000 Virtual Accounts in an update file request.
Error codes and descriptions
| Error code & error message | Additional descriptions |
|---|---|
| File The file field is required. | The upload file is missing. |
| CsvFileException File with customer details to update is empty. | |
| UpdateCustomerDetailsErrors File with customer details to update is empty. | The upload file contains only headers. |
| CsvFileException Csv file does not contain headers or they are incorrect | |
| UpdateCustomerDetailsErrors The maximum allowed number of virtual accounts per request is 1000 | |
| UpdateCustomerDetailsErrors Empty mandatory field | One or more mandatory fields are empty. The rowNumber + propertyName in the error body shows the fields in question. |
| UpdateCustomerDetailsErrors The company number has to be exactly 9 digits | |
| UpdateCustomerDetailsErrors Virtual account number has to be only digits | |
| UpdateCustomerDetailsErrors Characters not allowed | The field described in the response body contains invalid characters. |
| UpdateCustomerDetailsErrors Exceeding field length of 35 characters | The field described in the response body contains more than 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 file is of reconciliation type. |