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.

🚧

Importante

Os 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

NomeOrigemTipoObrigatórioDescrição
numberAccountpathstringSimNú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,
            "available": false,
            "status": "cancelled",
            "settlementDate": "2026-06-01T00:00:00",
            "expectedSettlementDate": "2026-08-01T00:00:00",
            "daysToSettlement": 180,
            "createdAt": "2026-01-01T00:00:00"
        },
        {
            "idRelease": 2,
	    "idTransaction":7654,
            "amount": 1000,
            "available": true,
            "status": "captured",
            "settlementDate": null,
            "expectedSettlementDate": "2026-08-01T00:00:00",
            "createdAt": "2026-01-01T00:00:00"
        }
    ],
    "totalTransaction": 2,
    "perPage": 50,
    "page": 1
}

Campos do response

ObjetoCampoTipoDescrição
antecipationantecipationLimitnumberValor total disponível para antecipação pela subconta. Calculado a cada requisição, já considerando todas as regras internas de elegibilidade da Celcoin.
antecipationfutureBalancenumberSoma de todas as releases ainda não liquidadas (agenda futura de recebíveis da subconta). Calculado a cada requisição.
transactionsidReleasenumberIdentificador do recebível. A release.
transactionsidTransactionnumberId da transação na qual a release pertence.
transactionsamountnumberValor do recebível.
transactionsavailablebooleanIndica se o recebível está elegível para antecipação. Quando false, o recebível não pode ser antecipado — por exemplo, por não respeitar a carência de liquidação (somente são elegíveis recebíveis com data de pagamento superior a 5 dias corridos), pelo status, ou por outras regras definidas pela Celcoin.
transactionsstatusstringStatus do recebível (ex.: pending, captured, cancelled). Apenas recebíveis com status pending são elegíveis à antecipação.
transactionssettlementDatestring | nullData em que a release foi oficialmente finalizada, seja por liquidação, chargeback ou cancelamento. Retorna null quando a release ainda não foi finalizada.
transactionsexpectedSettlementDatestringData prevista de liquidação do recebível.
transactionsdaysToSettlementnumberQuantidade de dias até a liquidação prevista.
transactionscreatedAtstringData de criação da release.

Regras de retorno

  • A lista de transactions contém as releases da conta consultada, e é retornada mesmo quando o antecipationLimit for 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.


Did this page help you?