API reference · Passes

Delete a revoked pass

POST/v1/passes/{serial}/eraseFreeSafe to retry with Idempotency-Key

Deletes a revoked pass's content and holder details now, rather than 30 days after it was revoked. Only its serial number is kept.

Path

serialstringrequired

The pass's serialNumber.

Answer

200Deleted

Deleting it again answers alreadyErased: true.

Errors

Every error has the same shape: see Errors.

Status	Code	When
404	`not_found`	No pass with that serial number in this workspace.
409	`pass_not_revoked`	Revoke it first, so holders' copies are voided.
409	`revoked_too_recently`	It was revoked less than 24 hours ago: phones need time to receive the voided copy.
409	`idempotency_conflict`	The Idempotency-Key was already used for a different request.

Request

curl -X POST "https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88/erase" \
  -H "Authorization: Bearer $WALLET_API_KEY"

const res = await fetch("https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88/erase", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.WALLET_API_KEY}`,
  },
});
const data = await res.json();

import os

import requests

res = requests.post(
    "https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88/erase",
    headers={"Authorization": f"Bearer {os.environ['WALLET_API_KEY']}"},
)
data = res.json()

<?php

$ch = curl_init("https://api.walletpassapi.com/v1/passes/9f904677-e06d-4b0f-8404-878ff1066f88/erase");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("WALLET_API_KEY"),
    ],
    CURLOPT_RETURNTRANSFER => true,
]);
$data = json_decode(curl_exec($ch), true);

200 Deleted

{
  "serialNumber": "9f904677-e06d-4b0f-8404-878ff1066f88",
  "erased": true,
  "alreadyErased": false
}