Antecipação de Recebíveis Pontual
A solução de antecipação de recebíveis do BaaS, permite antecipar os valores das cobranças realizadas via cartão de crédito antes do prazo acordado inicialmente. Abaixo iremos explicar como se integrar com esse módulo do BaaS.
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.
Caso de uso:
Como Fintech quero antecipar meu recebível de cartão de crédito para melhorar meu fluxo de caixa.
Nesse artigo você irá aprender sobre:
- Simular Antecipação de Recebíveis
- Antecipar recebíveis
- Listar simulações de antecipação
Pré requisitos para implementação:
- Possuir uma chave api da Celcoin, para mais informações acessar esse link
- Ter familiaridade com apis Rest usando o protocolo OAuth 2.0.
- Ter o produto/solução de sub Celcoin contratado, caso queira usar a funcionalidade em ambiente produtivo, por favor entre em contato com a nossa equipe comercial através do e-mail [email protected]. Para dúvidas técnicas, basta entrar em contato com o suporte através do link.
Regras de Negócio:
| Regra | Funcionamento |
|---|---|
| Janela de Operação | As solicitações de simulação e antecipação devem ser realizadas das 07h às 14h. Requisições fora desta janela serão rejeitadas. |
| Validade da Simulação | Todas as simulações geradas possuem validade diária limite e expiram impreterivelmente às 14h do mesmo dia. |
| Simulações Simultâneas | É permitida apenas uma simulação com status Ativa por vez para cada conta. A criação de uma nova simulação cancelará automaticamente a anterior. |
| Carência de Recebíveis | Somente são elegíveis recebíveis cujas datas de pagamento sejam superiores a 5 dias corridos a partir da data da solicitação. |
| Critério de Seleção | Caso o montante disponível ultrapasse o valor solicitado, o sistema selecionará a combinação de recebíveis mais próximos do vencimento (respeitando a carência de 5 dias) cujo valor total consolidado seja menor ou igual ao solicitado. |
| Status da simulação | START, PROCCESSING, ERROR, SUCCESS, EXPIRED, PAYED, REFUSED. |
Simular Antecipação de Recebíveis
Para simular uma antecipação de recebível e conhecer as taxas a serem aplicadas é necessário realizar uma chamada na api Simular Antecipação de Recebíves utilizando o método POST, onde precisa ser preenchido algumas informações relacionadas as transações e bandeiras que serão antecipadas. Os dados necessários estão no quadro "Parâmetros do Body"
Modelo de requisição:
curl --request POST \
--url https://sandbox.openfinance.celcoin.dev/baas/v1/cash/companies/numberAccount/simulation-antecipation-receivables \
--header 'accept: application/json' \
--header 'content-type: application/json'
--data '
{
"value": 1000.00,
"transactionIds": "774910235"
}
'Parâmetros do Body:
| Campo | Descrição | Tipo | Obrigatório |
|---|---|---|---|
| value | Valor total que se deseja simular para a antecipação. | number (float) | Obrigatório se transactionIds não for enviado. |
| transactionIds | Transações desejadas para antecipar. | Array Int (32) | Obrigatório se value não for enviado; se ambos forem enviados, ele prevalece. |
Modelo de retorno:
Sucesso(201):
{
"version": "1.0.0",
"status": 201,
"body": {
"idRequest": "cba1ecfd-dabc-4cb6-965f-1e194beb0c13",
"valueSimulation": 15000,
"transactionsIds": null,
"totalTaxAntecipations": 450.92,
"totalValueAntecipations": 14876.33,
"allTransactions": [
{
"idRelease": 9901,
"idTransaction": 5501,
"days": 18,
"taxAntecipation": 87.34,
"antecipatedValue": 2943.66,
"payDay": "2026-07-09"
},
{
"idRelease": 9902,
"idTransaction": 5502,
"days": 23,
"taxAntecipation": 111.2,
"antecipatedValue": 3764.8,
"payDay": "2026-07-14"
}
]
}
}Campos do response:
| Campo | Descrição | Tipo |
|---|---|---|
idRequest | Identificador da simulação criada. | string |
valueSimulation | Valor da simulação solicitado. | decimal |
transactionsIds | Caso a simulação tenha sido feita utilizando o transactionIds, será retornado o id neste campo. | array |
totalTaxAntecipations | Valor total a ser pago a Celcoin pela efetivação da antecipação. | decimal |
totalValueAntecipations | Valor total do valor aprovado para antecipação. | decimal |
idRelease | Identificador da release que a transação pertence | int |
idTransaction | Identificador da transação. | int |
days | Quantidade de dias em que a release seria paga. | numerico |
taxAntecipation | Valor total a ser pago a Celcoin pela efetivação da antecipação dessa transação. | decimal |
antecipatedValue | Valor total antecipado da transação. | decimal |
payDay | Dia em que a transação da release nasceu para ser paga. | Date |
Erro status code 404:
{ "version": "1.0.0", "status": 404, "error": { "errorCode": "BSPSAC0405", "message": "Nenhuma transação elegível encontrada para realizar a simulação." } }Erro status code 422:
{ "version": "1.0.0", "status": 422, "error": { "errorCode": "BSPSAC0422", "message": "Solicitação de simulação fora da janela de execução (7 às 14 horas do dia corrente)." } }Efetivar a Antecipação dos Recebíveis
Após a simulação de antecipação de recebíveis, caso concorde com os termos apresentados, é possível concluir a antecipação. Para isso, é necessário realizar uma chamada na api Efetivar a Antecipação de Recebíveis utilizando o método POST, onde precisa ser enviado na requisição o identificador da simulação realizada na etapa anterior.
Modelo de request:
curl --request POST \
--url https://sandbox.openfinance.celcoin.dev/baas/v1/cash/companies/numberAccount/simulation-antecipation-payment/idRequest \
--header 'accept: application/json'Modelo de retorno:
Sucesso(200):
{
"version": "1.0.0",
"status": 200,
"body": {
"success": true
}
}Erro Response Code 404:
{ "version": "1.0.0", "status": 404, "error": { "errorCode": "BSPSAC0404", "message": "Simulação não encontrada." } }Listar Simulações de Antecipação Realizadas
Caso necessite validar o status das simulações realizadas, você deve realizar uma chamada na API Listar Simulações de Antecipação utilizando o método GET
Modelo de requisição:
curl --request GET \
--url 'https://sandbox.openfinance.celcoin.dev/baas/v1/cash/companies/numberAccount/simulation-antecipation-receivables?page=1&perPage=15' \
--header 'accept: application/json'Parâmetros do Body:
| Campo | Descrição | Tipo |
|---|---|---|
| statusSimulation | status da simulação: START, PROCCESSING, ERROR, SUCCESS, EXPIRED, PAYED, REFUSED. | string |
| createdAtFrom | Data de criação inicial | date |
| createdAtTo | Até que data foi criada a simulação | date |
Modelo de retorno:
{
"version": "1.0.0",
"status": 200,
"body": [
{
"idRequest": "cba1ecfd-dabc-4cb6-965f-1e194beb0c13",
"valueSimulation": 15000.00,
"transactionsIds": null,
"taxAntecipation": 3.47,
"totalTaxAntecipations": 450.92,
"totalValueAntecipations": 14876.33,
"statusSimulation": "SUCCESS",
"simulationDay": "2026-06-03",
"insertDate": "2026-06-03 10:22:45"
}
],
"currentPage": 1,
"perPage": 15,
"total": 38,
"lastPage": 3
}Campos do response:
| Campo | Descrição | Tipo |
|---|---|---|
idRequest | Identificador da solicitação da simulação. | Numerico |
valueSimulation | Valor da simulação solicitado. | Decimal |
transactionsIds | Caso a simulação tenha sido feita utilizando o transactionIds, será retornado o id neste campo. | Array |
taxAntecipation | Percentual da taxa de antecipação. | Decimal |
totalTaxAntecipations | Valor total pago celcoin | Decimal |
totalValueAntecipations | Valor total pago a Celcoin pela efetivação da antecipação. | Decimal |
statusSimulation | Status da simulação. | String |
simulationDay | Dia da solicitação da simulação. | Date |
insertDate | Data e hora da criação da solicitação da simulação. | Datetime |
Detalhar as Releases de Uma Simulação
Caso necessite visualizar as releases de simulações realizadas, você deve realizar uma chamada na API Detalhar as Releases de Uma Simulação utilizando o método GET
Modelo de requisição:
curl --request GET \
--url https://sandbox.openfinance.celcoin.dev/baas/v1/cash/companies/4123/simulation-antecipation-receivables/cba1ecfd-dabc-4cb6-965f-1e194beb0c13 \
--header 'accept: application/json'Parâmetros do Body:
| Campo | Descrição | Tipo |
|---|---|---|
| numberAccount | Identificador público da company | int |
| idRequest | UUID da simulação (id_request) | uuid |
Modelo de retorno:
{
"version": "1.0.0",
"status": 200,
"body": {
"idSimulation": 42,
"idRequest": "cba1ecfd-dabc-4cb6-965f-1e194beb0c13",
"fkIdCompanySimulation": 12345,
"valueSimulation": 15000,
"transactionsIds": null,
"taxAntecipation": 3.47,
"totalTaxAntecipations": 450.92,
"totalValueAntecipations": 14876.33,
"statusSimulation": "SUCCESS",
"simulationDay": "2026-06-09",
"insertDate": "2026-06-09 10:22:45",
"allReleases": [
{
"idRelease": 9901,
"idTransactionRelease": 5501,
"days": 18,
"taxAntecipation": 87.34,
"antecipatedValue": 2943.66,
"payDay": "2026-07-09"
},
{
"idRelease": 9902,
"idTransactionRelease": 5502,
"days": 23,
"taxAntecipation": 111.2,
"antecipatedValue": 3764.8,
"payDay": "2026-07-14"
}
]
}
}Campos do response:
| Campo | Descrição | Tipo |
|---|---|---|
idRequest | Identificador da solicitação da simulação. | Numerico |
valueSimulation | Valor da simulação solicitado. | Decimal |
transactionsIds | Caso a simulação tenha sido feita utilizando o transactionIds, será retornado o id neste campo. | Array |
taxAntecipation | Percentual da taxa de antecipação. | Decimal |
totalTaxAntecipations | Valor total pago celcoin | Decimal |
totalValueAntecipations | Valor total pago a Celcoin pela efetivação da antecipação. | Decimal |
statusSimulation | Status da simulação. | String |
simulationDay | Dia da solicitação da simulação. | Date |
insertDate | Data e hora da criação da solicitação da simulação. | Datetime |
| allReleases | Detalhamento de cada release processada. | array |