Skip to main content

VirtualPaymentInstrument

Virtual Payment Instrument

idstring

Virtual instrument unique identifier.

Possible values: <= 50 characters

Example: acde070d-8c4c-4f0d-9d8a-162843c10333
instrumentTypeVirtualInstrumentType (string)required

Instrument type.

Possible values: [SEPA_BANK_ACCOUNT, UK_BANK_ACCOUNT, US_BANK_ACCOUNT, IBAN_BANK_ACCOUNT]

Example: IBAN_BANK_ACCOUNT
isPrimaryboolean

When true, this instrument is the primary one for its instrument type on the linked 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. The first active instrument of a type becomes primary when it is issued. After that the flag moves only when the set-primary operation is called, or when the current primary is closed and another active instrument of the same type takes over.

Example: true
statusstring

Instrument status.

Possible values: [ACTIVE]

VirtualPaymentInstrument
{
  "id": "acde070d-8c4c-4f0d-9d8a-162843c10333",
  "instrumentType": "IBAN_BANK_ACCOUNT",
  "isPrimary": true,
  "status": "ACTIVE"
}