Android SDK vault manager: deleteVaultedPaymentMethod

Delete a vaulted payment method for the customerId attached to the client session by id. You can get the id from any instance of PrimerVaultedPaymentMethod returned by fetchVaultedPaymentMethods.

KOTLIN

suspend fun deleteVaultedPaymentMethod(vaultedPaymentMethodId: String): Result<Unit>

Parameters

Hide Parameters

vaultedPaymentMethodId

String

required

The id of a PrimerVaultedPaymentMethod previously retrieved with fetchVaultedPaymentMethods.

Returns

The deleteVaultedPaymentMethod method performs the deletion of vaulted payment method and returns a result object of type Result. The Result class represents the outcome of the operation, indicating success or failure. By inspecting the returned Result object, you can determine the success or failure of the deletion of the vaulted payment method. This allows you to handle different scenarios based on the result.

Hide Results

success

In case of successful operation result, SDK will return Unit.

failure

In case of unsuccessful operation result, as part of Result object SDK will return:

Hide Exceptions

InvalidVaultedPaymentMethodIdException

In case the id passed does not match any payment method previously retrieved by fetchVaultedPaymentMethods.

VaultManagerDeleteException

If an error occurs while deleting the vaulted payment method.

IOException

if an I/O error occurs during the API request.

Example

Refer to the following example for fetching vaulted payment methods.

KOTLIN

private fun deleteVaultedPaymentMethod(vaultedPaymentMethodId: String) {
  // 👇 delete vaulted payment method by calling suspend function within the scope
  scope.launch {
    vaultManager.deleteVaultedPaymentMethod(vaultedPaymentMethodId).onSuccess {
      // display success message to the user, remove vaulted payment method from the list...
    }.onFailure { throwable ->
      // handle error
    }
  }
}

Web SDK (v2.x.x)

iOS SDK (v2.x.x)

Android SDK (v2.x.x)

deleteVaultedPaymentMethod

Parameters

Returns

Example

​Parameters

​Returns

​Example

Parameters

Returns

Example