Compra com troco
Solicitação de compra de CCB's de outros bancos
Neste etapa, o originar irá informar quais serão as CCB's que tem a intenção de adquirir de outras instituições. Nesse processo caso, ocorra tudo corretamente, a operação de liquidação dos créditos anteriores e liberação de margem ocorrerá sem que seja necessária uma nova chamada de averbação.
POST: https://platform.flowfinance.com.br/banking/originator/application-bundles
{
"applications": [
{
"funding": {
"id": "2f9bc139-b327-452a-9af8-f2d0c1b202a6"
},
"product": {
"id": "80b9d065-8eb6-4af3-b4ca-f5a52b013b01"
},
"borrower": {
"id": "3e512ef4-66b1-45c2-9ea0-afd581d3e6d3"
},
"bundle_item_name": "consignada",
"disbursement_date": "2025-09-29",
"first_payment_date": "2025-09-30",
"loan_details": {
"amortizationFrequency": "MONTHLY",
"amortizationType": "PRICE|SAC|SAA",
"annualEffectiveInterestRate": 74.822873,
"annualInterestRate": 6.983296,
"disbursementAmount": 250.0,
"financedAmount": 358.13,
"interestPreType": "BASE_365|BASE_360",
"interestRate": 0.189,
"interestRateFrequency": "MONTHLY",
"iofAmount": 3.13,
"lastPaymentDate": "2025-12-12",
"monthlyEffectiveInterestRate": 0.434333,
"paymentAmount": 169.8,
"schedule": [
{
"balance": 358.13,
"interest": 29.08,
"iof": 0.91,
"payment": 169.8,
"paymentDate": "2025-08-12",
"period": 1,
"principal": 140.72,
"runningDay": 33
},
{
"balance": 217.41,
"interest": 51.84,
"iof": 1.07,
"payment": 169.8,
"paymentDate": "2025-09-12",
"period": 2,
"principal": 117.96,
"runningDay": 64
},
{
"balance": 99.45,
"interest": 70.35,
"iof": 1.15,
"payment": 169.8,
"paymentDate": "2025-10-12",
"period": 3,
"principal": 99.45,
"runningDay": 94
}
],
"totalAmountOwed": 509.4,
"totalProcessingCost": 108.13
},
"contracts_to_purchase": [
"abc",
"abc1"
],
"consignment": {
"tokens": [
{
"type": "READ_CONTRACTS",
"values": [
"X"
]
},
{
"type": "GUARANTEE",
"values": [
"X"
]
}
],
"employee_id": "123123"
}
},
{
"funding": {
"id": "2f9bc139-b327-452a-9af8-f2d0c1b202a6"
},
"product": {
"id": "80b9d065-8eb6-4af3-b4ca-f5a52b013b01"
},
"borrower": {
"id": "3e512ef4-66b1-45c2-9ea0-afd581d3e6d3"
},
"bundle_item_name": "clean",
"disbursement_date": "2025-09-29",
"first_payment_date": "2025-09-30",
"payment_method": "BILLET_PAYMENT",
"billets_info": [
{
"digitable": "00190000090100159000700117369173390420000098888",
"type": 2,
"amount": 987.93,
"assignor": "BANCO DO BRASIL S.A.",
"payer": "PAGADOR AMBIENTE DE HOMOLOGACAO",
"recipient": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
"original_amount": 957.24,
"due_date": "2024-11-08T00:00:00Z",
"settle_date": "08/11/2024",
"document_payer": "698.447.801-44",
"document_recipient": "00.031.572/3670-91",
"validation_hash": "14cb959e5a4f076db859c6646da7a404"
},
{
"digitable": "23793381286008301352856000063307789840000150000",
"type": 2,
"amount": 1500,
"assignor": "BANCO BRADESCO S.A.",
"payer": "PAGADOR AMBIENTE DE HOMOLOGACAO",
"recipient": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
"original_amount": 1500,
"due_date": "2024-11-08T00:00:00Z",
"settle_date": "08/11/2024",
"document_payer": "698.447.801-44",
"document_recipient": "00.031.572/3670-91",
"validation_hash": "aeb538b55238f6ff26189eb72356984e"
}
],
"loan_details": {
"amortizationFrequency": "MONTHLY",
"amortizationType": "PRICE|SAC|SAA",
"annualEffectiveInterestRate": 74.822873,
"annualInterestRate": 6.983296,
"disbursementAmount": 250.0,
"financedAmount": 358.13,
"interestPreType": "BASE_365|BASE_360",
"interestRate": 0.189,
"interestRateFrequency": "MONTHLY",
"iofAmount": 3.13,
"issueDate": "2025-08-12",
"lastPaymentDate": "2025-12-12",
"monthlyEffectiveInterestRate": 0.434333,
"paymentAmount": 169.8,
"schedule": [
{
"additionalValue": 0.0,
"balance": 358.13,
"interest": 29.08,
"iof": 0.91,
"payment": 169.8,
"paymentDate": "2025-08-12",
"period": 1,
"principal": 140.72,
"runningDay": 33
},
{
"additionalValue": 0.0,
"balance": 217.41,
"interest": 51.84,
"iof": 1.07,
"payment": 169.8,
"paymentDate": "2025-09-12",
"period": 2,
"principal": 117.96,
"runningDay": 64
},
{
"additionalValue": 0.0,
"balance": 99.45,
"interest": 70.35,
"iof": 1.15,
"payment": 169.8,
"paymentDate": "2025-10-12",
"period": 3,
"principal": 99.45,
"runningDay": 94
}
],
"totalAmountOwed": 509.4,
"totalProcessingCost": 108.13
}
}
],
"workflow_definition": {
"id": "605e0e8e-587d-48f4-9f77-48bf5c9adab3"
}
}
Parâmetros da requisição
| Campo | Descrição | Tipo |
|---|---|---|
| borrower.id | ID único do tomador, obtido na etapa de criação do tomador. | string |
| product.id | .ID do produto de crédito a ser contratado. | string |
| funding.id | ID da fonte de recursos da operação. | string |
| balance_check_id | ID retornado na consulta de margem do tomador. | string |
| simulation_id | ID retornado na simulação da operação de crédito. | string |
| workflow_definition.id | ID do workflow que orquestra o fluxo de compra para o originador. Retornado na configuração do produto pelo time de acompanhamento. | string |
| bundle_item_name | Nome que diferencia as CCB's dento do grupo de criação. | string |
| contracts_to_purchase | Contratos que serão liquidados para composição da nova margem disponível do tomador. | string |
| consignment.tokens | Lista de tokens para que sejam utilizados na leitura dos dados do tomador no e-consig e para operação de compra. | array |
| billets_info.digitable | Linha digitável do boleto de liquidação do contrato adquirido. | string |
{
"id": "2f9bc139-b327-452a-9af8-f2d0c1b202a9",
"status": "PENDING|CANCELED|COMPLETED"
"applications": [
{
"funding": {
"id": "2f9bc139-b327-452a-9af8-f2d0c1b202a6"
},
"product": {
"id": "80b9d065-8eb6-4af3-b4ca-f5a52b013b01"
},
"borrower": {
"id": "3e512ef4-66b1-45c2-9ea0-afd581d3e6d3"
},
"bundle_item_name": "consignada",
"disbursement_date": "2025-09-29",
"first_payment_date": "2025-09-30",
"loan_details": {
"amortizationFrequency": "MONTHLY",
"amortizationType": "PRICE|SAC|SAA",
"annualEffectiveInterestRate": 74.822873,
"annualInterestRate": 6.983296,
"disbursementAmount": 250.0,
"financedAmount": 358.13,
"interestPreType": "BASE_365|BASE_360",
"interestRate": 0.189,
"interestRateFrequency": "MONTHLY",
"iofAmount": 3.13,
"lastPaymentDate": "2025-12-12",
"monthlyEffectiveInterestRate": 0.434333,
"paymentAmount": 169.8,
"schedule": [
{
"balance": 358.13,
"interest": 29.08,
"iof": 0.91,
"payment": 169.8,
"paymentDate": "2025-08-12",
"period": 1,
"principal": 140.72,
"runningDay": 33
},
{
"balance": 217.41,
"interest": 51.84,
"iof": 1.07,
"payment": 169.8,
"paymentDate": "2025-09-12",
"period": 2,
"principal": 117.96,
"runningDay": 64
},
{
"balance": 99.45,
"interest": 70.35,
"iof": 1.15,
"payment": 169.8,
"paymentDate": "2025-10-12",
"period": 3,
"principal": 99.45,
"runningDay": 94
}
],
"totalAmountOwed": 509.4,
"totalProcessingCost": 108.13
},
"contracts_to_purchase": [
"abc",
"abc1"
],
"consignment": {
"tokens": [
{
"type": "READ_CONTRACTS",
"values": [
"X"
]
},
{
"type": "GUARANTEE",
"values": [
"X"
]
}
],
"employee_id": "123123"
}
},
{
"funding": {
"id": "2f9bc139-b327-452a-9af8-f2d0c1b202a6"
},
"product": {
"id": "80b9d065-8eb6-4af3-b4ca-f5a52b013b01"
},
"borrower": {
"id": "3e512ef4-66b1-45c2-9ea0-afd581d3e6d3"
},
"bundle_item_name": "clean",
"disbursement_date": "2025-09-29",
"first_payment_date": "2025-09-30",
"payment_method": "BILLET_PAYMENT",
"billets_info": [
{
"digitable": "00190000090100159000700117369173390420000098888",
"type": 2,
"amount": 987.93,
"assignor": "BANCO DO BRASIL S.A.",
"payer": "PAGADOR AMBIENTE DE HOMOLOGACAO",
"recipient": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
"original_amount": 957.24,
"due_date": "2024-11-08T00:00:00Z",
"settle_date": "08/11/2024",
"document_payer": "698.447.801-44",
"document_recipient": "00.031.572/3670-91",
"validation_hash": "14cb959e5a4f076db859c6646da7a404"
},
{
"digitable": "23793381286008301352856000063307789840000150000",
"type": 2,
"amount": 1500,
"assignor": "BANCO BRADESCO S.A.",
"payer": "PAGADOR AMBIENTE DE HOMOLOGACAO",
"recipient": "BENEFICIARIO AMBIENTE HOMOLOGACAO",
"original_amount": 1500,
"due_date": "2024-11-08T00:00:00Z",
"settle_date": "08/11/2024",
"document_payer": "698.447.801-44",
"document_recipient": "00.031.572/3670-91",
"validation_hash": "aeb538b55238f6ff26189eb72356984e"
}
],
"loan_details": {
"amortizationFrequency": "MONTHLY",
"amortizationType": "PRICE|SAC|SAA",
"annualEffectiveInterestRate": 74.822873,
"annualInterestRate": 6.983296,
"disbursementAmount": 250.0,
"financedAmount": 358.13,
"interestPreType": "BASE_365|BASE_360",
"interestRate": 0.189,
"interestRateFrequency": "MONTHLY",
"iofAmount": 3.13,
"issueDate": "2025-08-12",
"lastPaymentDate": "2025-12-12",
"monthlyEffectiveInterestRate": 0.434333,
"paymentAmount": 169.8,
"schedule": [
{
"additionalValue": 0.0,
"balance": 358.13,
"interest": 29.08,
"iof": 0.91,
"payment": 169.8,
"paymentDate": "2025-08-12",
"period": 1,
"principal": 140.72,
"runningDay": 33
},
{
"additionalValue": 0.0,
"balance": 217.41,
"interest": 51.84,
"iof": 1.07,
"payment": 169.8,
"paymentDate": "2025-09-12",
"period": 2,
"principal": 117.96,
"runningDay": 64
},
{
"additionalValue": 0.0,
"balance": 99.45,
"interest": 70.35,
"iof": 1.15,
"payment": 169.8,
"paymentDate": "2025-10-12",
"period": 3,
"principal": 99.45,
"runningDay": 94
}
],
"totalAmountOwed": 509.4,
"totalProcessingCost": 108.13
}
}
],
"workflow_definition": {
"id": "605e0e8e-587d-48f4-9f77-48bf5c9adab3"
}
}
Demais processos:
- Geração do contrato;
- Coleta das assinaturas digitais do tomador e, se aplicável, da instituição financeira;
- Averbação junto ao órgão responsável.
- Quitação do empréstimo anterior;
- Quitação da CCB de empréstimo pessoal;
- Desembolso do "troco" na conta de livre movimentação do servidor.
Comunicação
A partir do sucesso no envio da solicitação de compra toda comunicação referente ao andamento das CCB's que compõem o bundle, será realizada por meio do webwook cadastrado.
Somente após a conclusão dessas etapas que a CCB segue para o desembolso do crédito e, se previsto, a cessão da operação.
Consulta de situação do bundle
Para consultar o andamento das CCB's dentro do workflow, pode-se utilizar a requisição a seguir:
GET: https://platform.flowfinance.com.br/banking/originator/application-bundles/{id}
Cancelamento da CCB
O crédito consignado pode ser cancelado (desaverbado) em casos específicos, conforme as regras e prazos estabelecidos pelo sistema. As situações que permitem o cancelamento incluem:
- Desistência pelo tomador: Solicitação de cancelamento dentro do prazo permitido;
- Cancelamento da CCB: Anulação formal do contrato, quando aplicável;
Documentação:
https://developers.celcoin.com.br/reference/post_banking-originator-applications-application-id-cancel
Updated 2 days ago