Skip to main content
POST
Enviar um template de layout de largura fixa do operador

Autorizações

Authorization
string
header
obrigatório

Autenticação por Bearer token (formato: "Bearer {token}")

Corpo

application/json
discriminatorLength
integer<int64>
obrigatório

Largura do discriminador em bytes

Intervalo obrigatório: x >= 1
Exemplo:

1

discriminatorStart
integer<int64>
obrigatório

Deslocamento de byte (base zero) do discriminador de tipo de registro

Intervalo obrigatório: x >= 0
Exemplo:

0

family
string
obrigatório

Família de formato sob a qual o template é agrupado por namespace

Minimum string length: 1
Exemplo:

"cnab400"

records
object[] | null
obrigatório

Tipos de registro declarados pelo layout

Minimum array length: 1
region
string
obrigatório

Região ISO alpha-2 (em maiúsculas) ou XX

Minimum string length: 1
Exemplo:

"BR"

variant
string
obrigatório

Eixo de variante de operador/marca

Minimum string length: 1
Exemplo:

"acme-cobranca"

requiredFields
string[] | null

Nomes de campo que a variante deve declarar

Resposta

Criado

createdAt
string<date-time>
obrigatório

Timestamp de criação (RFC 3339, UTC)

Exemplo:

"2025-01-15T10:30:00Z"

discriminator
object
obrigatório

Intervalo de bytes do discriminador de tipo de registro que o parser lê para selecionar um tipo de registro

formatKey
string
obrigatório

Chave canônica de descritor de formato (região/família/variante) sob a qual o template é registrado

Exemplo:

"br/cnab400/acme-cobranca"

id
string<uuid>
obrigatório

Identificador do template

Exemplo:

"550e8400-e29b-41d4-a716-446655440000"

recordTypeCount
integer<int64>
obrigatório

Número de tipos de registro que o layout declara

Exemplo:

1

recordWidths
object
obrigatório

Largura fixa em bytes por tipo de registro, chaveada por tipo de registro

records
object[] | null
obrigatório

Tipos de registro que o layout declara, cada um com sua largura fixa e campos de intervalo de bytes ordenados, ordenados por tipo de registro

requiredFields
string[] | null
obrigatório

Nomes de campo que a variante deve declarar em seus tipos de registro

variantKey
string
obrigatório

Chave de variante no arquivo pela qual o layout é chaveado

Exemplo:

"acme-cobranca"