Documentação
DocumentaçãoAPIStatusSuporteFAQscelcoin.com
Start typing to search…

Consultas, Escriturações e Repasses

O que são Consulta de Eventos

Os eventos de garantia representam ações ocorridas durante o ciclo de vida de um contrato do crédito do trabalhador.
Eles são armazenados em nossa base e podem ser consultados a qualquer momento via API.


Tipos de Evento Disponíveis

NomeTipo de EventoDescrição
EscrituraçãoBOOKKEEPINGEvento mensal que representa a escrituração (impressão da guia de pagamento das parcelas).
RepasseTRANSFEREvento mensal que representa o repasse financeiro da Dataprev para instituição financeira.
Consulta de VínculoALTER_ANNOTATIONEvento utilizado para consultar quando há novo vínculo empregatício do tomador.
Encerramento de VínculoALTER_ANNOTATIONEvento utilizado para consultar quando há encerramento de vínculo empregatício do tomador.

Endpoint


URL

GET https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee-events

Lista todos os eventos de garantia de acordo com os filtros informados.
A resposta é paginada, permitindo navegação entre grandes volumes de dados.


Filtros Disponíveis

CampoTipoDescrição
application_idsArray<UUID>Busca eventos relacionados a uma ou mais operações específicas.
annotation_idUUIDBusca eventos relacionados a um annotationId específico.
contract_numberStringBusca pelo número da CCB.
event_typeStringTipo do evento: BOOKKEEPING, TRANSFER, ALTER_ANNOTATION.
created_fromDateTime (ISO 8601)Retorna eventos criados a partir desta data (YYYY-MM-DDThh:mm:ssZ).
created_toDateTime (ISO 8601)Retorna eventos criados até esta data (YYYY-MM-DDThh:mm:ssZ).

💡

Dica: Combine filtros para refinar os resultados.

Exemplo: buscar apenas eventos TRANSFER de um annotationId específico.


BOOKKEEPING (Escrituração)


Exemplo de Request:

curl --location 'https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee-events?event_type=BOOKKEEPING' \
--header 'Authorization: Bearer ' \
--data ''

Exemplo de Response

