Confirmar lote de colaboradores

POST /api/v1/valepix/employees/batch/{batch_id}/commit

Confirma a criação dos colaboradores válidos de um lote processado.

Autenticação

Envie um API token ativo no header Authorization.

Authorization: Bearer <VALEPIX_API_TOKEN>
Accept: application/json
Content-Type: application/json

Path params

Parâmetro	Tipo	Obrigatório	Descrição
batch_id	string	Sim	Identificador do lote retornado no upload

Body

Campo	Tipo	Obrigatório	Descrição
benefit_id	string	Sim	Identificador retornado pela rota de benefícios

Antes de confirmar o lote, obtenha o benefit_id em Listar benefícios ou Criar benefício. Esse valor não deve ser informado manualmente fora da API.

Exemplo curl

curl --request POST \
  --header "Authorization: Bearer $VALEPIX_API_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --url "https://routes.valepix.com.br/api/v1/valepix/employees/batch/$BATCH_ID/commit" \
  --data '{
    "benefit_id": "<benefit_id_retornado_pela_rota_de_beneficios>"
  }'

Response

HTTP 200 OK.

{
  "success": "success",
  "data": {
    "success": true,
    "processed_count": 120
  }
}

Somente itens válidos são processados. errors_count aparece quando há linhas previamente inválidas ou falhas de processamento. Campos numéricos iguais a zero podem ser omitidos. Repetir o commit de um lote já concluído com o mesmo benefício mantém o resultado concluído.

Erros comuns

HTTP	Quando acontece	Ação recomendada
400	batch_id ou benefit_id inválido	Corrigir os identificadores enviados
401	Token ausente, inválido, expirado ou revogado	Conferir token
403	Token sem acesso ao recurso solicitado	Confirmar token com a ValePix
404	Lote não encontrado	Conferir batch_id
422	Lote em estado incompatível, limite operacional atingido ou processamento concorrente	Consultar o lote e tentar novamente conforme o estado retornado
429	Limite de chamadas excedido	Reduzir a frequência e aplicar backoff
500, 502, 503, 504	Falha temporária no commit	Consultar o lote antes de repetir e acionar suporte se persistir