Vault Instruction

May 27, 2025 ยท View on GitHub

Base vaulting specification. The object can be extended for specific use cases within each payment_source that supports vaulting.

Structure

VaultInstruction

Fields

NameTypeTagsDescriptionGetterSetter
StoreInVaultStoreInVaultInstructionRequiredDefines 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"
}