Tote
HomeAPIsGuiasRelease Notes
HomeAPIsGuiasRelease Notes
Fale conosco
  1. Cadastro de contas
  • Diretrizes Básicas
  • Autenticação
    • Autenticação
  • Acheron
    • Pagamento
      • Cadastrar um pagamento
      • Cancelar um pagamento
      • Criar intenção de pagamento
      • Confirmar intenção de pagamento
      • Cancelar intenção de pagamento
      • Listar intenções de pagamento
      • Criar pagamento via PIX
    • Venda
      • Criar venda com cartão
      • Cancelar venda com cartão
      • Criar venda com portador
      • Cancelar venda com portador
      • Estornar uma venda
    • E-Commerce
      • Criar venda e-commerce
      • Confirmar pagamento e-commerce
      • Listar pagamento e-commerce
      • Cancelar venda e-commerce
      • Gerar token de e-commerce
    • VTEX
      • Criar venda VTEX
      • Confirmar venda VTEX
      • Estornar venda VTEX
      • Cancelar venda VTEX
      • Listar manifesto do provedor de pagamento
    • Simulação
      • Criar simulação
    • Pré-autorização
      • Listar pré-autorização
      • Cancelar valor reservado
      • Listar valor reservado
    • BNPL
      • Confirmar estorno de venda
      • Estornar venda
      • Simular venda
      • Confirmar venda
      • Sensibilizar venda
  • Agenda lojista
    • Agenda
      • Cadastrar recebimento em agenda
      • Cadastrar agenda manual
      • Listar agenda por loja
      • Consultar agenda específica
      • Listar transações pelo ID da agenda ou loja
    • Configurações de Agendas
      • Cadastrar configuração
      • Listar configurações da agenda
      • Alterar configuração de uma loja
    • Modalidade
      • Cadastrar modalidades
      • Listar modalidades
      • Listar modalidade por lançamento
      • Alterar tipo de modalidade
    • Lançamentos
      • Listar lançamentos por loja
      • Cadastrar lançamentos
      • Cadastrar lançamento de ajuste
    • Tipo de ajuste
      • Cadastrar um tipo de ajuste
      • Listar tipo de ajuste
  • Banking
    • Conciliação bancária
      • Gerar saldo para um emissor
      • Gerar extrato para um emissor
      • Gerar arquivos de conciliação
    • Contas
      • Listar contas digitais
    • Pix
      • Transferir pix
      • Listar status do pix
      • Listar transferências Pix
      • Listar informações de chave
  • Biometria
    • Biometria
    • Handshake fortface
      • Iniciar o processo de autenticação biométrica SDK
      • Iniciar o processo de autenticação biométrica Backoffice
    • Biometria
      • Identificar um rosto
      • Cadastrar uma face utilizando o SDK Fortface
      • Cadastrar uma face através do Backoffice da Fortface
  • Broker
    • Enviar mensagem SMS
  • Cartões
    • Portadores
      • Buscar cartão pelo titular
      • Cadastrar portador adicional
      • Listar cartões do adicional
      • Gerar cartão adicional
    • CVV Virtual
      • Ativar CVV Virtual do titular
      • Inativar CVV Virtual
      • Atualizar data de expiração do CVV
    • Senha
      • Cadastrar senha
      • Alterar senha
      • Autenticar senha do cartão
      • Gerar senha e enviar por SMS
    • Bloqueios e Desbloqueios
      • Bloquear um cartão temporariamente
      • Bloquear permanentemente
      • Listar histórico de bloqueios
      • Listar tipos de bloqueio
      • Desbloquear cartão
    • Cartões
      • Solicitar segunda via
      • Trocar cartão pendente
      • Buscar cartão criptografado
      • Listar histórico de cancelamento
      • Listar tipos de cancelamento
      • Gerar um cartão virtual
      • Listar cartão virtual
      • Buscar cartão pelo id
      • Buscar cartão pelo número
      • Buscar cartão pelo CPF
      • Buscar cartão bandeirado
      • Token Merci
      • Trocar cartão do portador
      • Cadastrar Pessoa Jurídica
      • Solicitar troca do cartão
      • Listar BIN
    • No Name
      • Listar lotes de cartão
      • Criar lote de cartões
      • Destruir cartão
      • Vincular cartão ao titular
      • Vincular cartão adicional
      • Destruir lote de cartões
      • Embossar cartões por lote
      • Listar cartões
    • Vipagem
      • Listar cartões bandeirados
      • Emitir segunda via
  • Embossing
    • Cartões
      • Embossing de cartão
      • Bloquear cartão por falha
      • Listar cartões pendentes
    • Impressoras
      • Inativar impressora
      • Ativar impressora
  • Empréstimo
    • Empréstimo Pix Card
      • Enviar arquivo
      • Alterar dados bancários
      • Transferir via Pix
      • Cadastrar pessoa física
      • Simular empréstimo
      • Confirmar empréstimo
      • Aprovar crédito
      • Criar contrato
      • Consultar pessoa
    • Empréstimo FGTS
      • Simular saldo
      • Obter saldo
      • Cadastrar pessoa física
      • Cadastrar operação
      • Submeter para aprovação
      • Consultar informações
      • Listar produto
      • Consultar pessoa
      • Listar operações
      • Acompanhar operação
      • Listar estado civil
      • Listar bancos
  • Faturamentos
    • Parcelamento de fatura
      • Antecipar uma parcela do parcelamento
      • Antecipar todo o parcelamento
      • Buscar parcelamento pendente
      • Buscar parcelamento ativo
      • Simular antecipação
      • Parcelar faturas
    • Ciclos de fatura
      • Consultar ciclos de vencimento
      • Alterar o ciclo de vencimento
    • Consulta de faturas
      • Consultar lançamentos futuros
      • Consultar faturas por período
      • Consultar faturas futuras
      • Consultar última fatura fechada
      • Consultar fatura detalhada
      • Consultar fatura atual
      • Visualizar saldo detalhado
    • Faturas digitais
      • Receber fatura em PDF
      • Aderir à fatura digital
      • Cancelar fatura digital
      • Aderir à fatura por SMS
      • Cancelar fatura por SMS
  • Financiamentos
    • Parcelamento total
      • Simular parcelamento devedor total
    • Parcelamento manual
      • Simular parcelamento manual
  • Gestão de contas
    • Cadastrar cartão físico para titular
  • Lançamentos
    • Ajustes
      • Lançar um ajuste financeiro
      • Listar um ajuste financeiro
      • Lançar ajustes a débito
      • Lançar ajustes a crédito
      • Listar tipos de ajustes
      • Listar faturas ajustadas
      • Lançar um ajuste na fatura
    • Vendas
      • Antecipar venda total
      • Antecipar venda avulsa
    • Pagamentos
    • Antecipação
      • Listar compras passíveis de antecipação
    • Baixas bancárias
      • Estornar lançamento de baixa bancária
      • Lançar baixa báncaria
      • Lançar baixa bancária de pagamento
      • Estornar pagamento de baixa bancária
  • Loja
    • Formas de Pagamentos
      • Listar formas de pagamento
      • Cadastrar forma de pagamento
      • Atualizar forma de pagamento
      • Consultar parcelas de uma loja
    • Tarifas
      • Listar tarifas
      • Cadastrar tarifa
      • Associar tarifa a uma loja
      • Cancelar tarifas com a loja
      • Listar tarifas por loja
      • Consultar uma tarifa
      • Alterar cadastro de uma tarifa
    • Lojas
      • Cadastrar uma loja
      • Consultar uma loja
      • Consultar loja por id externo
      • Listar loja pelo CNPJ
      • Listar lojas
      • Alterar uma loja
  • Pacote SMS
    • Contratar um pacote SMS
    • Cancelar um pacote SMS
    • Consultar pacotes do portador
    • Habilitar celular para adesão do pacote
    • Habilitar celular para receber bônus
    • Consultar pacotes disponíveis
    • Consultar pacotes contratados
  • Parâmetros
    • Listar parâmetros cadastrados
    • Listar parâmetros exibíveis
  • Pix
    • Pix Imediato
      • Listar chaves Pix Imediato
      • Gerar Pix Imediato
      • Listar uma chave Pix Imediato
  • Pix Card
    • PixCard
      • Transferir via Pix
      • Consultar CPF
      • Cadastrar cliente
      • Simular operação
      • Confirmar operação
      • Cadastrar documento do portador
    • Assinatura
      • Listar as assinaturas
      • Cadastrar assinatura
      • Verificar assinaturas para cobrança
      • Listar assinaturas válidas
      • Listar planos
      • Alterar assinatura pelo CPF
    • Conta Digital
      • Listar termos obrigatórios
      • Cadastrar termo obrigatório
      • Cadastrar documento do portador
      • Criar uma conta digital
      • Criar uma conta alias
      • Listar contas pelo identificador
      • Listar informações do portador
    • Transferência
      • Agendar transferência
      • Efetuar transferência
      • Listar status de transferência
      • Listar devoluções
      • Listar transferências
      • Listar agendamentos de transferências
    • Relatórios
      • Listar operações
      • Listar relatórios de assinaturas
      • Listar adesões
    • QR Code
      • Criar QR Code estático
      • Decodificar QR Code
    • Chaves
      • Confirmar reivindicações
      • Fazer reivindicação
      • Cadastrar chave
      • Deletar chave
      • Listar chaves
      • Consultar chaves pelo identificador
      • Listar reivindicações
    • Limites
      • Criar limite de horário
      • Associar conta a grupo de serviço
      • Listar destinos confiáveis
      • Alterar limite do destino confiável
      • Listar limites de horários
      • Listar requisições
      • Remover destino confiável
  • Portadores
    • Gestão de portadores
      • Listar status do portador pelo CPF
      • Listar portadores
      • Alterar dados do portador
      • Alterar status de ativo problemático
      • Listar informações do portador
      • Alterar o limite do portador
      • Bloquear um portador
      • Desbloquear um portador
      • Listar adicionais pelo CPF
      • Listar portadores em lote
      • Listar contas pelo CPF (simplificado)
      • Listar contas pelo CNPJ
      • Alterar produto do portador
      • Listar contas pelo documento
      • Listar contas pelo RG
      • Listar contas pelo nome
      • Alterar vipagem
      • Consultar ciclo do portador
      • Listar contas pelo CPF (completo)
    • Gestão de dependentes
      • Listar dependentes pelo titular
      • Cadastrar dependentes
    • Gestão de telefones
      • Listar telefones
      • Cadastrar telefone
      • Deletar telefone
      • Receber SMS
    • Visualização de histórico
      • Listar histórico do portador
      • Listar ocorrências
      • Listar inadimplências pelo portador
      • Listar o histórico de limites
    • Gestão de senhas
      • Enviar senha por SMS
      • Alterar senha do portador
    • Cadastro de contas
      • Cadastrar uma conta PJ
        POST
      • Cadastrar uma conta PF
        POST
    • Informações da base de dados
      • Listar tipos de bloqueio
      • Listar escolaridades
      • Listar ocupações
    • BNPL
      • Consultar informações do portador
  • Portuno
    • Conta
      • Listar conta
      • Criar uma conta
      • Trocar o segredo da conta
    • Integração
      • Listar integrações
      • Alterar tempo de expiração de uma integração
  • Produtos
    • Produtos
      • Consultar produtos
      • Consultar um produto
    • Serviços financeiros
      • Listar serviços financeiros
  • Recompensa
    • Aderir à anuidade bonificada
    • Cancelar anuidade bonificada
    • Listar anuidades do produto
    • Listar anuidade do portador
    • Listar anuidades
    • Listar as anuidades
    • Cadastrar anuidades
  • Regulatório
    • Listar informações
  • Seguros
    • Seguros
      • Cancelar adesão do titular
      • Aderir seguro para o titular
      • Aderir seguro para dependente
      • Cancelar adesão do dependente
      • Listar seguros de dependentes
      • Listar seguros disponíveis
      • Cancelar um seguro
      • Listar seguros do portador
      • Listar campos de adesão ao seguro
      • Listar campos de adesão do portador
      • Listar seguros cancelados
    • Bilhetes de Seguro
      • Listar bilhetes de um portador
      • Listar o modelo de operação
      • Listar um bilhete de adesão
    • Cobranças e Pagamentos
      • Fazer estímulo de cobrança
    • Termos da Adesão
      • Listar termos de adesão
      • Listar modelos do código de operação
      • Listar termos de um seguro
  • Serviços Bancários
    • Registrar um boleto online
    • Listar pagamentos
    • Listar boleto completo
    • Listar contas habilitadas
  • SMS Notice
    • Processamento
      • Listar os eventos
      • Criar um evento
      • Alterar um evento
      • Listar as variáveis
      • Criar variáveis
      • Listar as transações
      • Criar mensagem para fila
    • Serviços
      • Criar um serviço de SMS
      • Listar serviços cadastrados
      • Alterar um serviço de SMS
      • Listar um serviço específico
    • Pacote de SMS
      • Listar os pacotes de sms
      • Cadastrar pacote SMS
      • Listar um pacote específico
      • Alterar um pacote específico
      • Aderir a um pacote SMS
      • Cancelar uma adesão
      • Listar adesões de um portador
      • Alterar o telefone do pacote
  1. Cadastro de contas

