Consulta de Valores e Recebíveis Elegíveis à Antecipação Pontual
Este endpoint é o ideal para que exibam em sua tela inicial ou em menus específicos de antecipação, os valores disponíveis para antecipação pontual, como por exemplo, para decidir se a funcionalidade deve ser exibida para determinada subconta e qual valor apresentar.
Para atender esse cenário, a Celcoin disponibiliza este endpoint, com ele você poderá consultar o valor total disponível para antecipação de uma subconta e a lista de recebíveis elegíveis, dentro da gestão de recebíveis e captura de transações de cartão da Subadquirência (AaaS) integrada ao seu BaaS.
O valor retornado já considera todas as regras definidas pelos times internos da Celcoin, como índices de chargeback, percentuais de "colchão" de segurança, prazos de liquidação aceitos e demais critérios de elegibilidade que não são divulgados em sua totalidade. Ou seja, o valor apresentado é o valor real que o cliente pode antecipar, sem necessidade de cálculos adicionais do seu lado.
A antecipação de recebíveis é liberada mediante aprovação da Celcoin, por políticas próprias, e não está disponível para todos os clientes. Consulte um especialista para melhor entendimento sobre o funcionamento.
ImportanteOs valores são atualizados diariamente, após cada antecipação realizada e também a qualquer momento, por critérios definidos pela Celcoin. Por isso, é importante consultar este endpoint sempre que for exibir valores ao cliente, garantindo que reflitam o que de fato pode ser antecipado e quais recebíveis estão passíveis de antecipação naquele momento.
Para utilizar este endpoint, clique aqui.
Modelo de requisição
curl --location 'https://sandbox-apicorp.celcoin.com.br/baas/v1/cash/companies/481701480/receivables/list' \
--header 'Authorization: Bearer TOKEN'Parâmetros
| Nome | Origem | Tipo | Obrigatório | Descrição |
|---|---|---|---|---|
numberAccount | path | string | Sim | Número da subconta a ser consultada. Os dados retornados são exclusivamente da subconta informada. |
Modelo de response
{
"antecipation": {
"antecipationLimit": 900000,
"futureBalance": 100000
},
"transactions": [
{
"idRelease": 1,
"idTransaction": 1234,
"amount": 1000,
"expectedSettlementDate": "2026-08-01T00:00:00",
"daysToSettlement": 180,
"createdAt":"2026-09-21T18:54:21",
"taxAntecipation":0.09,
"antecipatedValue":4.83
},
{
"idRelease": 2,
"idTransaction":7654,
"amount": 1000,
"expectedSettlementDate": "2026-08-01T00:00:00",
"createdAt": "2026-01-01T00:00:00",
"taxAntecipation":0.09,
"antecipatedValue":4.83
}
],
"totalTransaction": 2,
"perPage": 50,
"page": 1
}Campos do response
| Objeto | Campo | Tipo | Descrição |
|---|---|---|---|
| antecipation | antecipationLimit | number | Valor total disponível para antecipação pela subconta. Calculado a cada requisição, já considerando todas as regras internas de elegibilidade da Celcoin. |
| antecipation | futureBalance | number | Soma de todas as releases ainda não liquidadas (agenda futura de recebíveis da subconta). Calculado a cada requisição. |
| transactions | idRelease | number | Identificador do recebível. A release. |
| transactions | idTransaction | number | Id da transação na qual a release pertence. |
| transactions | amount | number | Valor do recebível. |
| transactions | expectedSettlementDate | string | Data prevista de liquidação do recebível. |
| transactions | daysToSettlement | number | Quantidade de dias até a liquidação prevista. |
| transactions | createdAt | string | Data de criação da release. |
| transactions | taxAntecipation | number | Valor cobrado da antecipação baseado na taxa. |
| transactions | antecipatedValue | number | Valor liquido antecipado desconsiderando as taxas. |
Regras de retorno
- A lista de
transactionscontém as releases da conta consultada, e é retornada mesmo quando oantecipationLimitfor igual a zero (ou inferior). - Quando a subconta não possui valores a receber ou não se enquadra nos critérios de elegibilidade definidos pela Celcoin, os campos são retornados zerados, a estrutura da resposta é sempre a mesma.
- Os critérios de elegibilidade da subconta e de cada recebível são definidos e mantidos pela Celcoin, e podem ser alterados sem aviso prévio.
Próximos passos
Após consultar os valores e recebíveis elegíveis, a contratação da antecipação pontual segue o fluxo de simulação da antecipação.
Updated 17 days ago