v1

latestOpenAPI 3.0.02026-07-2414022.3 KB
Vault

DeleteVault

DeleteVaultRequest

The DeleteVaultRequest allows a merchant to permanently delete a previously stored credit card token from PayVault. This is typically used when a customer requests the removal of their saved card, or when data retention policies require the clearing of stored payment details.

Only the VaultId (the token) is required — no card number or expiry date needs to be supplied.

Once deleted, the VaultId becomes invalid and cannot be used in future transactions.


Common Use Cases

  • Customer removes saved card from their profile

  • Merchant performs a cleanup of unused or expired VaultIds

  • Compliance with data retention or privacy regulations (e.g. GDPR, POPIA)


Request Requirements

  • A valid PayGate PayGateId and Password

  • A VaultId previously generated via CardVaultRequest

⚠️ Irreversible Action: Once a VaultId is deleted, it cannot be restored.

Runtime endpoint: POST https://secure.paygate.co.za/payhost/process.trans

post/payhost/delete-vault

Headers

Content-Typestring required
Example:text/xml

SOAP requests in this collection use text/xml.

SOAPActionstring
Example:SingleVaultRequest

SOAPAction value captured from the source Postman collection.

Response

SOAP response returned by PayHost.