Order Virtual Accounts

Use this endpoint to order Virtual Accounts.

You can order three different types of Virtual Accounts:

• Reconciliation
• POBO
• COBO

The defaultPhysicalAccountId property is the id of the Master Account you wish to use as the default currency. If you have multiple Master Accounts, this property is mandatory. Otherwise, the order defaults to the single available Master Account.

The optional physicalAccountsList property is available if you do not wish to link your Virtual Accounts for all your Master Account currencies. When the system creates the Virtual Accounts for your order, it will only create them for the Master Account ids you provide in this list.

You can order POBO and COBO accounts with or without customer details. If you decide to order POBO or COBO accounts without customer details, customer details can be added later using the POST/api/v1/virtualAccounts/update endpoint. The Reconciliation account type is only available without customer details.

In the order request body, you can provide the customerDetailsList property, which is an array able to contain customer detail items. The number of customer detail items you provide must equal the orderedAmount. Use the form below to generate an example of a request body with the customer details.

When adding customer details, the following characters are allowed:

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)

The endpoint response is an orderId that you can use to retrieve the order information and status.

📘

Limit on the number of Virtual Accounts per order.

There is a limit of 1,000 Virtual Accounts per request for orders and updates, including customer details. Orders WITHOUT customer details are limited to 2,500 Virtual Accounts per request.

📘

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

Error codes and descriptions