Este documento detalha o formato e as regras para os arquivos CSV utilizados no processo de liquidação de pagamentos.
#📁 Arquivo de Envio (Input)
O arquivo de envio contém os itens de liquidação a serem processados. Cada linha representa uma instrução de pagamento para um item específico.
#Formato Geral
Codificação:
UTF-8Delimitador de Colunas: Ponto e vírgula (
;)Cabeçalho: O arquivo não deve conter uma linha de cabeçalho. O processamento inicia diretamente na primeira linha.
#Estrutura das Colunas
Nome do Campo | Tipo | Obrigatório | Descrição e Regras de Validação |
|---|---|---|---|
| UUID | Sim | • Deverá ser um uuid válido e atribuído a um pagamento existente. |
| String (ISO 8601) | Sim | • Deve estar no formato de data e hora ISO 8601 (ex: |
| String (1-100 chars) | Não | • Conterá o motivo da confirmação. Se preenchido, deve ter entre 1 e 100 caracteres. |
#Exemplo de Conteúdo
4a17e128-459c-4b3e-9407-3f39d73c7344;2025-09-10T15:30:00;Pagamento confirmado via sistema X
f8c3de3d-1fea-4d7c-a8b0-29d5a3c0db8a;2025-09-11T09:00:00;
c2a7e134-460d-4c4f-9517-4f49e74d7455;2025-09-12T11:20:00;Pago#↩️ Arquivo de Retorno (Output)
Para cada arquivo de envio processado, um arquivo de retorno é gerado. Ele espelha as linhas do arquivo de entrada, adicionando uma coluna para indicar o status do processamento (sucesso ou erro) de cada linha.
#Formato Geral
Nome do Arquivo: Será o nome original do arquivo de envio, com o sufixo
_RET.csv.Delimitador de Colunas: Ponto e vírgula (
;)Cabeçalho: O arquivo não contém uma linha de cabeçalho.
#Estrutura das Colunas
Nome do Campo | Tipo | Descrição |
|---|---|---|
| UUID | Mesmo id da linha de envio. |
| String (ISO 8601) | A mesma data de pagamento fornecida na linha correspondente do arquivo de envio. |
| String | • Fica em branco ( |
#Exemplo de Conteúdo
Supondo que um arquivo de envio continha um item_id que não foi encontrado e outro com formato de UUID inválido:
4a17e128-459c-4b3e-9407-3f39d73c7344;2025-09-10T15:30:00;""
f8c3de3d-1fea-4d7c-a8b0-29d5a3c0db8a;2025-09-11T09:00:00;"f8c3de3d-1fea-4d7c-a8b0-29d5a3c0db8a not found"
id-invalido;2025-09-12T11:20:00;"id-invalido invalid id format"
