1. Beneficiários
Dental Gold API
  • Introdução
  • Autenticação
    • Client Login
      POST
    • Ping (checar autenticação)
      GET
  • Buscas
    • Busca por beneficiário
      GET
    • Buscar registro utilizando CPF ou CNPJ
      GET
  • Associados
    • Busca de associados
      GET
    • Consultar associado
      GET
    • Consultar mensalidades
      GET
    • Demonstrativo de pagamentos
      GET
  • Empresas
    • Consultar empresa
      GET
  • Beneficiários
    • Listar beneficiários
      GET
    • Consultar dados financeiros
      GET
    • Carteira virtual
      GET
  • Planos
    • Listar planos
      GET
    • Consultar plano
      GET
    • Cobertura do plano
      GET
    • Valores do plano
      GET
  • Rede Credenciada
    • Listar prestadores
      GET
    • Consultar prestador
      GET
    • Listar especialidades
      GET
    • Localizar clínicas próximas
      GET
    • JSON
      GET
  • Cobrança
    • Consultar mensalidade
    • Gerar novo boleto
  • Comercial
    • Equipes
      • Listar equipes
    • Vendedores
      • Consultar Vendedor
      • Listar vendedores
      • Cadastrar vendedor
    • Lotes de vendas
      • Listando os lotes
    • Vendas
      • Nova adesão
      • Consulta associado
      • Consultar mensalidades
      • Nova empresa
    • Restrições
      • Checagem de existência de restrições
  • Cadastros
    • Especialidades
      • Listar especialidades
    • Vendedores
      • Consultar Vendedor
      • Listar vendedores
      • Cadastrar vendedor
    • Lotes de vendas
      • Listando os lotes
    • Vendas
      • Nova adesão
  • CEP
    • Consulta CEP
  • Métricas
    • Movimentação de beneficiários
      • Movimentação de beneficiários
      • Novas vendas
    • Faturamento e Cobrança
      • Histórico de faturamento
      • Recebimento
      • Agendamentos
      • Campanhas de cobrança
      • Interações das campanhas
    • Validar token
  • Tipos de dados
  1. Beneficiários

Carteira virtual

GET
https://api.dentalgold.com.br/v1/beneficiario/{{beneficiario.id}}/carteira-virtual
A aplicação gera um link público temporário para que o cliente tenha acesso a uma imagem de sua carteira virtual, junto com a data de validade do link.
É necessário informar o ID do beneficiário para geração da carteira.
Por ser um link público, e por conter informações privadas do cliente, a url só funcionará dentro de sua validade. Se o cliente desejar ter acesso ao recurso após a validade, será necessário solicitar a geração de um novo link.

Requisição

Authorization
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************

Respostas

🟢200Carteira virtual
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https://api.dentalgold.com.br/v1/beneficiario/{{beneficiario.id}}/carteira-virtual' \
--header 'Authorization: Bearer <token>'
Response Response Example
{
    "message": "Link para a carteira do beneficiário gerado com sucesso.",
    "link": {
        "url": "http://smiley.localhost/web/c44bc26e-6565-4eb1-b5a1-909c25733e96",
        "validade": "2022-03-17 07:34:25"
    }
}
Modificado em 2024-09-04 22:36:20
Página anterior
Consultar dados financeiros
Próxima página
Listar planos
Built with