Consultar contratos de empréstimo

Sandbox

https://horizon-api-sb.app.rpe.tech

GET

/api/v1/emprestimos/pessoal/simplificado/contratos

Use esse endpoint para consultar contratos de empréstimos.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://horizon-api-sb.app.rpe.tech/api/v1/emprestimos/pessoal/simplificado/contratos?fields=&allFields=true&status=estornado,efetivado,cancelado&search=&limit=80&offset=0' \
--header 'Authorization: Bearer 123' \
--header 'Accept: */*' \
--header 'User-Funcao: OF0aX2xTB47P'

Response Example

200 - Sucesso

{
    "count": 35615667,
    "next": "3",
    "previous": "1",
    "results": [
        {
            "id": "C255956VCNBJW5",
            "localizador": "C255956VCNBJW5",
            "financeira": {
                "id": "AM6wkTEWLSNP",
                "razaoSocial": "Hpay Sociedade de Crédito Direto S/A",
                "nomeFantasia": "Hpay",
                "cnpj": "57.523.215/0001-04",
                "antecipacaoDecrescente": false,
                "sacEmail": "[email protected]",
                "sacTelefone": "(11) 3003-2850",
                "limiteDiasAtrasoAntecipacao": 0,
                "centroDeCustoPorConvenio": false,
                "sufixoContratoPorConvenio": false,
                "configuraCarimboPorConvenio": false
            },
            "clienteInfoNoContrato": {
                "cpf": "451.987.369-02",
                "email": "[email protected]",
                "nome": "Teste teste",
                "sobrenome": "Teste da silva",
                "dataNascimento": "2000-01-01",
                "nascimentoUf": "SP",
                "sexo": "M",
                "documento": {
                    "tipo": "RG",
                    "numero": "123456789",
                    "dataEmissao": "2010-04-20",
                    "emissor": "SSP",
                    "uf": "SP"
                },
                "endereco": {
                    "cep": "04533-013",
                    "logradouro": "Rua Tabapuã",
                    "numero": "841",
                    "complemento": "de 781 a 989 - lado ímpar",
                    "bairro": "Itaim Bibi",
                    "uf": "SP",
                    "cidade": "São Paulo",
                    "pais": "BR",
                    "residenciaTipo": "alugada",
                    "residenciaTempo": 45
                },
                "nacionalidade": "Brasileiro",
                "estadoCivil": "solteiro",
                "nomePai": "João Batista Rodrigues",
                "nomeMae": "Maria Aparecida da Silva",
                "telefoneCelular": "+5598984769292",
                "telefoneFixo": "+5598984769292",
                "pagamento": {
                    "banco": "069",
                    "instituicao": "gCRTsnq5LeB2",
                    "conta": "987654",
                    "contaDac": "0",
                    "agencia": "1234",
                    "agenciaDac": "0",
                    "tipo": "corrente",
                    "individualOuConjunta": "individual",
                    "bancoNome": "Banco Crefisa S.A.",
                    "telefone": "(87) 6033-7874",
                    "nomeGerente": "laboris velit",
                    "tipoChavePix": "email",
                    "chavePix": "[email protected]"
                },
                "cargo": "Tecnologia da Informação",
                "salario": 13500,
                "salarioBruto": 63858822.272570014,
                "escolaridade": "ensino superior",
                "resourcetype": "ContratoCP"
            },
            "status": "APROVADA",
            "dataPrimeiroVencimento": "2025-08-04",
            "dataUltimoVencimento": "2025-11-04",
            "geradoEm": "2025-07-04T19:19:36.170029Z",
            "dataEfetivacao": "2025-07-04",
            "dataPagamento": "1983-03-04T04:57:04.674Z",
            "proposta": "P255956VCNBJW5",
            "taxaContrato": 5.19,
            "taxaIrr": 5.190021577504,
            "taxaCetMes": 5.63,
            "taxaCetAno": 92.84,
            "taxaContratoAno": 83.52,
            "taxaIof": 3,
            "taxaIofComplementar": 0.38,
            "comissao": 0,
            "taxaMulta": 2,
            "diasCobrancaMulta": 1,
            "valorLiberado": 10000,
            "financeiraValorAPagar": 10000,
            "valorIof": 104.3,
            "valorTarifas": 0,
            "valorJuros": 1391.54,
            "valorRecebivel": 2873.96,
            "valorSeguro": 0,
            "valorFinanciado": 10104.3,
            "prazo": 4,
            "dataSolicitacao": "2025-07-04",
            "modalidade": "pessoal",
            "origem": "novo-contrato",
            "valorParcela": 2873.96,
            "parcelasInfo": {
                "emAtraso": {
                    "recebiveis": [
                        "consectetur",
                        "et nulla",
                        "sunt est deserunt dolore"
                    ],
                    "total": 0
                },
                "pagas": {
                    "recebiveis": [
                        "Excepteur cupidatat eiusmod ullamco"
                    ],
                    "total": 0
                },
                "pendentes": {
                    "recebiveis": [
                        "officia id sed anim quis",
                        "officia aliqua pariatur quis"
                    ],
                    "total": 0
                }
            },
            "ccbOriginalPdf": "https://onidata-creditorapi-hpay-hmg-storage.s3.amazonaws.com/AM6wkTEWLSNP/ccb/original/ccb_C255956VCNBJW5_original.pdf?AWSAccessKeyId=ASIA6FMPYFMASYGEEYBF&Signature=NBHBqpV8fbXIpw3Wi0iz%2FyPMl%2Fk%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEMv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCIA5rx8EmmmqMkEGlZiJxj16sMGFtJSDIqYPpcrjWCclrAiA9nFW3w6LEW4P9%2FUfwObzESxH%2FmR2qa8jAuy%2BQXk%2F9birwAwjU%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDk3MzY0ODQ0MDA2NSIM%2BmWbBGGVpNvIU1nYKsQDB2t21qBVYsgE0Jvog01lXfQ%2BLP%2F5vBu37rz%2BRoJ6nZGKpu%2BKTaE6zxIx7ZrvoahMnwImTo0KWqDWSn0D39uEmOQPGm%2Fnfv87bpZdunD4HsSVhlO%2FukSEZJJaIMXet5rsqjUmMPe5FYjiO5sNYiqCafwebbYQgtvUSa7Bvumoe7x5lnbVh02p72TcNOdXnzxcyO7%2FOV%2Bcz0PE0QCm70u41GBEGq6ub7HZhVFCTyZP2qw5Os%2BCxP3RRvewo%2FXEw5HUAhTrsEnLQywIcvlu29mCkt488gPid7A77rFommeOxXASYhgV1RqzxFwQJRNJAcWFwi5JF5nJHf7XZGcQ4U0dSou%2B5pWxpBgQGU1qC6dn6dhdR737vVz8OGF%2B6nW3KtEAhrvDMmNdyfvW%2FlIA4Cyqsx9I7wFbobSPQZYiXhU9Doznwkabc1iKdezPWhbZ%2BNW3gPrPcmV6r5n8ilRpl5bcNK%2FrCWKcWXXuIbrviE%2BYBq7LfigsXaiaEvlHWhAhUyNw%2BoWZ71PDAdwpmgbjMfn7rjdsKxWviskv69CuiwppJVkg7WlSvzlF1LIP5%2B1ISM7E2ukuIH2tV7LsqY0CMYn8DvgPEk8w%2Bd7DwwY6pgHYl1qzGMLSRx%2BHfpLu3R6%2BnujzbuyuWZpkPXnDL3AEXftX5jtVMj7Y3BzTGEZK6lE5X3t4rgW9eB8ZSPXdWviaSW0PE48nq1MjOajc2jVV98HFaONewG0UdYQ48p2R3W%2B1se%2FSZva6jjWomSUsRWFPoQF0SR5xlVViGn1SBy3TbArJCOTqBYocNU64xFjGtYyFFWny0ULk1zWNi6T0Ji6kU%2Ba%2Fgvr%2B&Expires=1752236750",
            "saldoDevedor": 0,
            "taxaPermanencia": 1,
            "assinaturaInfo": {
                "ip": "35.169.112.65",
                "data": "2025-07-04T19:20:09.99192Z",
                "browser": "okhttp/4.9.3",
                "localizacao": {
                    "coords": {
                        "accuracy": "54545",
                        "latitude": "16515",
                        "longitude": "45465654"
                    },
                    "timestamp": 0
                },
                "geolocalizacao": {}
            },
            "alteradoEm": "2025-07-04T19:50:14.309589Z",
            "statusAlteradoEm": "2025-07-04T19:50:14.258424Z",
            "canalAtendimento": "canal",
            "cpfOperador": "498.557.378-73",
            "nomeOperador": "José Gomes",
            "statusDescricao": "incididunt esse ullamco qui consectetur",
            "renegociacaoDe": [],
            "renegociadoPor": [],
            "valorALiquidar": 0,
            "pagamento": {
                "banco": "001",
                "instituicao": "F8oOuQmQg4lK",
                "conta": "12345",
                "contaDac": "3",
                "agencia": "0001",
                "agenciaDac": "3",
                "tipo": "corrente",
                "clienteDesde": "individual",
                "individualOuConjunta": "individual",
                "bancoNome": "Banco do Brasil S.A.",
                "tipoChavePix": "email",
                "chavePix": "[email protected]"
            },
            "canal": {
                "nome": "HPAY BANK",
                "id": "Yl6W2r5RXpBK"
            },
            "documentacaoComprovacao": {},
            "cliente": "rKmrZAaCyV1T",
            "cpf": "385.266.344-02",
            "nome": "Teste teste",
            "sobrenome": "Teste da silva",
            "promotora": "Não informado",
            "dataNascimento": "2000-01-01",
            "nascimentoUf": "SP",
            "sexo": "M",
            "nacionalidade": "Brasileiro",
            "estadoCivil": "solteiro",
            "nomePai": "João Batista Rodrigues",
            "nomeMae": "Maria Aparecida da Silva",
            "telefoneCelular": "+5598984769292",
            "telefoneFixo": "+5598984769292",
            "cargo": "Tecnologia da Informação",
            "salarioBruto": 13500,
            "salarioLiquido": 12000,
            "escolaridade": "Ensino superior",
            "email": "[email protected]",
            "dataCancelamento": "2025-07-07",
            "dataPrevistaCredito": "2025-06-17",
            "dataEfetivacaoTed": "2025-04-11",
            "estornadoEm": "2025-05-02T17:22:25.258961Z",
            "criadoEm": "2025-04-11T18:00:35.165205Z",
            "utilizaValorJusto": true,
            "renegociacaoExterna": false,
            "metadados": {
                "additionalProp1": {},
                "additionalProp2": {},
                "additionalProp3": {}
            },
            "suspensaoCobranca": false,
            "suspensaoEm": "2025-05-02T17:22:25.52209Z"
        },
        {
            "id": "C255956VCNBJW5",
            "localizador": "C255956VCNBJW5",
            "financeira": {
                "id": "AM6wkTEWLSNP",
                "razaoSocial": "Hpay Sociedade de Crédito Direto S/A",
                "nomeFantasia": "Hpay",
                "cnpj": "57.523.215/0001-04",
                "antecipacaoDecrescente": false,
                "sacEmail": "[email protected]",
                "sacTelefone": "(11) 3003-2850",
                "limiteDiasAtrasoAntecipacao": 0,
                "centroDeCustoPorConvenio": false,
                "sufixoContratoPorConvenio": false,
                "configuraCarimboPorConvenio": false
            },
            "clienteInfoNoContrato": {
                "cpf": "451.987.369-02",
                "email": "[email protected]",
                "nome": "Teste teste",
                "sobrenome": "Teste da silva",
                "dataNascimento": "2000-01-01",
                "nascimentoUf": "SP",
                "sexo": "M",
                "documento": {
                    "tipo": "RG",
                    "numero": "123456789",
                    "dataEmissao": "2010-04-20",
                    "emissor": "SSP",
                    "uf": "SP"
                },
                "endereco": {
                    "cep": "04533-013",
                    "logradouro": "Rua Tabapuã",
                    "numero": "841",
                    "complemento": "de 781 a 989 - lado ímpar",
                    "bairro": "Itaim Bibi",
                    "uf": "SP",
                    "cidade": "São Paulo",
                    "pais": "BR",
                    "residenciaTipo": "alugada",
                    "residenciaTempo": 45
                },
                "nacionalidade": "Brasileiro",
                "estadoCivil": "solteiro",
                "nomePai": "João Batista Rodrigues",
                "nomeMae": "Maria Aparecida da Silva",
                "telefoneCelular": "+5598984769292",
                "telefoneFixo": "+5598984769292",
                "pagamento": {
                    "banco": "069",
                    "instituicao": "gCRTsnq5LeB2",
                    "conta": "987654",
                    "contaDac": "0",
                    "agencia": "1234",
                    "agenciaDac": "0",
                    "tipo": "corrente",
                    "individualOuConjunta": "individual",
                    "bancoNome": "Banco Crefisa S.A.",
                    "telefone": "(57) 55932-4514",
                    "nomeGerente": "labore non quis sunt",
                    "tipoChavePix": "email",
                    "chavePix": "[email protected]"
                },
                "cargo": "Tecnologia da Informação",
                "salario": 13500,
                "salarioBruto": 12931451.211852044,
                "escolaridade": "ensino superior",
                "resourcetype": "ContratoCP"
            },
            "status": "APROVADA",
            "dataPrimeiroVencimento": "2025-08-04",
            "dataUltimoVencimento": "2025-11-04",
            "geradoEm": "2025-07-04T19:19:36.170029Z",
            "dataEfetivacao": "2025-07-04",
            "dataPagamento": "1968-12-30T21:20:44.513Z",
            "proposta": "P255956VCNBJW5",
            "taxaContrato": 5.19,
            "taxaIrr": 5.190021577504,
            "taxaCetMes": 5.63,
            "taxaCetAno": 92.84,
            "taxaContratoAno": 83.52,
            "taxaIof": 3,
            "taxaIofComplementar": 0.38,
            "comissao": 0,
            "taxaMulta": 2,
            "diasCobrancaMulta": 1,
            "valorLiberado": 10000,
            "financeiraValorAPagar": 10000,
            "valorIof": 104.3,
            "valorTarifas": 0,
            "valorJuros": 1391.54,
            "valorRecebivel": 2873.96,
            "valorSeguro": 0,
            "valorFinanciado": 10104.3,
            "prazo": 4,
            "dataSolicitacao": "2025-07-04",
            "modalidade": "pessoal",
            "origem": "novo-contrato",
            "valorParcela": 2873.96,
            "parcelasInfo": {
                "emAtraso": {
                    "recebiveis": [
                        "qui commodo laborum",
                        "non est"
                    ],
                    "total": 0
                },
                "pagas": {
                    "recebiveis": [
                        "adipisicing nostrud",
                        "do ut incididunt proident Lorem",
                        "esse et"
                    ],
                    "total": 0
                },
                "pendentes": {
                    "recebiveis": [
                        "reprehenderit sed culpa"
                    ],
                    "total": 0
                }
            },
            "ccbOriginalPdf": "https://onidata-creditorapi-hpay-hmg-storage.s3.amazonaws.com/AM6wkTEWLSNP/ccb/original/ccb_C255956VCNBJW5_original.pdf?AWSAccessKeyId=ASIA6FMPYFMASYGEEYBF&Signature=NBHBqpV8fbXIpw3Wi0iz%2FyPMl%2Fk%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEMv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCIA5rx8EmmmqMkEGlZiJxj16sMGFtJSDIqYPpcrjWCclrAiA9nFW3w6LEW4P9%2FUfwObzESxH%2FmR2qa8jAuy%2BQXk%2F9birwAwjU%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDk3MzY0ODQ0MDA2NSIM%2BmWbBGGVpNvIU1nYKsQDB2t21qBVYsgE0Jvog01lXfQ%2BLP%2F5vBu37rz%2BRoJ6nZGKpu%2BKTaE6zxIx7ZrvoahMnwImTo0KWqDWSn0D39uEmOQPGm%2Fnfv87bpZdunD4HsSVhlO%2FukSEZJJaIMXet5rsqjUmMPe5FYjiO5sNYiqCafwebbYQgtvUSa7Bvumoe7x5lnbVh02p72TcNOdXnzxcyO7%2FOV%2Bcz0PE0QCm70u41GBEGq6ub7HZhVFCTyZP2qw5Os%2BCxP3RRvewo%2FXEw5HUAhTrsEnLQywIcvlu29mCkt488gPid7A77rFommeOxXASYhgV1RqzxFwQJRNJAcWFwi5JF5nJHf7XZGcQ4U0dSou%2B5pWxpBgQGU1qC6dn6dhdR737vVz8OGF%2B6nW3KtEAhrvDMmNdyfvW%2FlIA4Cyqsx9I7wFbobSPQZYiXhU9Doznwkabc1iKdezPWhbZ%2BNW3gPrPcmV6r5n8ilRpl5bcNK%2FrCWKcWXXuIbrviE%2BYBq7LfigsXaiaEvlHWhAhUyNw%2BoWZ71PDAdwpmgbjMfn7rjdsKxWviskv69CuiwppJVkg7WlSvzlF1LIP5%2B1ISM7E2ukuIH2tV7LsqY0CMYn8DvgPEk8w%2Bd7DwwY6pgHYl1qzGMLSRx%2BHfpLu3R6%2BnujzbuyuWZpkPXnDL3AEXftX5jtVMj7Y3BzTGEZK6lE5X3t4rgW9eB8ZSPXdWviaSW0PE48nq1MjOajc2jVV98HFaONewG0UdYQ48p2R3W%2B1se%2FSZva6jjWomSUsRWFPoQF0SR5xlVViGn1SBy3TbArJCOTqBYocNU64xFjGtYyFFWny0ULk1zWNi6T0Ji6kU%2Ba%2Fgvr%2B&Expires=1752236750",
            "saldoDevedor": 0,
            "taxaPermanencia": 1,
            "assinaturaInfo": {
                "ip": "35.169.112.65",
                "data": "2025-07-04T19:20:09.99192Z",
                "browser": "okhttp/4.9.3",
                "localizacao": {
                    "coords": {
                        "accuracy": "54545",
                        "latitude": "16515",
                        "longitude": "45465654"
                    },
                    "timestamp": 0
                },
                "geolocalizacao": {}
            },
            "alteradoEm": "2025-07-04T19:50:14.309589Z",
            "statusAlteradoEm": "2025-07-04T19:50:14.258424Z",
            "canalAtendimento": "canal",
            "cpfOperador": "498.557.378-73",
            "nomeOperador": "José Gomes",
            "statusDescricao": "culpa officia veniam ullamco",
            "renegociacaoDe": [],
            "renegociadoPor": [],
            "valorALiquidar": 0,
            "pagamento": {
                "banco": "001",
                "instituicao": "F8oOuQmQg4lK",
                "conta": "12345",
                "contaDac": "3",
                "agencia": "0001",
                "agenciaDac": "3",
                "tipo": "corrente",
                "clienteDesde": "individual",
                "individualOuConjunta": "individual",
                "bancoNome": "Banco do Brasil S.A.",
                "tipoChavePix": "email",
                "chavePix": "[email protected]"
            },
            "canal": {
                "nome": "HPAY BANK",
                "id": "Yl6W2r5RXpBK"
            },
            "documentacaoComprovacao": {},
            "cliente": "rKmrZAaCyV1T",
            "cpf": "385.266.344-02",
            "nome": "Teste teste",
            "sobrenome": "Teste da silva",
            "promotora": "Não informado",
            "dataNascimento": "2000-01-01",
            "nascimentoUf": "SP",
            "sexo": "M",
            "nacionalidade": "Brasileiro",
            "estadoCivil": "solteiro",
            "nomePai": "João Batista Rodrigues",
            "nomeMae": "Maria Aparecida da Silva",
            "telefoneCelular": "+5598984769292",
            "telefoneFixo": "+5598984769292",
            "cargo": "Tecnologia da Informação",
            "salarioBruto": 13500,
            "salarioLiquido": 12000,
            "escolaridade": "Ensino superior",
            "email": "[email protected]",
            "dataCancelamento": "2025-07-07",
            "dataPrevistaCredito": "2025-06-17",
            "dataEfetivacaoTed": "2025-04-11",
            "estornadoEm": "2025-05-02T17:22:25.258961Z",
            "criadoEm": "2025-04-11T18:00:35.165205Z",
            "utilizaValorJusto": true,
            "renegociacaoExterna": false,
            "metadados": {
                "additionalProp1": {},
                "additionalProp2": {},
                "additionalProp3": {}
            },
            "suspensaoCobranca": false,
            "suspensaoEm": "2025-05-02T17:22:25.52209Z"
        },
        {
            "id": "C255956VCNBJW5",
            "localizador": "C255956VCNBJW5",
            "financeira": {
                "id": "AM6wkTEWLSNP",
                "razaoSocial": "Hpay Sociedade de Crédito Direto S/A",
                "nomeFantasia": "Hpay",
                "cnpj": "57.523.215/0001-04",
                "antecipacaoDecrescente": false,
                "sacEmail": "[email protected]",
                "sacTelefone": "(11) 3003-2850",
                "limiteDiasAtrasoAntecipacao": 0,
                "centroDeCustoPorConvenio": false,
                "sufixoContratoPorConvenio": false,
                "configuraCarimboPorConvenio": false
            },
            "clienteInfoNoContrato": {
                "cpf": "451.987.369-02",
                "email": "[email protected]",
                "nome": "Teste teste",
                "sobrenome": "Teste da silva",
                "dataNascimento": "2000-01-01",
                "nascimentoUf": "SP",
                "sexo": "M",
                "documento": {
                    "tipo": "RG",
                    "numero": "123456789",
                    "dataEmissao": "2010-04-20",
                    "emissor": "SSP",
                    "uf": "SP"
                },
                "endereco": {
                    "cep": "04533-013",
                    "logradouro": "Rua Tabapuã",
                    "numero": "841",
                    "complemento": "de 781 a 989 - lado ímpar",
                    "bairro": "Itaim Bibi",
                    "uf": "SP",
                    "cidade": "São Paulo",
                    "pais": "BR",
                    "residenciaTipo": "alugada",
                    "residenciaTempo": 45
                },
                "nacionalidade": "Brasileiro",
                "estadoCivil": "solteiro",
                "nomePai": "João Batista Rodrigues",
                "nomeMae": "Maria Aparecida da Silva",
                "telefoneCelular": "+5598984769292",
                "telefoneFixo": "+5598984769292",
                "pagamento": {
                    "banco": "069",
                    "instituicao": "gCRTsnq5LeB2",
                    "conta": "987654",
                    "contaDac": "0",
                    "agencia": "1234",
                    "agenciaDac": "0",
                    "tipo": "corrente",
                    "individualOuConjunta": "individual",
                    "bancoNome": "Banco Crefisa S.A.",
                    "telefone": "+55 (89) 6274-3668",
                    "nomeGerente": "tempor ut",
                    "tipoChavePix": "email",
                    "chavePix": "[email protected]"
                },
                "cargo": "Tecnologia da Informação",
                "salario": 13500,
                "salarioBruto": 57664742.87603122,
                "escolaridade": "ensino superior",
                "resourcetype": "ContratoCP"
            },
            "status": "APROVADA",
            "dataPrimeiroVencimento": "2025-08-04",
            "dataUltimoVencimento": "2025-11-04",
            "geradoEm": "2025-07-04T19:19:36.170029Z",
            "dataEfetivacao": "2025-07-04",
            "dataPagamento": "1948-06-30T21:02:39.540Z",
            "proposta": "P255956VCNBJW5",
            "taxaContrato": 5.19,
            "taxaIrr": 5.190021577504,
            "taxaCetMes": 5.63,
            "taxaCetAno": 92.84,
            "taxaContratoAno": 83.52,
            "taxaIof": 3,
            "taxaIofComplementar": 0.38,
            "comissao": 0,
            "taxaMulta": 2,
            "diasCobrancaMulta": 1,
            "valorLiberado": 10000,
            "financeiraValorAPagar": 10000,
            "valorIof": 104.3,
            "valorTarifas": 0,
            "valorJuros": 1391.54,
            "valorRecebivel": 2873.96,
            "valorSeguro": 0,
            "valorFinanciado": 10104.3,
            "prazo": 4,
            "dataSolicitacao": "2025-07-04",
            "modalidade": "pessoal",
            "origem": "novo-contrato",
            "valorParcela": 2873.96,
            "parcelasInfo": {
                "emAtraso": {
                    "recebiveis": [
                        "Excepteur ullamco"
                    ],
                    "total": 0
                },
                "pagas": {
                    "recebiveis": [
                        "ex qui",
                        "incididunt mollit nisi amet do"
                    ],
                    "total": 0
                },
                "pendentes": {
                    "recebiveis": [
                        "ad deserunt aute"
                    ],
                    "total": 0
                }
            },
            "ccbOriginalPdf": "https://onidata-creditorapi-hpay-hmg-storage.s3.amazonaws.com/AM6wkTEWLSNP/ccb/original/ccb_C255956VCNBJW5_original.pdf?AWSAccessKeyId=ASIA6FMPYFMASYGEEYBF&Signature=NBHBqpV8fbXIpw3Wi0iz%2FyPMl%2Fk%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEMv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCIA5rx8EmmmqMkEGlZiJxj16sMGFtJSDIqYPpcrjWCclrAiA9nFW3w6LEW4P9%2FUfwObzESxH%2FmR2qa8jAuy%2BQXk%2F9birwAwjU%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDk3MzY0ODQ0MDA2NSIM%2BmWbBGGVpNvIU1nYKsQDB2t21qBVYsgE0Jvog01lXfQ%2BLP%2F5vBu37rz%2BRoJ6nZGKpu%2BKTaE6zxIx7ZrvoahMnwImTo0KWqDWSn0D39uEmOQPGm%2Fnfv87bpZdunD4HsSVhlO%2FukSEZJJaIMXet5rsqjUmMPe5FYjiO5sNYiqCafwebbYQgtvUSa7Bvumoe7x5lnbVh02p72TcNOdXnzxcyO7%2FOV%2Bcz0PE0QCm70u41GBEGq6ub7HZhVFCTyZP2qw5Os%2BCxP3RRvewo%2FXEw5HUAhTrsEnLQywIcvlu29mCkt488gPid7A77rFommeOxXASYhgV1RqzxFwQJRNJAcWFwi5JF5nJHf7XZGcQ4U0dSou%2B5pWxpBgQGU1qC6dn6dhdR737vVz8OGF%2B6nW3KtEAhrvDMmNdyfvW%2FlIA4Cyqsx9I7wFbobSPQZYiXhU9Doznwkabc1iKdezPWhbZ%2BNW3gPrPcmV6r5n8ilRpl5bcNK%2FrCWKcWXXuIbrviE%2BYBq7LfigsXaiaEvlHWhAhUyNw%2BoWZ71PDAdwpmgbjMfn7rjdsKxWviskv69CuiwppJVkg7WlSvzlF1LIP5%2B1ISM7E2ukuIH2tV7LsqY0CMYn8DvgPEk8w%2Bd7DwwY6pgHYl1qzGMLSRx%2BHfpLu3R6%2BnujzbuyuWZpkPXnDL3AEXftX5jtVMj7Y3BzTGEZK6lE5X3t4rgW9eB8ZSPXdWviaSW0PE48nq1MjOajc2jVV98HFaONewG0UdYQ48p2R3W%2B1se%2FSZva6jjWomSUsRWFPoQF0SR5xlVViGn1SBy3TbArJCOTqBYocNU64xFjGtYyFFWny0ULk1zWNi6T0Ji6kU%2Ba%2Fgvr%2B&Expires=1752236750",
            "saldoDevedor": 0,
            "taxaPermanencia": 1,
            "assinaturaInfo": {
                "ip": "35.169.112.65",
                "data": "2025-07-04T19:20:09.99192Z",
                "browser": "okhttp/4.9.3",
                "localizacao": {
                    "coords": {
                        "accuracy": "54545",
                        "latitude": "16515",
                        "longitude": "45465654"
                    },
                    "timestamp": 0
                },
                "geolocalizacao": {}
            },
            "alteradoEm": "2025-07-04T19:50:14.309589Z",
            "statusAlteradoEm": "2025-07-04T19:50:14.258424Z",
            "canalAtendimento": "canal",
            "cpfOperador": "498.557.378-73",
            "nomeOperador": "José Gomes",
            "statusDescricao": "proident",
            "renegociacaoDe": [],
            "renegociadoPor": [],
            "valorALiquidar": 0,
            "pagamento": {
                "banco": "001",
                "instituicao": "F8oOuQmQg4lK",
                "conta": "12345",
                "contaDac": "3",
                "agencia": "0001",
                "agenciaDac": "3",
                "tipo": "corrente",
                "clienteDesde": "individual",
                "individualOuConjunta": "individual",
                "bancoNome": "Banco do Brasil S.A.",
                "tipoChavePix": "email",
                "chavePix": "[email protected]"
            },
            "canal": {
                "nome": "HPAY BANK",
                "id": "Yl6W2r5RXpBK"
            },
            "documentacaoComprovacao": {},
            "cliente": "rKmrZAaCyV1T",
            "cpf": "385.266.344-02",
            "nome": "Teste teste",
            "sobrenome": "Teste da silva",
            "promotora": "Não informado",
            "dataNascimento": "2000-01-01",
            "nascimentoUf": "SP",
            "sexo": "M",
            "nacionalidade": "Brasileiro",
            "estadoCivil": "solteiro",
            "nomePai": "João Batista Rodrigues",
            "nomeMae": "Maria Aparecida da Silva",
            "telefoneCelular": "+5598984769292",
            "telefoneFixo": "+5598984769292",
            "cargo": "Tecnologia da Informação",
            "salarioBruto": 13500,
            "salarioLiquido": 12000,
            "escolaridade": "Ensino superior",
            "email": "[email protected]",
            "dataCancelamento": "2025-07-07",
            "dataPrevistaCredito": "2025-06-17",
            "dataEfetivacaoTed": "2025-04-11",
            "estornadoEm": "2025-05-02T17:22:25.258961Z",
            "criadoEm": "2025-04-11T18:00:35.165205Z",
            "utilizaValorJusto": true,
            "renegociacaoExterna": false,
            "metadados": {
                "additionalProp1": {},
                "additionalProp2": {},
                "additionalProp3": {}
            },
            "suspensaoCobranca": false,
            "suspensaoEm": "2025-05-02T17:22:25.52209Z"
        }
    ]
}

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros Query

