Skip to main content
Creates a tenant-custom receipt type with a JSON Schema for payload validation. Platform-defined types (payment_receipt, security_event_receipt, etc.) cannot be overridden.

Schema Requirements

The schema field must be a valid JSON Schema (draft 2020-12). Include a required array to enforce mandatory payload fields.
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "required": ["invoice_number", "amount", "currency"],
  "properties": {
    "invoice_number": { "type": "string" },
    "amount":         { "type": "integer" },
    "currency":       { "type": "string", "minLength": 3, "maxLength": 3 }
  },
  "additionalProperties": false
}

Versioning

Create multiple versions of the same type by passing different version values (1.0.0, 2.0.0, etc.). Receipts always pin the version at mint time.