← InicioFleetPay / Schema

ConferenciaChavePix

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

ChavePixInformada ↗

documentostringObligatorio

CPF o CNPJ consultado, solo dígitos.

chave_pixobjectObligatorio

ChavePixInformada ↗

vinculadabooleanObligatorio

Atajo para situacao == "vinculada".

situacaostringObligatorio

vinculada — la clave coincide con la registrada para este documento. chave_de_outro_titular — la clave existe en su base, registrada a nombre de OTRO transportista agregado suyo. Este caso requiere actuar: corresponde al patrón de sustitución de clave. nao_cadastrada — no hay una clave Pix externa con este valor registrada para este documento.

"vinculada" · "chave_de_outro_titular" · "nao_cadastrada"

titularobject | nullObligatorio

Solo se completa cuando situacao es vinculada. En chave_de_outro_titular, se devuelve null deliberadamente para que la verificación no se convierta en un directorio inverso de clave a persona.

documento_possui_chavebooleanObligatorio

Indica si este documento tiene ALGUNA clave Pix externa registrada con usted. Distingue entre "no tenemos una clave de esta persona" (false) y "tenemos una, pero es otra" (true): ambos casos devuelven vinculada: false y requieren acciones opuestas.

mensagemstringObligatorio

Texto preparado por FleetPay para mostrar a tu operador.

Definición JSON Original (Descripciones en Portugués)

{
  "type": "object",
  "required": [
    "documento",
    "chave_pix",
    "vinculada",
    "situacao",
    "titular",
    "documento_possui_chave",
    "mensagem"
  ],
  "properties": {
    "documento": {
      "type": "string",
      "description": "CPF ou CNPJ consultado, somente dígitos."
    },
    "chave_pix": {
      "$ref": "#/components/schemas/ChavePixInformada"
    },
    "vinculada": {
      "type": "boolean",
      "description": "Atalho para `situacao == \"vinculada\"`."
    },
    "situacao": {
      "type": "string",
      "enum": [
        "vinculada",
        "chave_de_outro_titular",
        "nao_cadastrada"
      ],
      "description": "`vinculada` — a chave é a que consta no cadastro deste documento. `chave_de_outro_titular` — a chave existe na sua base, cadastrada para OUTRO agregado seu. **É o caso que pede ação:** é o padrão da troca de chave. `nao_cadastrada` — não há chave PIX externa com este valor para este documento."
    },
    "titular": {
      "type": [
        "object",
        "null"
      ],
      "description": "Só vem preenchido quando `situacao` é `vinculada`. Em `chave_de_outro_titular` vai `null` de propósito, para a conferência não virar um diretório reverso chave → pessoa.",
      "properties": {
        "tipo": {
          "type": "string",
          "enum": [
            "motorista"
          ]
        },
        "nome": {
          "type": [
            "string",
            "null"
          ]
        },
        "documento": {
          "type": "string"
        }
      }
    },
    "documento_possui_chave": {
      "type": "boolean",
      "description": "Este documento tem ALGUMA chave PIX externa cadastrada com você. É o que separa \"não temos chave desta pessoa\" (`false`) de \"temos, e é outra\" (`true`) — as duas respondem `vinculada: false` e pedem ações opostas."
    },
    "mensagem": {
      "type": "string",
      "description": "Frase pronta, redigida pela FleetPay, para você mostrar ao seu operador."
    }
  }
}