Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com

Guia rápido consignado

Suggest Edits

Crédito Trabalhador - Sem Leilão

Documentação oficial das rotas utilizadas no fluxo de Crédito Trabalhador, ambiente Sandbox.

Base URL: https://sandbox.platform.flowfinance.com.br

01 - Obter Token

Método: POST
Endpoint:

https://sandbox.auth.platform.flowfinance.com.br/oauth2/token

Autenticação: Basic Auth

  • Username: {{clientId}}
  • Password: {{clientSecret}}

Body (x-www-form-urlencoded):

CampoValor
grant_typeclient_credentials

02.A - Autorizar pelo fluxo da Celcoin

Método: POST
Endpoint:

https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee/authorization-permission

Headers:

ChaveValor
AuthorizationBearer {{originatorAccessToken}}
Content-Typeapplication/json

Payload:

{
  "taxpayer_id": "TESTE",
  "product_id": "UIDI",
  "name": "celcoin teste",
  "mode": "WHATSAPP",
  "email": "[email protected]",
  "phone": {
    "country_code": "+55",
    "area_code": "11",
    "number": "TESTE"
  }
}

02.B - Autorizar através de arquivo do parceiro

Método: POST
Endpoint:

https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee/authorization-file-permission

Headers:

ChaveValor
AuthorizationBearer {{originatorAccessToken}}

Form-Data:

CampoTipoExemplo
taxpayer_idtext86144456015
product_idtext330ab1f3-3b21-4188-b213-d853b98f0f92
authorizationtextEvidência (hash)
authorization_filefileevidência.pdf

02.1 - Gerar novo token de autorização

Método: POST
Endpoint:

https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee/authorization

Headers:

ChaveValor
AuthorizationBearer {{originatorAccessToken}}
Content-Typeapplication/json

Payload:

{
  "taxpayer_id": "{{taxpayerId}}",
  "product": {
    "id": "{{productId}}"
  }
}

03 - Consulta margem consignável

Método: GET
Endpoint:

https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee/{{productId}}/get-balance?taxpayer_id={{taxpayerId}}

Headers:

ChaveValor
AuthorizationBearer {{originatorAccessToken}}

⚙️

Essa rota gera o balance_check_id, que será usado para vincular a operação nas etapas seguintes.

05 - Cria tomador

Método: POST
Endpoint:

https://sandbox.platform.flowfinance.com.br/banking/originator/persons

Headers:

ChaveValor
AuthorizationBearer {{originatorAccessToken}}
Content-Typeapplication/json

Payload:

{
  "full_name": "{{employeeName}}",
  "taxpayer_id": "{{taxpayerId}}",
  "id_document": {
    "issue_date": "2024-01-01",
    "issuer": "SSP/SC",
    "number": "190653164",
    "type": "RG"
  },
  "sex": "MALE",
  "nationality": "Brasileiro",
  "birth_date": "2001-01-01",
  "occupation": "Administrador",
  "marital_status": "SINGLE",
  "marital_property_system": "NO_COMMUNION",
  "pep": false,
  "email_address": "{{email}}",
  "phone": {
    "country_code": "55",
    "area_code": "48",
    "number": "999999999"
  },
  "address": {
    "street_number": "350",
    "street_name": "Alameda Xingu",
    "postal_code": "06455030",
    "district": "Alphaville",
    "city": "Barueri",
    "state_code": "SP",
    "country_code": "BRA"
  },
  "external_bank_account": {
    "bank_code": "000",
    "bank_account": "00000",
    "bank_account_digit": "0",
    "bank_branch": "00000"
  },
  "pix": {
    "key": "4ca519ef-0ccc-4c41-b58b-c88f1f47d8ab",
    "key_type": "ALEATORY_KEY"
  }
}

💡

Observação:

Em ambiente de sandbox, utilize a chave PIX 4ca519ef-0ccc-4c41-b58b-c88f1f47d8ab para habilitar transferências simuladas.

Simulação de produto (por valor solicitado)

Método: POST
Endpoint:

https://sandbox.platform.flowfinance.com.br/banking/originator/products/{{id_produto}}/preview

Headers:

ChaveValor
AuthorizationBearer {{originatorAccessToken}}
Content-Typeapplication/json

Payload:

{
  "requested_amount": 1000,
  "interest_rate": 0.04,
  "tac_amount": 0,
  "finance_fee": 0,
  "iofType": "PERSON",
  "num_payments": 10,
  "first_payment_date": "2025-11-01",
  "disbursement_date": "2025-10-16",
  "borrower_type": "PERSON",
  "schedule_type": "MONTHLY",
  "balance_check_id": "{{balance_check_id}}"
}

Essa rota gera o simulation_id, que será usado na criação da CCB.

🧾 06 - Cria CCB

Método: POST
Endpoint:

https://sandbox.platform.flowfinance.com.br/banking/originator/applications

Headers:

ChaveValor
AuthorizationBearer {{originatorAccessToken}}
Content-Typeapplication/json

Payload:

{
  "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"
}

⚙️

Vínculo entre entidades:

  • Consulta de margem → balance_check_id
  • Simulação → simulation_id

Webhooks e Eventos Assíncronos

Após a criação da CCB (/banking/originator/applications), todas as respostas passam a ser assíncronas, enviadas via webhook cadastrado pelo originador na rota: /banking/originator/webhooks


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

StatusDescrição
AGREEMENT_RENDERINGGerando contrato
CREATING_BENEFICIARY_ACCOUNTCriando conta do tomador
PENDING_SIGNATUREPendente de assinatura
PENDING_GUARANTEEPendente de garantia
PENDING_QUALIFICATIONPendente de aprovação
PENDING_CESSION_QUALIFICATIONPendente de aprovação da cessão
PENDING_PAYMENTPendente de pagamento
KYC_PROCESSINGPendente KYC
PENDING_DISBURSEMENTPendente desembolso
PARTIAL_DISBURSEMENTDesembolso parcial
DISBURSEMENT_ATTEMPT_FAILEDFalha no pagamento
ISSUEDEmitido
CANCELEDCancelado
PENDING_RANDOMPendente aprovação
PENDING_CASHOUTAguardando PIX
PENDING_CESSIONPendente de cessão
PENDING_INTEGRATION_LAQUSPendente integração Laqus
AWAITING_APPROVAL_DISBURSEMENTAguardando aprovação de desembolso
SIGNATURE_ERRORErro na assinatura
PENDING_ENTRY_PAYMENTAguardando pagamento de entrada
CREATING_ENTRY_PAYMENTCriando pagamento de entrada
SCHEDULED_DISBURSEMENTDesembolso agendado
SENDING_CONSIGNEE_CONTRACTEnviando contrato ao consignatário
PENDING_CONTRACT_SUBMISSIONPendente 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, definido pelo Dataprev.

  • As requisições excedentes entram em fila assíncrona e são notificadas via webhook.
  • Uma nova chamada com os mesmos parâmetros não cancela nem substitui a anterior.

Exemplo de Criação de CCB com o provedor ÚNICO

{
  "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
  }
}

Updated about 16 hours ago