Vault Instruction Base

May 27, 2025 ยท View on GitHub

Basic vault instruction specification that can be extended by specific payment sources that supports vaulting.

Structure

VaultInstructionBase

Fields

NameTypeTagsDescriptionGetterSetter
StoreInVaultStoreInVaultInstructionOptionalDefines how and when the payment source gets vaulted.

Constraints: Minimum Length: 1, Maximum Length: 255, Pattern: ^[0-9A-Z_]+$
StoreInVaultInstruction getStoreInVault()setStoreInVault(StoreInVaultInstruction storeInVault)

Example (as JSON)

{
  "store_in_vault": "ON_SUCCESS"
}