Add currency (CSV)

This endpoint allows you to add new currencies to an existing Virtual Account by uploading a CSV file. This may be required when a Virtual Account was originally created with only a subset of the available Master Account currencies or additional Master Account currencies have since been added to your company.

You can also use the endpoint if you have companies in multiple regional entities with Master Account currencies that you want linked to a Virtual Account.

Please provide a comma-separated file (CSV) that follows the formatting shown in the example below. All headers are mandatory.

Example CSV

VirtualAccountNumber,CompanyNumber,CurrencyAccount,IsDefault
0000234567,000002345,0004344444,true
0000234567,000002345,0004344445,false

Use Cases

The endpoint supports two primary scenarios:

  1. Add new currencies to an existing regional entity
    You can link additional Master Account currencies from the same company.
  • Provide the Master Account numbers to be linked in the CurrencyAccount column.
  • Use the CompanyNumber of the company under which the Virtual Account currently exists.
  • If one of the new currencies should become the default currency of the Virtual Account, put true in the column IsDefault. Only one row per Virtual Account can have true is IsDefault. Put "false" in all rows if no change in default currency is required.
  1. Add new currencies for a new regional entity
    If your Virtual Account does not yet have a regional entity for a given company, you can create one by linking Master Account currencies from that company.
  • Provide the CompanyNumber of the new regional entity.
  • Specify the Master Account numbers in the CurrencyAccount column.
  • One of the Master Account currencies, must have true in the isDefault column.

Requirements

  • A Virtual Account can only have one open Master Account link per currency. A request with an already linked and open currency will return an error.
  • The Virtual Accounts being modified must have status active

After a successful request you can use the response property requestId in the GET Modification status endpoint to check the modification status.

Body Params
file
Responses

Language
Credentials
Bearer
LoadingLoading…
Response
Choose an example:
application/json