Zum Hauptinhalt springen
POST
Belegtyp erstellen
Erstellt einen mandanten-spezifischen Belegtyp mit einem JSON-Schema zur Nutzlastvalidierung. Plattformdefinierte Typen (payment_receipt, security_event_receipt, delivery_receipt, compliance_receipt, custom_receipt) sind schreibgeschützt und können nicht überschrieben oder ersetzt werden. Benutzerdefinierte Typen sind durch zeilenbasierte Sicherheit auf den authentifizierten Mandanten isoliert. Andere Mandanten können Ihre benutzerdefinierten Typen nicht sehen oder verwenden.

Anfragetext

Schema-Anforderungen

Das Feld schema muss ein gültiges JSON-Schema (Entwurf 2020-12) sein. Fügen Sie ein required-Array hinzu, um obligatorische Payload-Felder beim Minting zu erzwingen.

Versionierung

Erstellen Sie mehrere Versionen desselben Typs, indem Sie verschiedene version-Werte (1.0.0, 2.0.0 usw.) übergeben. Belege fixieren immer die Version zum Zeitpunkt der Prägung, sodass bestehende Belege unberührt bleiben, wenn Sie eine neue Version einführen. Um eine alte Version zu verwerfen, verwenden Sie PATCH /v1/receipt-types/{name} mit {"status": "deprecated"}.

Antworten

Autorisierungen

X-API-Key
string
header
erforderlich

API-Schlüssel für die Maschine-zu-Maschine-Authentifizierung

Body

application/json
display_name
string
erforderlich

Menschenlesbarer Name

name
string
erforderlich

Maschinenlesbarer Belegtypname

schema
any
erforderlich

JSON-Schema für die Payload-Validierung

description
string | null
version
string

Antwort

Belegtyp erstellt

name
string
display_name
string
schema
object
created_at
string