Skip to main content
GET
/
v1
/
receipt-types
/
{name}
curl "https://api.truthlocks.com/v1/receipt-types/payment_receipt" \
  -H "X-API-Key: tl_live_..."

{
  "id": "a1b2c3d4-0000-0000-0000-000000000001",
  "name": "payment_receipt",
  "display_name": "Payment Receipt",
  "version": "1.0.0",
  "status": "active",
  "description": "Payments, invoices, and refunds",
  "schema": {
    "type": "object",
    "required": ["amount", "currency", "provider", "provider_reference", "subject"],
    "properties": {
      "amount": { "type": "integer", "description": "Amount in smallest currency unit" },
      "currency": { "type": "string", "description": "ISO 4217 currency code" },
      "provider": { "type": "string", "description": "Payment provider name" },
      "provider_reference": { "type": "string", "description": "Provider transaction ID" },
      "subject": { "type": "string", "description": "Subject identifier" }
    }
  },
  "created_at": "2026-01-01T00:00:00Z"
}
Retrieves a single receipt type by name. Returns the full type definition including the JSON Schema used to validate the payload field when minting receipts of this type. To pin a specific version, append @<version> to the name — for example, payment_receipt@1.0.0.

​
Path parameters

​
name
string
required
Receipt type name. Examples: payment_receipt, security_event_receipt, custom_receipt. Append @<version> to pin a specific schema version (e.g. payment_receipt@1.0.0).

​
Responses

{
  "id": "a1b2c3d4-0000-0000-0000-000000000001",
  "name": "payment_receipt",
  "display_name": "Payment Receipt",
  "version": "1.0.0",
  "status": "active",
  "description": "Payments, invoices, and refunds",
  "schema": {
    "type": "object",
    "required": ["amount", "currency", "provider", "provider_reference", "subject"],
    "properties": {
      "amount": { "type": "integer", "description": "Amount in smallest currency unit" },
      "currency": { "type": "string", "description": "ISO 4217 currency code" },
      "provider": { "type": "string", "description": "Payment provider name" },
      "provider_reference": { "type": "string", "description": "Provider transaction ID" },
      "subject": { "type": "string", "description": "Subject identifier" }
    }
  },
  "created_at": "2026-01-01T00:00:00Z"
}

curl "https://api.truthlocks.com/v1/receipt-types/payment_receipt" \
  -H "X-API-Key: tl_live_..."