Skip to main content
POST
/
v1
/
receipts
/
{id}
/
revoke
Revoke receipt
curl --request POST \
  --url https://api.truthlocks.com/v1/receipts/{id}/revoke \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "reason": "<string>"
}
'
{
  "receipt_id": "<string>",
  "status": "<string>",
  "revoked_at": "<string>"
}
Revokes a receipt event. Sets the status to revoked and records a RECEIPT_REVOKE event in the transparency log. Only active receipts can be revoked.

​
Path parameters

​
id
string
required
UUID of the receipt to revoke.

​
Headers

​
Idempotency-Key
string
required
UUID for idempotent revocation. Prevents duplicate revocation events.

​
Response

​
receipt_id
string
UUID of the revoked receipt.
​
status
string
revoked
​
revoked_at
string
ISO 8601 timestamp of revocation.

​
Webhook event

A receipt.revoked webhook event is delivered after successful revocation: 
{
  "event_type": "receipt.revoked",
  "receipt_id": "<uuid>",
  "receipt_type": "payment_receipt",
  "tenant_id": "<uuid>",
  "revoked_at": "<RFC3339>"
}
Revocation is permanent and recorded in the transparency log.

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Path Parameters

​
id
string
required

Receipt UUID

Body

application/json
​
reason
string
required

Revocation reason

Response

Receipt revoked

​
receipt_id
string
​
status
string
​
revoked_at
string