← InicioFleetPay / Schema

ContaDoAgregado

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.

Cuenta digital FleetPay del colaborador. Si solo lees un campo, consulta habilitado_a_receber; los demás explican el motivo.

situacaostringObligatorio

Etapa actual de la cuenta. sem_conta — existe el registro, pero no ha comenzado la apertura de la cuenta. criada / em_analise — FleetPay está gestionando el proceso. aprovada — la cuenta existe y está operativa. reprovada / encerrada — resultados finales. Trátelo como una lista abierta: un valor nuevo no debe provocar fallos en su cliente.

"sem_conta" · "criada" · "em_analise" · "aprovada" · "reprovada" · "encerrada"

biometriastringObligatorio

Verificación de identidad del titular. Es el paso que más suele detener el avance de una cuenta y FleetPay lo gestiona directamente con la persona; no puede desbloquearlo mediante la API.

"nao_iniciada" · "em_analise" · "aprovada" · "reprovada"

habilitado_a_receberbooleanObligatorio

El campo decisivo. Es true únicamente cuando la cuenta está aprobada Y no está bloqueada. Una cuenta aprobada pero bloqueada sigue existiendo y sigue sin poder recibir fondos; por eso no basta con consultar situacao.

pendenciastring | nullOpcional

Lo que falta, en una frase que puede mostrar a su operador. Es null cuando no hay nada pendiente. Es texto para lectura humana: no construya una condición if sobre él; utilice situacao y biometria.

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

{
  "type": "object",
  "required": [
    "situacao",
    "biometria",
    "habilitado_a_receber"
  ],
  "description": "A conta digital FleetPay do agregado. Se você só for ler um campo, leia `habilitado_a_receber` — os outros existem para explicar o \"por quê\".",
  "properties": {
    "situacao": {
      "type": "string",
      "enum": [
        "sem_conta",
        "criada",
        "em_analise",
        "aprovada",
        "reprovada",
        "encerrada"
      ],
      "description": "Em que ponto está a conta. `sem_conta` — o cadastro existe mas a abertura da conta não começou. `criada` / `em_analise` — a FleetPay está conduzindo. `aprovada` — a conta existe e funciona. `reprovada` / `encerrada` — desfechos finais. Trate como lista aberta: um valor novo não deve quebrar o seu cliente."
    },
    "biometria": {
      "type": "string",
      "enum": [
        "nao_iniciada",
        "em_analise",
        "aprovada",
        "reprovada"
      ],
      "description": "A verificação de identidade do titular. É o passo que mais segura conta parada, e é conduzido pela FleetPay com a pessoa — você não consegue destravá-lo pela API."
    },
    "habilitado_a_receber": {
      "type": "boolean",
      "description": "**O campo que decide.** `true` só quando a conta está aprovada E não está bloqueada. Uma conta aprovada porém bloqueada continua existindo e continua não recebendo — por isso não basta olhar `situacao`."
    },
    "pendencia": {
      "type": [
        "string",
        "null"
      ],
      "description": "O que falta, em uma frase que você pode mostrar ao seu operador. `null` quando não há nada pendente. É texto para leitura humana: não faça `if` em cima dele — use `situacao` e `biometria`."
    }
  }
}