{
    "content": [
        {
            "id": "c7f8edaf-85b3-4117-a36e-c5cc2d44bf49",
            "annotation_id": "09dbd998-b8d0-4ed4-926c-93979c2299b3",
            "event_type": "BOOKKEEPING",
            "payload": {
                "payload": {
                    "id": "66030d28-3e3b-4a18-92b3-adb581a7924f",
                    "amount": 600,
                    "agency_id": "3a7e1beb-c64f-4936-8555-b9edb42c3328",
                    "metadata": {
                        "period": "202512",
                        "agency_code": 668
                    },
                    "created_at": 1.7640961266403215E9,
                    "event_type": "BOOKKEEPING",
                    "consignee_id": "3b9be0e7-3af9-4ca4-ad31-26233a58486a",
                    "annotation_id": "09dbd998-b8d0-4ed4-926c-93979c2299b3",
                    "contract_number": "185736"
                },
                "created_at": 1.7640961266403215E9,
                "event_type": "BOOKKEEPING",
                "annotation_id": "09dbd998-b8d0-4ed4-926c-93979c2299b3",
                "contract_number": "185736"
            },
            "created_at": "2025-11-25T18:42:06.640Z"
        },

Parâmetros BOOKKEEPING

CampoTipoDescrição
idstringIdentificador único do evento.
annotation_idstringID da anotação vinculada ao evento.
event_typestringTipo do evento (ex.: BOOKKEEPING).
created_atstringData e hora de criação do evento no formato ISO 8601.
payloadobjectObjeto contendo os dados detalhados do evento.
payload.created_atnumberTimestamp (epoch) da criação do payload.
payload.event_typestringTipo do evento dentro do payload.
payload.annotation_idstringID da anotação no payload.
payload.contract_numberstringNúmero do contrato associado ao evento.
payload.payloadobjectDetalhes da escrituração.
payload.payload.idstringID único da escrituração.
payload.payload.amountnumberValor da escrituração.
payload.payload.agency_idstringIdentificador da agência responsável.
payload.payload.metadataobjectDados complementares da escrituração.
payload.payload.metadata.periodstringPeríodo/competência (AAAAMM).
payload.payload.metadata.agency_codenumberCódigo da agência.
payload.payload.created_atnumberTimestamp (epoch) da criação da escrituração.
payload.payload.event_typestringTipo do evento da escrituração.
payload.payload.consignee_idstringIdentificador do consignatário.
payload.payload.annotation_idstringID da anotação vinculada à escrituração.
payload.payload.contract_numberstringNúmero do contrato na escrituração.


TRANSFER (Repasse)


Exemplo de Request:

curl --location 'https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee-events?event_type=TRANSFER' \
--header 'Authorization: Bearer' \
--data ''

Exemplo de Response

{
    "content": [
        {
            "id": "4e1df7fb-e3d5-420b-b7cc-8f72cd86a3ed",
            "annotation_id": "09dbd998-b8d0-4ed4-926c-93979c2299b3",
            "event_type": "TRANSFER",
            "payload": {
                "payload": {
                    "id": "3ec34ef5-eed1-4ac4-a96f-a56454263f77",
                    "amount": 600,
                    "agency_id": "3a7e1beb-c64f-4936-8555-b9edb42c3328",
                    "metadata": {
                        "agency_code": 668,
                        "payment_datetime": 1.7639424E9,
                        "agency_transfer_datetime": 1.7640288E9
                    },
                    "created_at": 1.7640962455665488E9,
                    "event_type": "TRANSFER",
                    "consignee_id": "3b9be0e7-3af9-4ca4-ad31-26233a58486a",
                    "annotation_id": "09dbd998-b8d0-4ed4-926c-93979c2299b3",
                    "contract_number": "185736"
                },
                "created_at": 1.7640962455665488E9,
                "event_type": "TRANSFER",
                "annotation_id": "09dbd998-b8d0-4ed4-926c-93979c2299b3",
                "contract_number": "185736"
            },
            "created_at": "2025-11-25T18:44:05.566Z"
        },

Parâmetros TRANSFER


CampoTipoDescrição
idstringIdentificador único do evento principal.
annotation_idstringID da anotação associada ao evento.
event_typestringTipo do evento (ex.: TRANSFER).
created_atstringData e hora de criação do evento principal (ISO 8601).
payloadobjectObjeto contendo os dados detalhados do evento.
payload.created_atnumberTimestamp da criação do payload.
payload.event_typestringTipo do evento dentro do payload.
payload.annotation_idstringID da anotação dentro do payload.
payload.contract_numberstringNúmero do contrato dentro do payload.
payload.payloadobjectDados internos da transferência.
payload.payload.idstringID único da transferência.
payload.payload.amountnumberValor transferido.
payload.payload.agency_idstringID da agência responsável pela transferência.
payload.payload.metadataobjectInformações adicionais da transferência.
payload.payload.metadata.agency_codenumberCódigo da agência.
payload.payload.metadata.payment_datetimenumberTimestamp do pagamento realizado.
payload.payload.metadata.agency_transfer_datetimenumberTimestamp do repasse pela agência.
payload.payload.created_atnumberTimestamp da criação do evento interno.
payload.payload.event_typestringTipo do evento interno (ex.: TRANSFER).
payload.payload.consignee_idstringIdentificador do consignatário.
payload.payload.annotation_idstringID da anotação interna.
payload.payload.contract_numberstringNúmero do contrato na transferência.


ALTER_ANNOTATION (Consulta de novo vínculo)


Exemplo de Request:

curl --location --request GET 'https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee-events?event_type=ALTER_ANNOTATION' \
--header 'Authorization: Bearer' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials'

Exemplo de Response

        {
            "id": "8c5c3a8e-c011-49d0-8338-29ff9381192f",
            "annotation_id": "ab3a4e4e-9539-4c04-9827-92e0c79f3d8d",
            "event_type": "ALTER_ANNOTATION",
            "payload": {
                "status": "SUCCESS",
                "contract": {
                    "ip": "45.185.3.252",
                    "score": 0,
                    "number": "186227",
                    "account": {
                        "bank": "0",
                        "branch": "668",
                        "number": "N/A"
                    },
                    "latitude": 0,
                    "sequence": "17777079187",
                    "longitude": 0,
                    "nsu_contrato": 186227,
                    "numero_contrato": "2394744",
                    "tipo_autenticacao": 1,
                    "codigo_solicitante": 668,
                    "data_hora_assinatura": "03102025133313",
                    "indicador_analfabetismo": false,
                    "indicador_validacao_com_doc_oficial": false,
                    "indicador_assinatura_cert_digital_icpbrasil": false
                },
                "metadata": {
                    "document": "42811680870",
                    "net_amount": 0,
                    "loan_amount": 0,
                    "employer_name": "COMPANHIA DE SANEAMENTO BASICO DO ESTADO DE SAO PAULO - SABESP",
                    "registration": "00133627",
                    "employer_number": "43776517",
                    "end_discount_date": 0,
                    "bookings_quantity": 0,
                    "init_discount_date": 0,
                    "payments_quantity": 0,
                    "installment_amount": 0,
                    "installment_quantity": 0,
                    "employer_registration": {
                        "code": 1,
                        "description": "CNPJ"
                    }
                },
                "created_at": "2025-10-03T14:26:31.809Z",
                "action_type": "ALTER_ANNOTATION",
                "operation_id": "17777079187",
                "annotation_id": "ab3a4e4e-9539-4c04-9827-92e0c79f3d8d",
                "contract_number": "186227",
                "status_contract": "DEACTIVATED_RENEWED_LINK"
            },
            "created_at": "2025-10-03T14:26:31.809Z"
        }

Parâmetros ALTER_ANNOTATION (Consulta de novo vínculo)


CampoTipoDescrição
idstringIdentificador único do evento.
annotation_idstringID da anotação relacionada ao evento.
event_typestringTipo do evento (ALTER_ANNOTATION).
created_atstringData/hora de criação do evento (ISO 8601).
payloadobjectDados detalhados da alteração.
payload.statusstringStatus do processamento (SUCCESS).
payload.created_atstringData/hora da criação do payload.
payload.action_typestringTipo da ação realizada (ALTER_ANNOTATION).
payload.operation_idstringIdentificador da operação alterada.
payload.annotation_idstringID da anotação associada ao payload.
payload.contract_numberstringNúmero do contrato relacionado ao evento.
payload.status_contractstringStatus atualizado do contrato.
payload.contractobjectDados completos do contrato associado.
payload.contract.ipstringEndereço IP utilizado.
payload.contract.scorenumberScore calculado para o contrato.
payload.contract.numberstringNúmero do contrato.
payload.contract.accountobjectDados da conta bancária vinculada.
payload.contract.account.bankstringCódigo do banco.
payload.contract.account.branchstringAgência bancária.
payload.contract.account.numberstringNúmero da conta.
payload.contract.latitudenumberLatitude registrada no momento da assinatura.
payload.contract.longitudenumberLongitude registrada no momento da assinatura.
payload.contract.sequencestringSequência interna da operação.
payload.contract.nsu_contratonumberNSU do contrato.
payload.contract.numero_contratostringNúmero interno do contrato no órgão.
payload.contract.tipo_autenticacaonumberTipo de autenticação utilizada (ex.: biometria, senha, etc.).
payload.contract.codigo_solicitantenumberCódigo do solicitante/originador.
payload.contract.data_hora_assinaturastringData e hora da assinatura (formato AAAAMMDDHHMMSS).
payload.contract.indicador_analfabetismobooleanIndica se o tomador é analfabeto.
payload.contract.indicador_validacao_com_doc_oficialbooleanIndica se houve validação com documento oficial.
payload.contract.indicador_assinatura_cert_digital_icpbrasilbooleanIndica se foi utilizada certificação ICP-Brasil.
payload.metadataobjectMetadados detalhados do contrato.
payload.metadata.documentstringCPF ou documento do tomador.
payload.metadata.net_amountnumberValor líquido.
payload.metadata.loan_amountnumberValor bruto do empréstimo.
payload.metadata.employer_namestringNome da empresa empregadora.
payload.metadata.registrationstringMatrícula do servidor/beneficiário.
payload.metadata.employer_numberstringCódigo da empresa empregadora.
payload.metadata.end_discount_datenumberData de fim dos descontos.
payload.metadata.bookings_quantitynumberQuantidade de lançamentos/averbações.
payload.metadata.init_discount_datenumberData de início do desconto.
payload.metadata.payments_quantitynumberQuantidade de parcelas pagas.
payload.metadata.installment_amountnumberValor da parcela.
payload.metadata.installment_quantitynumberQuantidade total de parcelas.
payload.metadata.employer_registrationobjectDados de registro da empresa empregadora.
payload.metadata.employer_registration.codenumberTipo de registro (ex.: 1 = CNPJ).
payload.metadata.employer_registration.descriptionstringDescrição do tipo de registro.

ALTER_ANNOTATION (Encerramento de Vínculo)

Exemplo de Request:

curl --location --request GET 'https://sandbox.platform.flowfinance.com.br/banking/originator/guarantee-events?event_type=ALTER_ANNOTATION' \
--header 'Authorization: Bearer' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'grant_type=client_credentials'

Exemplo de Response

{
    "content": [
        {
            "id": "64ca7a51-4786-49c2-aa0e-5335b7b7f00f",
            "annotation_id": "ab3a4e4e-9539-4c04-9827-92e0c79f3d8d",
            "event_type": "ALTER_ANNOTATION",
            "payload": {
                "status": "SUCCESS",
                "contract": {
                    "ip": "177.107.88.171",
                    "score": 0,
                    "number": "186227",
                    "account": {
                        "bank": "0",
                        "branch": "668",
                        "number": "N/A"
                    },
                    "latitude": 0,
                    "sequence": "18530098497",
                    "longitude": 0,
                    "nsu_contrato": 2639733,
                    "numero_contrato": "2639733",
                    "tipo_autenticacao": 1,
                    "codigo_solicitante": 668,
                    "data_hora_assinatura": "05112025003841",
                    "indicador_analfabetismo": false,
                    "indicador_validacao_com_doc_oficial": false,
                    "indicador_assinatura_cert_digital_icpbrasil": false
                },
                "metadata": {
                    "document": "47348333893",
                    "net_amount": 102.36,
                    "loan_amount": 103.49,
                    "employee_name": "BRUNA MENDES DA SILVA ANDRADE",
                    "employer_name": "ATENTO BRASIL S/A",
                    "registration": "1526578",
                    "situation_loan": {
                        "code": 15,
                        "description": "Encerrado por término do vínculo"
                    },
                    "employer_number": "2879250",
                    "proposal_number": "clv9bd5gxzk",
                    "update_date_time": "2025-11-21T01:41:22",
                    "contract_end_date": "2026-02-21",
                    "end_discount_date": 202601,
                    "bookings_quantity": 0,
                    "init_discount_date": 202512,
                    "payments_quantity": 0,
                    "contract_start_date": "2025-11-15",
                    "installment_amount": 78.95,
                    "installment_quantity": 2,
                    "employer_registration": {
                        "code": 1,
                        "description": "CNPJ"
                    },
                    "financial_institution": {
                        "code": 668,
                        "description": "VIA CAPITAL"
                    },
                    "inclusion_loan_date_time": "2025-11-04T21:40:04"
                },
                "created_at": "2025-11-05T00:40:02.261Z",
                "action_type": "ALTER_ANNOTATION",
                "operation_id": "18530098497",
                "annotation_id": "ab3a4e4e-9539-4c04-9827-92e0c79f3d8d",
                "contract_number": "186227 ",
                "status_contract": "DEACTIVATED_TERMINATED_LINK"
            },
            "created_at": "2025-11-05T00:40:02.261Z"
        },

Parâmetros ALTER_ANNOTATION (Encerramento de Vínculo)


CampoTipoDescrição
idstringIdentificador único do evento.
annotation_idstringID da averbação associada ao evento.
event_typestringTipo do evento recebido (ALTER_ANNOTATION).
payload.statusstringStatus do processamento da ação.
payload.contract.ipstringEndereço IP do solicitante.
payload.contract.scorenumberScore associado à operação.
payload.contract.numberstringNúmero do contrato informado no evento.
payload.contract.account.bankstringCódigo do banco associado à conta.
payload.contract.account.branchstringNúmero da agência.
payload.contract.account.numberstringNúmero da conta bancária.
payload.contract.latitudenumberLatitude coletada durante a assinatura.
payload.contract.sequencestringSequência identificadora da operação.
payload.contract.longitudenumberLongitude coletada durante a assinatura.
payload.contract.nsu_contratonumberNSU do contrato utilizado na operação.
payload.contract.numero_contratostringNúmero do contrato na instituição.
payload.contract.tipo_autenticacaonumberTipo de autenticação utilizada.
payload.contract.codigo_solicitantenumberCódigo da instituição solicitante.
payload.contract.data_hora_assinaturastringData e hora da assinatura do contrato.
payload.contract.indicador_analfabetismobooleanIndica se o cliente é analfabeto.
payload.contract.indicador_validacao_com_doc_oficialbooleanIndica se houve validação com documento oficial.
payload.contract.indicador_assinatura_cert_digital_icpbrasilbooleanIndica se foi usada assinatura com certificado ICP-Brasil.
payload.metadata.documentstringDocumento do cliente (CPF).
payload.metadata.net_amountnumberValor líquido liberado ao cliente.
payload.metadata.loan_amountnumberValor bruto do empréstimo.
payload.metadata.employee_namestringNome do colaborador.
payload.metadata.employer_namestringNome do empregador.
payload.metadata.registrationstringMatrícula do colaborador no empregador.
payload.metadata.situation_loan.codenumberCódigo da situação do contrato.
payload.metadata.situation_loan.descriptionstringDescrição da situação do contrato.
payload.metadata.employer_numberstringCódigo do empregador.
payload.metadata.proposal_numberstringNúmero da proposta.
payload.metadata.update_date_timestringData/hora da última atualização.
payload.metadata.contract_end_datestringData de término do contrato.
payload.metadata.end_discount_datenumberÚltimo mês previsto de desconto.
payload.metadata.bookings_quantitynumberQuantidade de bookings realizados.
payload.metadata.init_discount_datenumberPrimeiro mês de desconto.
payload.metadata.payments_quantitynumberQuantidade de pagamentos efetuados.
payload.metadata.contract_start_datestringData de início do contrato.
payload.metadata.installment_amountnumberValor da parcela.
payload.metadata.installment_quantitynumberNúmero total de parcelas.
payload.metadata.employer_registration.codenumberTipo de registro do empregador (ex: CNPJ).
payload.metadata.employer_registration.descriptionstringDescrição do tipo de registro.
payload.metadata.financial_institution.codenumberCódigo da instituição financeira.
payload.metadata.financial_institution.descriptionstringNome da instituição financeira.
payload.metadata.inclusion_loan_date_timestringData/hora de inclusão do contrato.
payload.created_atstringData/hora da criação do payload.
payload.action_typestringTipo de ação executada (ALTER_ANNOTATION).
payload.operation_idstringID da operação executada.
payload.annotation_idstringID da averbação referenciada.
payload.contract_numberstringNúmero do contrato relacionado.
payload.status_contractstringStatus atual do contrato.
created_atstringData/hora da criação do evento.

Updated about 2 hours ago