Cadastrar uma conta PF

Sandbox
https://horizon-api-sb.app.rpe.tech
Sandbox
https://horizon-api-sb.app.rpe.tech
POST
https://horizon-api-sb.app.rpe.tech
/api/v1/portadores/contas/pf
Cadastro de contas
Use este endpoint para cadastrar uma conta de pessoa física.
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request POST 'https://horizon-api-sb.app.rpe.tech/api/v1/portadores/contas/pf' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "nome": "Mario da Silva",
    "nomeSocial": "Mario Bros",
    "cpf": "34966451051",
    "dataNascimento": "1988-02-16",
    "rg": "418757896",
    "orgaoEmissor": "SSPPB",
    "dataEmissaoRg": "2003-04-20",
    "renda": 2000,
    "rendaComprovada": true,
    "sexo": "MASCULINO",
    "estadoCivil": "SOLTEIRO",
    "nomeMae": "Maria Aparecida dos Santos",
    "nomePai": "João Carlos dos Santos",
    "idProfissao": 2,
    "enderecoResidencial": {
        "numero": "4020",
        "cep": "58070000",
        "complemento": "Ap 301",
        "logradouro": "Av. Presidente Epitácio Pessoa",
        "bairro": "Lapa",
        "localidade": "João Pessoa",
        "uf": "PB"
    },
    "enderecoComercial": {
        "numero": "4020",
        "cep": "58070000",
        "complemento": "Ap 301",
        "logradouro": "Av. Presidente Epitácio Pessoa",
        "bairro": "Lapa",
        "localidade": "João Pessoa",
        "uf": "PB",
        "empresa": "Empresa 2",
        "departamento": "Pesquisa e Inovação",
        "cnpj": "22130511000160"
    },
    "enderecoAlternativo": {
        "numero": "4020",
        "cep": "58070000",
        "complemento": "Ap 301",
        "logradouro": "Av. Presidente Epitácio Pessoa",
        "bairro": "Lapa",
        "localidade": "João Pessoa",
        "uf": "PB",
        "tipo": "R"
    },
    "tipoEnderecoContato": "RESIDENCIAL",
    "idCiclo": 3,
    "conjuge": {
        "nome": "Maria Aparecida dos Santos",
        "sexo": "MASCULINO",
        "dataNascimento": "1992-10-25",
        "nomeEmpresa": "Empresa 1",
        "idProfissao": 5,
        "telefone": {
            "tipo": "CELULAR",
            "ramal": "4020",
            "area": "83",
            "telefone": "999999999",
            "receberSMS": false,
            "faturaDigital": false
        },
        "cpf": "67815544410",
        "escolaridade": "FUNDAMENTAL_COMPLETO",
        "rg": "963852741",
        "orgaoEmissor": "SSPPB",
        "dataEmissaoRg": "2000-04-15",
        "salario": 2000
    },
    "adicionais": [
        {
            "nome": "Mario Oliveira Barros",
            "cpf": "59822557000",
            "rg": "418757896",
            "dataNascimento": "1988-02-16",
            "sexo": "MASCULINO",
            "grauParentesco": "PAI",
            "nomePersonalizado": "Mari Silva"
        }
    ],
    "dependentes": [
        {
            "nome": "João da Silva",
            "nomeMae": "string",
            "cpf": "91829438000",
            "dataNascimento": "2000-04-15",
            "sexo": "MASCULINO",
            "telefone": {
                "tipo": "CELULAR",
                "ramal": "4020",
                "area": "83",
                "telefone": "999999999",
                "receberSMS": false,
                "faturaDigital": false
            },
            "grauParentesco": "PAI"
        }
    ],
    "referencias": [
        {
            "nome": "Maria Aparecida dos Santos",
            "grauParentesco": "PAI",
            "telefone": {
                "tipo": "CELULAR",
                "ramal": "4020",
                "area": "83",
                "telefone": "999999999",
                "receberSMS": false,
                "faturaDigital": false
            }
        }
    ],
    "idLoja": 15,
    "limiteRotativo": 2000,
    "limiteSaque": 2000,
    "limiteParcelamento": 4000,
    "ocupacao": "OUTROS",
    "email": "mario.silva@email.com",
    "cidadeNatal": "João Pessoa",
    "estadoNatal": "PB",
    "dataAdmissaoProfissao": "1988-02-16",
    "tempoMoradiaAnos": 2,
    "tempoMoradiaMeses": 6,
    "tempoEmpregadoAnos": 2,
    "tipoMoradia": "NAO_INFORMADA",
    "nacionalidade": "Brasileiro",
    "escolaridade": "FUNDAMENTAL_COMPLETO",
    "telefones": [
        {
            "tipo": "CELULAR",
            "ramal": "4020",
            "area": "83",
            "telefone": "999999999",
            "receberSMS": false,
            "faturaDigital": false
        }
    ],
    "idProduto": 1,
    "numeroBeneficio": "1786997312",
    "contratoImpresso": true,
    "utilizaFaturaDigital": false,
    "portadorNecessidadesVisuais": false,
    "inibirEnvioFaturaGrafica": false,
    "gerarCartao": false,
    "nomePersonalizado": "Mario Silva",
    "tipoEnderecoEnvioCartao": "R",
    "idServicosFinanceiros": 15
}'
Response Response Example
201 - Cards
{
    "contaCartao": 111111,
    "cartaoMascarado": "0000XXXXXXXX0000",
    "numeroManual": "CA-123456789=",
    "nomeCartao": "NOME PORTADOR FICTICIO",
    "diaVencimento": 15,
    "dataValidade": "2024-01-01"
}

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
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 eyJhbGciOiJIUzUxMiIsInR5cCIgOiAiSldUIiwia2lkIiA6ICIwZDI1NmI2MS03Y2RhLTQ5MzItYjVmNS1hZGIxOGUyNzc3MDQifQ.eyJleHAiOjE3NDI1ODE3NTMsImlhdCI6MTc0MjU2Mzc1MywianRpIjoiMDljMmMwMWUtNmMyNS00NTg5LWIyODUtZGZlMzIxZjUzZDhlIiwiaXNzIjoiaHR0cDovL3ZwYy1saW5rLXNiLmFwcC5ycGUudGVjaC9yZWFsbXMvcnBlIiwic3ViIjoiNGY2YmM0ZTgtMTRjYi00YmU4LWI4M2MtOWNiMTNhM2NiOWQwIiwidHlwIjoiQmVhcmVyIiwiYXpwIjoicnBlY2xpZW50Iiwic2Vzc2lvbl9zdGF0ZSI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsInNjb3BlIjoicHJvZmlsZSIsInNpZCI6IjEzMWY5OWNjLWQ1ZjgtNDYzYS1hMDdmLWM0MDYwOTNkYjdjZCIsImlzc3VlcmlkIjoxLCJyb2xlcyI6WyJST0xFX1NJU1RFTUEiLCJST0xFX1BBQ09URV9TTVNfQ09OU1VMVEFfTElTVEEiLCJST0xFX0NPTlNVTFRBUl9QT1JUQURPUiIsIlJPTEVfQ0FSVE9FU19BRE1JTiIsIlJPTEVfdGVzdGUtcm9sZSIsIlJPTEVfUEFDT1RFX1NNU19DT05TVUxUQV9QQUNPVEVTX0RJU1BPTklWRUlTIiwiUk9MRV9QQUNPVEVfU01TX0FMVEVSQUNBT19SRUNFQkVfQk9OVVNfQ0VMVUxBUiIsIlJPTEVfdW1hX3Byb3RlY3Rpb24iLCJST0xFX1BBQ09URV9TTVNfQ0FEQVNUUk9fQ09OVFJBVEFDQU9fUEFDT1RFIiwiUk9MRV9QQUNPVEVfU01TX0NBREFTVFJPX0NFTFVMQVJfU01TIiwiUk9MRV9QQUNPVEVfU01TX0NPTlNVTFRBX1BBQ09URVNfQ09OVFJBVEFET1MiLCJST0xFX0FETUlOIiwiUk9MRV9QQUNPVEVfU01TX1JFTU9DQU9fUEFDT1RFIl0sInVzZXJuYW1lIjoicnBlLXNhbmRib3gifQ.DtxNXDEFD4R7hP8XusdDNqGNvI2_NtwR5tZAjbYYEb2SWSANiPx8kRLMzVcqkvCWf57PqEAIEO6uQN9mbcYBwQ
Content-Type
string 
opcional
Tipo de mídia do corpo da solicitação.
Exemplo:
application/json
Accept
string 
opcional
Tipo do conteúdo aceito.
Exemplo:
application/json
Parâmetros Bodyapplication/json
opcional
Parâmetros para o cadastro de conta de pessoa física.
One of
Parâmetros para o cadastro de conta de pessoa física.
nome
string 
requerido
Nome completo da pessoa física.
>= 6 Caracteres<= 60 Caracteres
Exemplo:
Mario da Silva
nomeSocial
string 
opcional
Nome social da pessoa física.
Exemplo:
Mario Bros
cpf
string 
requerido
Número do CPF da pessoa física, com 11 dígitos e sem pontuação.
Exemplo:
34966451051
dataNascimento
string 
requerido
Data de nascimento da pessoa física no formato YYYY-MM-DD.
Exemplo:
1988-02-16
rg
string 
requerido
Número do RG da pessoa física, com 9 dígitos e sem pontuação.
Exemplo:
418757896
orgaoEmissor
string 
opcional
Orgão emissor do RG, sem mascaramento.
Exemplo:
SSPPB
dataEmissaoRg
string 
opcional
Data de emissão do RG no formato YYYY-MM-DD.
Exemplo:
2003-04-20
renda
number 
requerido
Renda da pessoa física, formatada com duas casa decimais.
>= 0
Exemplo:
2000
rendaComprovada
boolean 
opcional
Identifica se a renda informada foi comprovada.
Padrão:
true
Exemplo:
true
sexo
enum<string> 
requerido
Sexo da pessoa física.
Valores permitidos:
MASCULINOFEMININO
Exemplo:
FEMININO
estadoCivil
enum<string> 
opcional
Estado civil da pessoa física.
Valores permitidos:
SOLTEIROCASADOVIUVODIVORCIADOOUTROAMASIADOUNIAO_ESTAVEL
Exemplo:
SOLTEIRO
nomeMae
string 
requerido
Nome completo da mãe da pessoa física.
Exemplo:
Maria Aparecida dos Santos
nomePai
string 
opcional
Nome completo do pai da pessoa física.
Exemplo:
João Carlos dos Santos
idProfissao
integer <int64>
requerido
Código identificador da profissão da pessoa física.
>= 1
Exemplo:
2
enderecoResidencial
object 
requerido
Parâmetros para cadastro de endereco residencial no cadastro de conta.
enderecoComercial
object 
opcional
Parâmetros para cadastro ou alteração de endereço comercial.
enderecoAlternativo
object 
opcional
Parâmetros para cadastro ou alteração de endereço alternativo.
tipoEnderecoContato
enum<string> 
opcional
Tipo de endereço utilizado para contato da pessoa física. [Obrigatório para processadora Cards]
Valores permitidos:
RESIDENCIALCOMERCIALCORRESPONDENCIA
Exemplo:
RESIDENCIAL
idCiclo
integer <int64>
requerido
Código identificador do ciclo de corte/vencimento da pessoa física.
>= 1
Exemplo:
3
conjuge
object 
opcional
Parâmetros para cadastramento do cônjuge do portador.
adicionais
array [object {7}] 
opcional
Adicional da pessoa física.
dependentes
array [object {7}] 
opcional
Dependentes da pessoa física.
referencias
array [object {3}] 
opcional
Referências da pessoa física.
idLoja
integer <int64>
requerido
Código identificador do estabelecimento da pessoa física.
Exemplo:
15
limiteRotativo
number 
requerido
Limite rotativo, formatado com duas casas decimais.
>= 0
Exemplo:
2000
limiteParcelamento
number 
opcional
Limite parcelado. Campo obrigatório se o emissor utilizar limite misto.
>= 0
Exemplo:
4000
ocupacao
enum<string> 
requerido
Ocupação da pessoa física.
Valores permitidos:
OUTROSAPOSENTADOAUTONOMODO_LAREMPREGADOREMPREGADOESTUDANTEFUNCIONARIO_PUBLICOMILITARPENSIONISTAPROFISSIONAL_LIBERALCOMERCIANTE
Exemplo:
EMPREGADO
email
string 
opcional
E-mail de contato da pessoa física. O e-mail precisa estar em um formato válido.
Exemplo:
mario.silva@email.com
cidadeNatal
string 
opcional
Cidade natal da pessoa física.
Exemplo:
João Pessoa
estadoNatal
string 
opcional
Estado natal da pessoa física.
Exemplo:
PB
dataAdmissaoProfissao
string 
opcional
Data de admissão profissional, no formato YYYY-MM-DD.
Exemplo:
1988-02-16
tempoMoradiaAnos
integer <int32>
opcional
Quantidade de anos completos que a pessoa física reside na mesma residência. Campo não aceita valores negativos.
>= 0
Exemplo:
2
tempoMoradiaMeses
integer <int32>
opcional
Quantidade de meses que da pessoa física reside na mesma residência. Campo não aceita valores negativos.
>= 0
Exemplo:
6
tempoEmpregadoAnos
integer <int32>
opcional
Quantidade em anos que a pessoa física esteve em um emprego.
Exemplo:
2
tipoMoradia
enum<string> 
opcional
Tipo de moradia da pessoa física.
Valores permitidos:
NAO_INFORMADAPROPRIAALUGADAEM_FINANCIAMENTOFUNCIONAL_EMPRESACOM_PARENTESOUTRAS
Exemplo:
ALUGADA
nacionalidade
string 
requerido
Nacionalidade da pessoa física.
Exemplo:
Brasileiro
escolaridade
enum<string> 
opcional
Escolaridade da pessoa física.
Valores permitidos:
FUNDAMENTAL_COMPLETOMEDIO_COMPLETOSUPERIOR_INCOMPLETOSUPERIOR_COMPLETOOUTROS
Exemplo:
MEDIO_COMPLETO
telefones
array [object {6}] 
requerido
Telefones de contato da pessoa física.
idProduto
integer <int64>
requerido
Código do identificador do produto da pessoa física.
Exemplo:
1
numeroBeneficio
string 
opcional
Número do benefício para aposentados e pensionistas.
Exemplo:
1786997312
contratoImpresso
boolean 
opcional
Indica se a pessoa física terá o contrato de cadastro impresso ou não. [Obrigatório para processadora Cards]
Exemplo:
true
utilizaFaturaDigital
boolean 
opcional
Flag que indica se a pessoa física utiliza o serviço de fatura digital por e-mail
Exemplo:
false
portadorNecessidadesVisuais
boolean 
opcional
Indica se a pessoa física possui necessidades visuais.
Exemplo:
false
inibirEnvioFaturaGrafica
boolean 
opcional
Indica se a fatura do portador irá para a gráfica.
Exemplo:
false
gerarCartao
boolean 
opcional
Indica se o cartão será gerado junto ao cadastro da conta.
Exemplo:
false
nomePersonalizado
string 
opcional
Nome que será impresso no cartão.
>= 6 Caracteres<= 26 Caracteres
Exemplo:
Mario Silva
tipoEnderecoEnvioCartao
enum<string> 
opcional
O endereço de entrega do cartão.
Valores permitidos:
RCL
Exemplo:
R
idServicosFinanceiros
integer 
opcional
Identificador do serviço financeiro do produto.
Exemplo:
15
Examples

Respostas

🟢201Criado
application/json
OK
Body
contaCartao
integer <int64>
opcional
A conta referente ao cartão.
Exemplo:
111111
cartaoMascarado
string 
opcional
O número mascarado do cartão.
Exemplo:
0000XXXXXXXX0000
numeroManual
string 
opcional
Número manual.
Exemplo:
CA-123456789=
nomeCartao
string 
opcional
Nome impresso no cartão.
Exemplo:
NOME PORTADOR FICTICIO
diaVencimento
integer <int64>
opcional
Dia vencimento.
Exemplo:
15
dataValidade
string 
opcional
Data de validade do cartão.
Exemplo:
2024-01-01
🟠400Pedido inválido
🟠401Não autorizado
🟠403Proibido
🟠404Registro não encontrado
🔴500Erro do servidor
Página anterior
Cadastrar uma conta PJ
Próxima página
Listar tipos de bloqueio