Skip to main content
POST
Criar operação de borderô

Authorizations

Authorization
string
header
required

Chave de API do workspace (prefixo slhk_), enviada no header: Authorization: Bearer slhk_sua_chave_aqui

Headers

Idempotency-Key
string

Opcional. Presente: reenviar a mesma key com o mesmo payload devolve a resposta original (HTTP 200), sem nova operação nem nova cobrança; a mesma key com payload diferente devolve 409 idempotency_conflict. Ausente: cada POST cria uma operação nova.

x-request-id
string

Identificador de rastreio opcional fornecido pelo cliente. Ecoado no header da resposta (nunca no body).

Body

multipart/form-data
file
file
required

Arquivo CNAB 400 remessa (.REM) — Banco Paulista 611, 444 colunas, Windows-1252. Obrigatório. Máximo de 16 MB.

cedente_cnpj
string
required

CNPJ do cedente, 14 dígitos ou formatado. Obrigatório; o dígito verificador é validado.

Example:

"12345678000195"

xmls
file

ZIP com os XMLs de NFe (nfeProc) dos títulos, para validação cruzada. Opcional. Máximo de 32 MB.

engine_id
string

ID da engine de borderô a usar. Omitido ou "template-padrao": usa a engine template do sistema. Engine não utilizável retorna 422 no_engine.

Example:

"template-padrao"

purpose
string

Finalidade da análise (auditoria LGPD). Opcional.

Base legal LGPD para os sacados PF. Opcional.

Response

Replay idempotente: mesma Idempotency-Key + mesmo payload. Corpo idêntico ao da resposta 202 original; nenhum token adicional é cobrado.

operation_id
string<uuid>
required

UUID da operação criada. Use no GET /operations/{id} e no GET /operations/{id}/result.

status
enum<string>
required

Sempre queued imediatamente após a criação.

Available options:
queued
created_at
string<date-time>
required

Timestamp ISO 8601 de criação.