LYNX
DocsCartão (recebimento)Antecipar recebíveis
1 min de leitura

Antecipar recebíveis

POST/v1/card/anticipate

Antecipa (recebe agora) recebíveis ainda agendados, mediante uma taxa de antecipação que incide sobre o valor bruto do recebível. O líquido antecipado cai no saldo na hora.

Permissão necessária: CARD:ANTICIPATE

Boas práticas

  • creditedAmountCents já é o valor líquido creditado (bruto − taxa de antecipação).

Requisição

bash
curl -X POST https://lynxpix.cc/api/v1/card/anticipate \
  -H "Authorization: Bearer lynx_test_sua_chave" \
  -H "Content-Type: application/json" \
  -d '[{"name":"receivableIds","type":"array","desc":"IDs específicos de recebíveis a antecipar. Se omitido, antecipa todos os agendados."},{"name":"maxInstallments","type":"integer","desc":"Limita a quantidade de parcelas antecipadas (das mais próximas)."}]'

Resposta

json
{
  "data": {
    "anticipated": true,
    "installments": 2,
    "grossAmountCents": 21380,
    "feeAmountCents": 1916,
    "creditedAmountCents": 19125
  },
  "error": null
}