fields

string

opcional

Campos a serem retornados na pesquisa, separados por vírgula e sem espaço. > Nota: Utilize para limitar a pesquisa somente aos campos inseridos

Exemplo:

financeira

allFields

boolean

opcional

Indica se deve retornar todos os campos.

Exemplo:

true

status

enum<string>

opcional

Status do contrato de empréstimo simplificado.

Valores permitidos:

CANCELADOESTORNADO EFETIVADO

Exemplo:

estornado,efetivado,cancelado

string

opcional

Permite pesquisar por nome, ID ou demais atributos vinculados ao registro.

Exemplo:

Teste

limit

integer <int32>

opcional

Limite de resultados por página.

Exemplo:

offset

integer <int32>

opcional

Número de linhas a serem puladas.

Exemplo:

Parâmetros Header

Authorization

string

opcional

Header HTTP utilizado para autenticação do cliente. O valor deve ser um token JWT válido precedido do prefixo Bearer.

Exemplo:

Bearer 123

string

opcional

Tipo do conteúdo aceito.

Exemplo:

*/*

User-Funcao

string

opcional

Chave de função fornecida pelo parceiro.

Exemplo:

OF0aX2xTB47P

Respostas

🟢200Success

application/json

Body

count

integer

opcional

Quantidade de registros a serem retornados.

string

opcional

Próxima página.

results

array [object {80}]

opcional

Informações sobre os resultados.

string

opcional

Identificador da proposta financeira.

Exemplo:

C255956VCNBJW5

localizador

string

opcional

Localizador da proposta financeira.

Exemplo:

C255956VCNBJW5

financeira

object

opcional

Informações sobre a entidade financeira.

clienteInfoNoContrato

object

opcional

Informações de cliente no contrato.

status

enum<string>

opcional

Status do contrato.

Valores permitidos:

CANCELADAANALISE-CREDITONEGADAAPROVADAERROMESA-ERRORASCUNHO

Exemplo:

APROVADA

dataPrimeiroVencimento

string <date>

opcional

Data do primeiro vencimento.

Exemplo:

2025-08-04

dataUltimoVencimento

string <date>

opcional

Data do último vencimento.

Exemplo:

2025-11-04

geradoEm

string <date-time>

opcional

Data e hora do boleto gerado.

Exemplo:

2025-07-04T19:19:36.170029Z

dataEfetivacao

string <date>

opcional

Data da efetivação do contrato.

Exemplo:

2025-07-04

dataPagamento

string <date-time>

opcional

Data e hora do pagamento.

proposta

string

opcional

Identificador da proposta.

Exemplo:

P255956VCNBJW5

taxaContrato

number

opcional

Taxa de contrato.

Exemplo:

5.19

taxaIrr

number

opcional

Taxa de IRR (Interal Rate of Return).

Exemplo:

5.190021577504

taxaCetMes

number

opcional

Taxa CET ao mês.

Exemplo:

5.63

taxaCetAno

number

opcional

Taxa CET ao ano.

Exemplo:

92.84

taxaContratoAno

number

opcional

Taxa de contrato ao ano.

Exemplo:

83.52

taxaIof

number

opcional

Taxa IOF.

Exemplo:

taxaIofComplementar

number

opcional

Taxa IOF complementar.

Exemplo:

0.38

comissao

number

opcional

Valor da comissão.

Exemplo:

taxaMulta

number

opcional

Taxa de multa.

Exemplo:

diasCobrancaMulta

integer <int32>

opcional

Quantidade de dias para cobrança de multa.

Exemplo:

valorLiberado

number

opcional

Valor liberado para empréstimo.

Exemplo:

10000

financeiraValorAPagar

number

opcional

Valor a pagar pela financeira.

Exemplo:

10000

valorIof

number

opcional

Valor IOF.

Exemplo:

104.3

valorTarifas

number

opcional

Valor das tarifas.

Exemplo:

valorJuros

number

opcional

Valor de juros

Exemplo:

1391.54

valorRecebivel

number

opcional

Valor total a ser recebido.

Exemplo:

2873.96

valorSeguro

number

opcional

Valor do seguro.

Exemplo:

valorFinanciado

number

opcional

Valor financiado.

Exemplo:

10104.3

prazo

integer <int32>

opcional

Prazo do contrato, em meses.

Exemplo:

dataSolicitacao

string <date>

opcional

Data de solicitação.

Exemplo:

2025-07-04

modalidade

string

opcional

Modalidade do contrato.

Exemplo:

pessoal

origem

enum<string>

opcional

Origem do contrato.

Valores permitidos:

novo-contratorenegociacaoportabilidade

Exemplo:

novo-contrato

valorParcela

number

opcional

Valor da parcela.

Exemplo:

2873.96

parcelasInfo

object

opcional

Informações sobre parcelamento.

ccbOriginalPdf

string

opcional

Link do documento em .PDF.

Exemplo:

https://onidata-creditorapi-hpay-hmg-storage.s3.amazonaws.com/AM6wkTEWLSNP/ccb/original/ccb_C255956VCNBJW5_original.pdf?AWSAccessKeyId=ASIA6FMPYFMASYGEEYBF&Signature=NBHBqpV8fbXIpw3Wi0iz%2FyPMl%2Fk%3D&x-amz-security-token=IQoJb3JpZ2luX2VjEMv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJGMEQCIA5rx8EmmmqMkEGlZiJxj16sMGFtJSDIqYPpcrjWCclrAiA9nFW3w6LEW4P9%2FUfwObzESxH%2FmR2qa8jAuy%2BQXk%2F9birwAwjU%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAMaDDk3MzY0ODQ0MDA2NSIM%2BmWbBGGVpNvIU1nYKsQDB2t21qBVYsgE0Jvog01lXfQ%2BLP%2F5vBu37rz%2BRoJ6nZGKpu%2BKTaE6zxIx7ZrvoahMnwImTo0KWqDWSn0D39uEmOQPGm%2Fnfv87bpZdunD4HsSVhlO%2FukSEZJJaIMXet5rsqjUmMPe5FYjiO5sNYiqCafwebbYQgtvUSa7Bvumoe7x5lnbVh02p72TcNOdXnzxcyO7%2FOV%2Bcz0PE0QCm70u41GBEGq6ub7HZhVFCTyZP2qw5Os%2BCxP3RRvewo%2FXEw5HUAhTrsEnLQywIcvlu29mCkt488gPid7A77rFommeOxXASYhgV1RqzxFwQJRNJAcWFwi5JF5nJHf7XZGcQ4U0dSou%2B5pWxpBgQGU1qC6dn6dhdR737vVz8OGF%2B6nW3KtEAhrvDMmNdyfvW%2FlIA4Cyqsx9I7wFbobSPQZYiXhU9Doznwkabc1iKdezPWhbZ%2BNW3gPrPcmV6r5n8ilRpl5bcNK%2FrCWKcWXXuIbrviE%2BYBq7LfigsXaiaEvlHWhAhUyNw%2BoWZ71PDAdwpmgbjMfn7rjdsKxWviskv69CuiwppJVkg7WlSvzlF1LIP5%2B1ISM7E2ukuIH2tV7LsqY0CMYn8DvgPEk8w%2Bd7DwwY6pgHYl1qzGMLSRx%2BHfpLu3R6%2BnujzbuyuWZpkPXnDL3AEXftX5jtVMj7Y3BzTGEZK6lE5X3t4rgW9eB8ZSPXdWviaSW0PE48nq1MjOajc2jVV98HFaONewG0UdYQ48p2R3W%2B1se%2FSZva6jjWomSUsRWFPoQF0SR5xlVViGn1SBy3TbArJCOTqBYocNU64xFjGtYyFFWny0ULk1zWNi6T0Ji6kU%2Ba%2Fgvr%2B&Expires=1752236750

saldoDevedor

number

opcional

Valor do saldo devedor.

Exemplo:

taxaPermanencia

number

opcional

Valor da taxa de permanência.

Exemplo:

assinaturaInfo

object

opcional

Informações sobre a assinatura do contrato.

alteradoEm

string <date-time>

opcional

Data e hora da última alteração nos registros.

Exemplo:

2025-07-04T19:50:14.309589Z

statusAlteradoEm

string <date-time>

opcional

Data e hora de alteração do status.

Exemplo:

2025-07-04T19:50:14.258424Z

canalAtendimento

string

opcional

Canal de atendimento.

Exemplo:

canal

cpfOperador

string

opcional

CPF do operador, com 11 dígitos.

Exemplo:

498.557.378-73

nomeOperador

string

opcional

Nome do operador.

Exemplo:

José Gomes

statusDescricao

string

opcional

Descrição do status do contrato.

renegociacaoDe

array [object]

opcional

Informações sobre renegociação.

renegociadoPor

array [object]

opcional

Informações da renegociação de origem.

valorALiquidar

number

opcional

Valor do contrato a ser liquidado.

Exemplo:

pagamento

object

opcional

Informações de pagamento do empréstimo.

canal

object

opcional

Informações sobre o canal para empréstimo.

documentacaoComprovacao

object

opcional

Documento do cliente para comprovação do empréstimo pessoal.

cliente

string

opcional

Identificador do cliente.

Exemplo:

rKmrZAaCyV1T

cpf

string

opcional

CPF, com 11 dígitos.

Exemplo:

385.266.344-02

nome

string

opcional

Nome.

Exemplo:

Teste teste

sobrenome

string

opcional

Sobrenome.

Exemplo:

Teste da silva

promotora

string

opcional

Nome da promotora de crédito.

Exemplo:

Não informado

dataNascimento

string <date>

opcional

Data de nascimento do cliente.

Exemplo:

2000-01-01

nascimentoUf

string

opcional

Unidade federativa de nascimento do cliente.

Exemplo:

sexo

enum<string>

opcional

Sexo do cliente.

Valores permitidos:

Exemplo:

nacionalidade

string

opcional

Nacionalidade do cliente.

Exemplo:

Brasileiro

estadoCivil

string

opcional

Estado civil do cliente.

Exemplo:

solteiro

nomePai

string

opcional

Nome do pai do cliente.

Exemplo:

João Batista Rodrigues

nomeMae

string

opcional

Nome da mãe do cliente.

Exemplo:

Maria Aparecida da Silva

telefoneCelular

string

opcional

Telefone celular do cliente, com 9 dígitos e DDD obrigatório.

Exemplo:

+5598984769292

telefoneFixo

string

opcional

Telefone fixo do cliente, com 8 dígitos e DDD obrigatório.

Exemplo:

+5598984769292

cargo

string

opcional

Cargo do cliente.

Exemplo:

Tecnologia da Informação

salarioBruto

number <double>

opcional

Salário bruto do cliente.

Exemplo:

13500

salarioLiquido

number <double>

opcional

Salário líquido do cliente.

Exemplo:

12000

escolaridade

string

opcional

Grau de escolaridade do cliente.

Exemplo:

Ensino superior

string

opcional

E-mail do cliente.

Exemplo:

[email protected]

dataCancelamento

string <date>

opcional

Data do cancelamento do contrato.

Exemplo:

2025-07-07

dataPrevistaCredito

string <date>

opcional

Data de previsão do crédito

Exemplo:

2025-06-17

dataEfetivacaoTed

string <date>

opcional

Data da realização do TED.

Exemplo:

2025-04-11

estornadoEm

string <date-time>

opcional

Data e hora do estorno.

Exemplo:

2025-05-02T17:22:25.258961Z

criadoEm

string <date-time>

opcional

Data e hora de criação dos registros.

Exemplo:

2025-04-11T18:00:35.165205Z

utilizaValorJusto

boolean

opcional

Indica se a operação utiliza valor justo.

Exemplo:

true

renegociacaoExterna

boolean

opcional

Indica uma renegociação externa.

Exemplo:

false

metadados

object

opcional

Informações em formato JSON, retornado quando o contrato é efetivado ou assinado.

suspensaoCobranca

boolean

opcional

Indica se houve suspensão de cobrança.

Exemplo:

false

suspensaoEm

string <date-time>

opcional

Data e hora da suspensão.

Exemplo:

2025-05-02T17:22:25.52209Z

🟠400Pedido inválido

🟠401Não autorizado

🟠403Proibido

🟠404Registro não encontrado

🔴500Erro do servidor

Página anterior

Consultar informações de contrato

Próxima página

Faturamentos