Antecipações
Como antecipar recebíveis e receber seus valores antes do prazo
O que são Antecipações?
Antecipação é o processo de receber valores de recebíveis futuros antes da data de liquidação original. Ao antecipar, uma taxa de desconto é aplicada e o valor líquido é creditado imediatamente na sua carteira.
Fluxo de Antecipação
Simule a antecipação
Envie os IDs dos recebíveis que deseja antecipar para visualizar taxas e valor líquido antes de confirmar.
Solicite a antecipação
Confirme a solicitação com o tipo de antecipação e os recebíveis selecionados.
Aguarde a aprovação
A antecipação é analisada e aprovada automaticamente ou pela equipe SoarLabz.
Receba o valor
Após aprovação e processamento, o valor líquido é creditado na sua carteira.
Tipos de Antecipação
| Tipo | Descrição |
|---|---|
spot | Antecipação pontual de recebíveis selecionados manualmente |
batch | Antecipação em lote de múltiplos recebíveis |
automatic | Antecipação automática configurada pelo sistema |
Simulando uma Antecipação
Antes de solicitar, simule para ver os valores:
curl -X POST https://api.payhubrasil.com.br/v1/anticipations/simulate \
-H "Authorization: Basic {credentials}" \
-H "Content-Type: application/json" \
-d '{
"receivable_ids": [
"550e8400-e29b-41d4-a716-446655440001",
"550e8400-e29b-41d4-a716-446655440002"
]
}'const response = await fetch('https://api.payhubrasil.com.br/v1/anticipations/simulate', {
method: 'POST',
headers: {
'Authorization': `Basic ${credentials}`,
'Content-Type': 'application/json',
},
body: JSON.stringify
O campo receivable_ids é opcional. Quando omitido em antecipações do tipo automatic, o sistema seleciona os recebíveis elegíveis automaticamente.
Resposta da Simulação
{
"data": {
"total_gross_amount": 20000,
"total_fee_amount": 600,
"total_net_amount": 19400,
"receivable_count": 2
}
}| Campo | Descrição |
|---|---|
total_gross_amount | Valor bruto total dos recebíveis selecionados |
total_fee_amount | Taxa total de antecipação |
total_net_amount | Valor líquido que será creditado |
receivable_count | Quantidade de recebíveis na simulação |
Solicitando uma Antecipação
Após confirmar os valores da simulação, solicite a antecipação:
curl -X POST https://api.payhubrasil.com.br/v1/anticipations \
-H "Authorization: Basic {credentials}" \
-H "Content-Type: application/json" \
-d '{
"anticipation_type": "spot",
"receivable_ids": [
"550e8400-e29b-41d4-a716-446655440001",
"550e8400-e29b-41d4-a716-446655440002"
]
}'O campo receivable_ids é opcional. Para antecipações do tipo automatic, quando omitido, o sistema seleciona os recebíveis elegíveis automaticamente.
Status da Antecipação
| Status | Descrição |
|---|---|
pending | Solicitação criada, aguardando aprovação |
approved | Aprovada, aguardando processamento |
processing | Em processamento |
completed | Concluída, valor creditado na carteira |
rejected | Rejeitada |
canceled | Cancelada pelo solicitante |
Cancelando uma Antecipação
Antecipações com status pending podem ser canceladas:
curl -X DELETE https://api.payhubrasil.com.br/v1/anticipations/{id} \
-H "Authorization: Basic {credentials}"Apenas antecipações com status pending podem ser canceladas. Após a aprovação, o processo não pode ser revertido.
Resumo de Antecipações
curl -X GET https://api.payhubrasil.com.br/v1/anticipations/summary \
-H "Authorization: Basic {credentials}"Retorna o total antecipado e a distribuição por status.