UserRevoke a user's Google Wallet pass

Revoke a user's Google Wallet pass

Expires every saved Google Wallet object of the user's Google wallet key and clears the key it presents at a lock; the Google wallet worker serves the key no pass again. Only an API key may call it: a partner for its own org's keys, a super key for any key.

curl -X POST "https://api.spkey.co/users/example_string/wallet/revoke" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "keyId": "example_string"
}'
{
  "keyId": "example_string",
  "walletType": "GOOGLE",
  "revokedAt": "example_string",
  "revoked": 42,
  "notSaved": 42
}
POST
/users/{id}/wallet/revoke
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
Content-Typestring
Required

The media type of the request body

Options: application/json
keyIdstring
Required

The Google wallet key whose pass is revoked

Min length: 1
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

Body

application/json
keyIdstring
Required

The Google wallet key whose pass is revoked

Responses

keyIdstring
Required
walletTypestring
Required
Allowed values:GOOGLE
revokedAtstring
Required

When the key's pass was first revoked

revokedinteger
Required

Google Wallet objects a person holds, now expired with the key cleared

notSavedinteger
Required

Objects of the key no one holds, expired too: a never-saved one is created expired so that none can be saved active