Skip to main content
POST
Submit an operator fixed-width layout template

Autorizaciones

Authorization
string
header
requerido

Bearer token authentication (format: "Bearer {token}")

Cuerpo

application/json
discriminatorLength
integer<int64>
requerido

Discriminator width in bytes

Rango requerido: x >= 1
Ejemplo:

1

discriminatorStart
integer<int64>
requerido

Zero-based byte offset of the record-type discriminator

Rango requerido: x >= 0
Ejemplo:

0

family
string
requerido

Format family the template namespaces under

Minimum string length: 1
Ejemplo:

"cnab400"

records
object[] | null
requerido

Record types declared by the layout

Minimum array length: 1
region
string
requerido

ISO alpha-2 region (uppercased) or XX

Minimum string length: 1
Ejemplo:

"BR"

variant
string
requerido

Operator/brand variant axis

Minimum string length: 1
Ejemplo:

"acme-cobranca"

requiredFields
string[] | null

Field names the variant must declare

Respuesta

Created

createdAt
string<date-time>
requerido

Creation timestamp (RFC 3339, UTC)

Ejemplo:

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

discriminator
object
requerido

Record-type discriminator byte range the parser reads to select a record type

formatKey
string
requerido

Canonical format descriptor key (region/family/variant) the template registers under

Ejemplo:

"br/cnab400/acme-cobranca"

id
string<uuid>
requerido

Template identifier

Ejemplo:

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

recordTypeCount
integer<int64>
requerido

Number of record types the layout declares

Ejemplo:

1

recordWidths
object
requerido

Per-record-type fixed width in bytes, keyed by record type

records
object[] | null
requerido

Record types the layout declares, each with its fixed width and ordered byte-range fields, sorted by record type

requiredFields
string[] | null
requerido

Field names the variant must declare across its record types

variantKey
string
requerido

In-file variant key the layout is keyed by

Ejemplo:

"acme-cobranca"