luniumpay-com Pix API

openapi: 3.2.0
info:
  title: Luniumpay Com Pix API
  version: 1.48.0
  contact:
    name: Lunium
    email: contato@luniumpay.com
    url: https://luniumpay.com/integrar?utm_source=openapi&utm_medium=spec
  x-documentation-revision: 2026-09-17.4
  x-lunium-partners:
    name: Lunium Partners — comunidade oficial de integradores
    url: https://t.me/+FerOZMRRP_g5MDk5
    description: Avisos operacionais, mudanças de contrato e troca entre parceiros. Nunca publique uma chave de API no grupo.
  description: 'Operations tagged Pix across 2 of this provider''s published API definitions: api.json, luniumpay-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.luniumpay.com
  description: Produção
security:
- ApiKey: []
tags:
- name: Pix
paths:
  /pix/keys/lookup:
    get:
      operationId: consultarTitularChavePix
      summary: Consultar titular PIX quando a verificação estiver disponível
      description: Consulta auxiliar de titular. Quando desabilitada, retorna HTTP 200 com verified=false, available=false, verification_status=not_performed, source=disabled e dados de titular nulos. Isso não desabilita pagamentos. Quando disponível, retorna dados obtidos do DICT sujeitos a cache e rate limit. Sandbox retorna titular fictício, source=sandbox. Não trate HTTP 200 isoladamente como titular verificado; envie type explícito quando souber o tipo.
      tags:
      - Pix
      security:
      - ApiKeyAuth: []
      parameters:
      - name: key
        in: query
        required: true
        schema:
          type: string
        description: A chave PIX (CPF, CNPJ, e-mail, telefone com ou sem +55, ou aleatória).
        examples:
          email:
            value: vendas@loja.com.br
          telefone:
            value: '+5511987654321'
      - name: type
        in: query
        required: false
        schema:
          type: string
          enum:
          - cpf
          - cnpj
          - phone
          - email
          - random
        description: Opcional. Deduzido do formato quando ausente.
      responses:
        '200':
          description: Titular encontrado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TitularPix'
        '400':
          description: Chave em formato inválido (`pix_key_invalida`) ou ausente (`pix_key_obrigatoria`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Erro'
        '401':
          description: X-API-Key ausente, desconhecida ou incorreta.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Erro'
        '404':
          description: Chave não existe no DICT (`chave_nao_encontrada`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Erro'
        '429':
          description: Limite de 5 consultas/min da conta (`limite_consultas`); leia `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Erro'
        '503':
          description: Provedor DICT indisponível (`provedor_indisponivel`, repetir) ou consulta desligada (`consulta_indisponivel`, esperar).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Erro'
    servers:
    - url: https://api.luniumpay.com
      description: Produção
components:
  schemas:
    TitularPix:
      type: object
      required:
      - pix_key
      - pix_key_type
      - owner_name
      - verified
      - source
      - checked_at
      properties:
        pix_key:
          type: string
          description: A chave, normalizada (telefone em +55…).
        pix_key_type:
          type: string
          enum:
          - cpf
          - cnpj
          - phone
          - email
          - random
          description: 'Tipo da chave consultada: "cpf", "cnpj", "phone", "email" ou "random".'
        owner_name:
          type:
          - string
          - 'null'
          description: Nome do titular, como está no DICT.
          examples:
          - João Silva
        owner_tax_number:
          type:
          - string
          - 'null'
          description: CPF/CNPJ MASCARADO. Nunca vem inteiro.
          examples:
          - '***.202.745-**'
        institution_name:
          type:
          - string
          - 'null'
          description: Instituição onde a chave está registrada.
          examples:
          - NU PAGAMENTOS - IP
        ispb:
          type:
          - string
          - 'null'
          description: ISPB da instituição (8 dígitos).
          examples:
          - '18236120'
        verified:
          type: boolean
          description: true quando titular foi consultado ou simulado (source=sandbox); false quando não verificado.
        source:
          type: string
          enum:
          - dict
          - sandbox
          - disabled
        checked_at:
          type: string
          format: date-time
        cached:
          type: boolean
          description: true quando a resposta veio do cache de 24h.
        sandbox:
          type: boolean
          description: 'Só em chave de teste: titular fictício.'
        available:
          type: boolean
          description: false quando consulta está indisponível; pode vir com HTTP 200.
        optional:
          type: boolean
          description: Consulta é auxiliar; não é um requisito de pagamento.
        verification_status:
          type: string
          description: not_performed quando a verificação não foi executada.
        detail:
          type: string
    Erro:
      type: object
      description: Erro da API; campos podem variar por caminho, inclusive respostas de infraestrutura. Combine código HTTP com erro e acao quando presentes; detail é para exibição, não decisão. Tolere códigos novos.
      properties:
        erro:
          type: string
          description: Codigo estavel de erro. Ramifique por ele, nunca pelo texto de detail. Esta lista e gerada a partir dos codigos que a API realmente emite.
          x-known-values:
          - amount_invalido
          - asset_invalido
          - br_code_indisponivel
          - br_code_invalido
          - br_code_sem_valor
          - brl_amount_invalido
          - campos_conflitantes
          - campos_obrigatorios
          - carencia_primeiro_deposito
          - carteira_indisponivel
          - carteira_nao_liberada
          - cashin_indisponivel
          - cashout_indisponivel
          - catalogo_indisponivel
          - chave_ausente
          - chave_desconhecida
          - chave_incorreta
          - chave_nao_encontrada
          - chave_obrigatoria
          - conflito
          - consulta_indisponivel
          - corpo_grande_demais
          - cotacao_divergente
          - cotacao_expirada
          - cotacao_indisponivel
          - cotacao_recusada
          - criacao_recusada
          - custodia_desligada
          - deposit_obrigatorio
          - destino_invalido
          - devolucao_indisponivel
          - documento_invalido
          - em_conciliacao
          - em_processamento
          - email_invalido
          - email_obrigatorio
          - endpoint_nao_respondeu
          - erro_interno
          - external_id_divergente
          - formato_invalido
          - funding_source_invalido
          - ja_entregue
          - limite_consultas
          - limite_de_chaves_teste
          - limite_diario
          - limite_diario_recebedor
          - limite_do_pagador
          - limite_indisponivel
          - liquidante_indisponivel
          - mandate_contraparte_nao_autorizada
          - mandate_valor_acima_do_teto
          - memo_obrigatorio
          - metodo_nao_permitido
          - muitas_tentativas
          - muitos_pedidos_abertos
          - nao_autenticado
          - nao_encontrado
          - nao_permitido
          - nao_processavel
          - origem_igual_destino
          - outcome_invalido
          - pagador_bloqueado
          - pagador_recusado_pelo_provedor
          - pagamentos_indisponiveis
          - payer_tax_invalido
          - payer_tax_number_invalido
          - payout_address_invalido
          - payout_address_obrigatorio
          - payout_nao_liberado
          - payout_recusado
          - pix_key_invalida
          - pix_key_obrigatoria
          - provedor_indisponivel
          - provedor_sem_resposta
          - rate_limit
          - rede_indisponivel
          - referencia_recusada
          - refund_address_imutavel
          - refund_address_invalida
          - requisicao_invalida
          - saldo_insuficiente
          - sandbox_sem_cashin
          - sandbox_sem_saldo
          - sandbox_sem_saque
          - saque_comissao_diario
          - saque_indisponivel
          - status_invalido
          - tax_number_obrigatorio
          - taxa_alterada
          - tempo_esgotado
          - temporariamente_indisponivel
          - tipo_ambiguo
          - valor_abaixo_do_minimo
          - valor_acima_do_maximo
          - valor_invalido
          - webhook_nao_configurado
          - webhook_url_invalida
        acao:
          type: string
          enum:
          - corrigir
          - repetir
          - esperar
          - parar
          - falar_com_suporte
          description: 'corrigir = o pedido esta errado, repetir identico nunca funciona · repetir = falha transitoria nossa, tente de novo · esperar = cota renova, volte depois · parar = nao repita, fale com a gente · falar_com_suporte = nao repita em laco; preserve request_id e external_id e encaminhe a Lunium (ex.: config_provedor).'
        detail:
          type: string
          description: Texto para humano. Nunca ramifique por ele.
        limits:
          type: object
          description: Presente nos erros de limite, ja convertido na moeda da ordem.
        docs:
          type: string
          format: uri
        request_id:
          type: string
          description: Identificador desta requisicao. Vai tambem no header X-Request-ID e e o que citar no suporte. Se voce enviar X-Request-ID no formato [A-Za-z0-9._:-]{8,64}, ele e preservado de ponta a ponta.
          examples:
          - req_62f05f21b3794830a241
        code:
          type: string
          deprecated: true
          description: 'Alias LEGADO de `erro` — SUNSET: deixa de ser enviado em 2026-11-09. NAO ramifique por ele; use `erro` (canonico). Nunca vem sem `erro`.'
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave criada em `POST /keys`. Aparece uma única vez — guarde no momento da criação.
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Your key. `lun_test_…` is sandbox (moves nothing); `lun_…` is production.
externalDocs:
  description: Mínimos e máximos por moeda e rede
  url: https://docs.luniumpay.com/minimos
x-refined-from:
- api.json
- luniumpay-com-openapi.json