Saltar para o conteúdo principal
POST
Criar tipo de recibo
Cria um tipo de recibo personalizado para o inquilino com um JSON Schema para validação de payload. Tipos definidos pela plataforma (payment_receipt, security_event_receipt, delivery_receipt, compliance_receipt, custom_receipt) são somente leitura e não podem ser substituídos ou alterados. Tipos personalizados são isolados para o inquilino autenticado por segurança em nível de linha. Outros inquilinos não podem ver ou usar seus tipos personalizados.

Corpo da solicitação

Requisitos de Esquema

O campo schema deve ser um JSON Schema válido (rascunho 2020-12). Inclua um array required para impor campos de payload obrigatórios ao cunhar.

Versionamento

Crie várias versões do mesmo tipo passando diferentes valores de version (1.0.0, 2.0.0, etc.). Os recibos sempre fixam a versão no momento da cunhagem, então os recibos existentes não são afetados quando você introduz uma nova versão. Para depreciar uma versão antiga, use PATCH /v1/receipt-types/{name} com {"status": "deprecated"}.

Respostas

Autorizações

X-API-Key
string
header
obrigatório

Chave de API para autenticação máquina a máquina

Corpo

application/json
display_name
string
obrigatório

Nome legível por humanos

name
string
obrigatório

Nome do tipo de recibo legível por máquina

schema
any
obrigatório

JSON Schema para validação de carga útil

description
string | null
version
string

Resposta

Tipo de recibo criado

name
string
display_name
string
schema
object
created_at
string