Pular para o conteúdo principal
POST
Fazer upload de arquivo de transações

Autorizações

Authorization
string
header
obrigatório

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

Cabeçalhos

X-Request-Id
string

A unique identifier for tracing the request across services.

X-Idempotency-Key
string

Chave de idempotência opcional para novas tentativas seguras. Também aceita Idempotency-Key como nome alternativo do cabeçalho. Se a mesma chave for enviada novamente e a requisição original já tiver sido processada, a resposta em cache é retornada com X-Idempotency-Replayed: true.

Consulte Novas tentativas e idempotência para mais detalhes.

Parâmetros de caminho

contextId
string
obrigatório

The unique identifier of the reconciliation context.

sourceId
string
obrigatório

The unique identifier of the reconciliation source.

Corpo

multipart/form-data
file
file
obrigatório

Arquivo de transações (CSV, JSON ou XML)

format
enum<string>
obrigatório

Formato do arquivo

Opções disponíveis:
csv,
json,
xml

Resposta

Indica que a requisição foi aceita para processamento.

A resposta inclui o cabeçalho X-Idempotency-Replayed.

Se o valor for false, a requisição acabou de ser processada. Se o valor for true, a resposta é uma repetição de uma requisição processada anteriormente.

Consulte Retries and idempotency para mais detalhes.

Detalhes da tarefa de importação

completedAt
string

Quando a tarefa foi concluída no formato RFC3339 (se concluída)

Exemplo:

"2025-01-15T10:35:00.000Z"

contextId
string

ID do contexto ao qual esta tarefa pertence

Exemplo:

"019c96a0-10a0-72d2-9fb0-2b7de8093182"

createdAt
string

Timestamp de criação no formato RFC3339

Exemplo:

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

failedRows
integer

Número de linhas que falharam no processamento

Intervalo obrigatório: x >= 0
Exemplo:

5

fileName
string

Nome original do arquivo

Exemplo:

"transactions_2024.csv"

id
string

Identificador único da tarefa

Exemplo:

"019c96a0-10ce-75fc-a273-dc799079a99c"

sourceId
string

ID da fonte na qual esta tarefa importa dados

Exemplo:

"019c96a0-108c-7a74-8e31-3789daffe1ed"

startedAt
string

Quando a tarefa foi iniciada no formato RFC3339 (null para tarefas em fila)

Exemplo:

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

status
enum<string>

Status atual da tarefa

Opções disponíveis:
QUEUED,
PROCESSING,
COMPLETED,
FAILED
Exemplo:

"PROCESSING"

totalRows
integer

Número total de linhas no arquivo

Intervalo obrigatório: x >= 0
Exemplo:

1000