Esta rota permite criar uma aplicação/CCB, vinculando tomador, produto, funding, simulação e consulta de margem.
Método:POST
Endpoint
https://sandbox.platform.flowfinance.com.br/banking/originator/applications
Headers
| Chave | Valor |
|---|---|
| Authorization | Bearer {{originatorAccessToken}} |
| Content-Type | application/json |
Payload Exemplo
{
"borrower": {
"id": "UUID"
},
"product": {
"id": "UUID"
},
"funding": {
"id": "UUID"
},
"balance_check_id": "UUID",
"simulation_id": "UUID",
"first_payment_date": "2025-11-10",
"disbursement_date": "2025-10-20",
"amortization_type": "PRICE",
"amortization_frequency": "MONTHLY",
"interest_rate_frequency": "MONTHLY",
"signature_collect_method": "LINK",
"signature_provider": "CLICKSIGN"
}
- Payload Exemplo - UNICO
{
"requested_amount": 2000,
"interest_rate": 0.01,
"tac_amount": 0,
"finance_fee": 0,
"insurance_amount": 0,
"num_payments": 1,
"first_payment_date": "2025-11-17",
"disbursement_date": "2025-10-17",
"amortization_type": "PRICE",
"amortization_frequency": "MONTHLY",
"interest_pre_type": "BASE_360",
"interest_rate_frequency": "MONTHLY",
"borrower": {
"id": "10fc4519-97a3-4661-aa30-9a96d2fd3caf"
},
"product": {
"id": "72187dc9-57e9-45f2-8fe4-5a5ee754090b"
},
"funding": {
"id": "ecc143f4-e1cc-499b-ae1f-be6a47004dca"
},
"signature_collect_method": "WHATSAPP",
"signature_provider": "UNICO",
"simulation_id": "62703534-4786-43fd-b008-8fe488f5582c",
"signature_authentication_options": {
"mode": "DOC_SIGN_SERPRO"
},
"signature_collect_options": {
"require_self_photo": false,
"require_selfie_validation": false
}
}
Vínculo entre entidades
- Consulta de margem:
balance_check_id - Simulação:
simulation_id
Webhooks e Eventos Assíncronos
Atenção:
Após a criação da CCB, todas as respostas passam a ser assíncronas e são enviadas via webhook cadastrado pelo originador na rota:
1Cadastrar um Novo Webhook
Utilize o método POST para registrar um novo webhook no sistema.
Endpoint: /banking/originator/webhooks
Content-Type: application/json
Exemplo de Requisição (cURL):
curl --location 'https://sandbox.platform.flowfinance.com.br/banking/originator/webhooks' \
--header 'Authorization: SEU_TOKEN_DE_AUTORIZACAO' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://www.dominio.com/webhooks"
}'
- Atualizar um Webhook Existente
Use o método PUT para atualizar a URL de um webhook já cadastrado.
Endpoint: /banking/originator/webhooks/{webhook_id}
Content-Type: application/json
Exemplo de Requisição (cURL):
curl --location --globoff --request PUT 'https://sandbox.platform.flowfinance.com.br/banking/originator/webhooks/{{webhook_id}}' \
--header 'Authorization: SEU_TOKEN_DE_AUTORIZACAO' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://www.dominio.com/webhooks"
}'
Substitua {{webhook_id}} pelo ID do webhook que deseja atualizar.
- Excluir um Webhook
Para remover um webhook, utilize o método DELETE especificando o ID do webhook na rota.
Endpoint: /banking/originator/webhooks/{webhook_id}
Exemplo de Requisição (cURL):
curl --location --request DELETE 'https://sandbox.platform.flowfinance.com.br/banking/originator/webhooks/WEBHOOK_ID' \
--header 'Authorization: SEU_TOKEN_DE_AUTORIZACAO'
Lembrete: Não há corpo de requisição (--data) na operação DELETE.
Certifique-se de substituir WEBHOOK_ID pelo identificador correto do webhook.
Formato do Evento
{
"payload": {
"application_id": "UUID",
"status": "STATUS_AQUI",
"entry_payment_info": null
},
"createdAt": "2025-10-17T19:18:42.958721Z",
"type": "APPLICATION_STATUS_UPDATED"
}
Possíveis Status da Aplicação
| Status | Descrição |
|---|---|
| AGREEMENT_RENDERING | Gerando contrato |
| CREATING_BENEFICIARY_ACCOUNT | Criando conta do tomador |
| PENDING_SIGNATURE | Pendente de assinatura |
| PENDING_GUARANTEE | Pendente de garantia |
| PENDING_QUALIFICATION | Pendente de aprovação |
| PENDING_CESSION_QUALIFICATION | Pendente de aprovação da cessão |
| PENDING_PAYMENT | Pendente de pagamento |
| KYC_PROCESSING | Pendente KYC |
| PENDING_DISBURSEMENT | Pendente desembolso |
| PARTIAL_DISBURSEMENT | Desembolso parcial |
| DISBURSEMENT_ATTEMPT_FAILED | Falha no pagamento |
| ISSUED | Emitido |
| CANCELED | Cancelado |
| PENDING_RANDOM | Pendente aprovação |
| PENDING_CASHOUT | Aguardando PIX |
| PENDING_CESSION | Pendente de cessão |
| PENDING_INTEGRATION_LAQUS | Pendente integração Laqus |
| AWAITING_APPROVAL_DISBURSEMENT | Aguardando aprovação de desembolso |
| SIGNATURE_ERROR | Erro na assinatura |
| PENDING_ENTRY_PAYMENT | Aguardando pagamento de entrada |
| CREATING_ENTRY_PAYMENT | Criando pagamento de entrada |
| SCHEDULED_DISBURSEMENT | Desembolso agendado |
| SENDING_CONSIGNEE_CONTRACT | Enviando contrato ao consignatário |
| PENDING_CONTRACT_SUBMISSION | Pendente de submissão de contrato |
Requisições Assíncronas (Dataprev)
- O endpoint de Consulta de Margem Consignável pode retornar processamento assíncrono quando excedido o limite de 25 requisições/segundo por originador.
- Requisições excedentes entram em fila assíncrona e notificadas via webhook.
- Uma nova chamada com os mesmos parâmetros não cancela nem substitui a anterior