Adicionar Depósito
Segundo passo do fluxo. Inclui um colaborador e o valor do benefício ao pedido. Repita para cada combinação de colaborador + benefício.
Não é possível adicionar dois depósitos do mesmo benefício para o mesmo colaborador no mesmo pedido. Se precisar corrigir, cancele o depósito e adicione novamente.
POST /benefits/v1/orders/{orderId}/deposits
Campos obrigatórios:
| Campo | Descrição |
|---|---|
employeeId | ID do colaborador |
employeeName | Nome do colaborador |
employeeDocument | CPF do colaborador (só números) |
benefitId | ID do benefício (obtido em Listar Benefícios) |
benefitName | Nome do benefício |
amount | Valor em centavos — mínimo R$ 2,00 = 200 |
Valores em centavos: R$ 500,00 →
50000· R$ 150,00 →15000
Campo opcional:
| Campo | Descrição |
|---|---|
creditDate | Data de crédito específica para este depósito. Se omitida, usa a data definida na confirmação do pedido. Deve ser futura e dentro de 6 meses. |
Resposta (201):
| Campo | Descrição |
|---|---|
id | Guarde este valor — é o depositId para um possível cancelamento |
orderId | ID do pedido ao qual o depósito foi adicionado |
employeeName | Nome do colaborador |
benefitName | Nome do benefício |
amount | Valor do depósito em centavos |
fee | Taxa calculada automaticamente em centavos |
status | Sempre created ao adicionar |
Erros comuns
| Código | Causa |
|---|---|
400 | Campo obrigatório ausente ou amount abaixo de R$ 2,00 |
400 | Benefício inativo ou de outra empresa |
404 | Pedido ou benefício não encontrado |
409 | Já existe depósito para este colaborador + benefício neste pedido |
422 | Pedido não aceita mais depósitos (já faturado) |
Próximo passo: Confirmar Pedido →