Skip to main content

Set Primary Virtual Instrument

PUT 
/v2/customers/:customerId/accounts/:accountId/virtual-instruments/:virtualInstrumentId/primary

Marks the virtual instrument as the primary one for its instrument type on the balance account. Payments that do not name an instrument use the primary instrument of the required type.

For each account and instrument type, exactly one active instrument is primary. Setting a new primary clears the previous primary of the same type on that account; instruments of other types keep their own primary. Setting the instrument that is already the primary succeeds and changes nothing.

Only an active instrument can be set as primary. A closed instrument is rejected with DW-VIRTUAL-INSTRUMENT-NOT-ACTIVE.

Request​

Responses​

OK. Returns the virtual instrument with the updated primary flag.