api-users.yml

swagger: '2.0'
info:
  description: |
    Bienvenido a la API de [Multicaja](https://www.multicaja.cl) (Alpha)

    ** Este es un proyecto alpha y por lo tanto sufrirá muchos cambios **

    Todos los requests son autenticados usando un `api-key`.

    Existen dos ambientes: `qa` y `producción`. El `host` de `qa` es `apiqa.multicaja.cl`.
  version: '0.5'
  title: API Multicaja (Alpha)
host: 'api.multicaja.cl'
basePath: /v0.5-alpha/
consumes:
  - application/json
produces:
  - application/json
tags:
  - name: clientes
    description: Operaciones directamente con relacionadas un cliente
  - name: contacto
    description: Para contactar a un cliente y validar datos de contacto
  - name: cuentas
    description: Operaciones relacionadas con las cuentas bancarias de un cliente
  - name: direcciones
    description: Operaciones relacionadas con la dirección física de un cliente
paths:
  /users:
    post:
      summary: Crear
      tags: 
        - clientes
      description: |
        Registra a un nuevo cliente, el que puede ser persona natural (`rut.value < 50000000`) o empresa (`rut.value >= 50000000`).
        ### Notas
        * Requiere al menos los campos mínimos de User: rut y correo.
        * Si es una empresa, debe incluir `company_data`.
        * El servicio también funcionará con el `rut` de un cliente existente con `globalStatus` `"pre-registro"`.
        * Si se intenta crear un usuario con un `rut` o un `email` que ya ha sido usado y con `globalStatus` distinto de `"pre-registro"`, el servicio retornará `405`.
        * `clave` debe ser númérica, de 4 dígitos, no consecutivos, no iguales, y que no correspondan a ninguna parte de `rut.value`
        * Si se incluye el campo `clave`, `globalStatus` cambiará a `"activo"`
        * Si se incluye `rut.serial_number`, se invocará al SRCeI para validar la cédula. Si esa validación fuera exitosa, `rut.status` pasará a "validado". Si la validación no fuera exitosa, `rut.status` cambiará a (o seguirá siendo) "no validado". Esta llamada se hará de manera síncrona, por lo que el servicio no retornará hasta que el SRCeI responda.
        
        ### Recomendaciones
        * Dado que el servicio no funciona si el `rut` o el `email` ya han sido usados (a menos que pertenezcan a un cliente con `globalStatus` `"pre-registro"`), debería buscarlo primero por `rut` y luego por `email` usando el método `/users/find`
      parameters:
        - in: body
          name: user
          description: Parámetros del usuario a crear
          required: true
          schema:
            $ref: '#/definitions/NewUser'
      responses:
        '201':
          description: OK
          schema:
            $ref: '#/definitions/User'
        '405':
          description: El usuario ya existe
        '422':
          description: El Cliente contiene datos inválidos
          schema:
            $ref: '#/definitions/ErrorObj'
  /users/{user_id}:
    get:
      summary: Leer
      tags: 
        - clientes
      description: |
        Lee los datos de un cliente.
        ### Notas
        * Incluye los objetos `rut`, `email` y `cellphone`
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User'
        '404':
          description: Cliente no existe
    put:
      summary: Actualizar
      tags: 
        - clientes
      description: |
        Modifica los datos de un cliente, el que puede ser persona natural (`rut.value < 50000000`) o empresa (`rut.value >= 50000000`).
        
        ### Notas
        * Pese a que el rut es requerido, no es modificable. Si se proporciona un RUT distinto al del cliente `{user_id}`, el servicio retornará `422`
        * Si es una empresa, debe incluir `company_data`.
        * `clave` debe ser númérica, de 4 dígitos, no consecutivos, no iguales, y que no correspondan a ninguna parte de `rut.value`
        * Si se incluye el campo `clave` y `globalStatus` era `"pre-registro"`, `globalStatus` cambiará a `"activo"`
        * No se podrá modificar `email.value` si cliente no tiene clave. Si se intenta modificar un email de un cliente que no tiene clave, el servicio retornará `422`.
        * No se podrá modificar `email.value` si `email.status == "validado"`. Si se intenta modificar un email validado a través de este método, el servicio retornará `422`. Para modificar un correo validado, se debe usar los métodos de la URL `/user/{user_id}/mail`. La excepción a esta regla son los clientes con `globalStatus == "pre-registro"`. Si se intenta modificar un email validado de un cliente "pre-registro", la modificación tendrá éxito y `email.status` pasará a ser `"no validado"`.
        * No se podrá modificar `cellphone.value` si `celular.status == "validado"`. Si se intenta modificar un celular validado a través de este método, el servicio retornará `422`. Para modificar un celular validado, se debe usar los métodos de la URL `/user/{user_id}/sms`. La excepción a esta regla son los clientes con `globalStatus == "pre-registro"`. Si se intenta modificar un celular validado de un cliente "pre-registro", la modificación tendrá éxito y `celular.status` pasará a ser `"no validado"`.
        * Si se incluye `rut.serial_number`, se invocará al SRCeI para validar la cédula. Si esa validación fuera exitosa, `rut.status` pasará a "validado". Si la validación no fuera exitosa, `rut.status` cambiará a (o seguirá siendo) "no validado". Esta llamada se hará de manera síncrona, por lo que el servicio no retornará hasta que el SRCeI responda.
        * Los campos `gender`, `birthday`, `name`, `lastname_1` y `lastname_2` no tienen restricciones de modificación
        
        ### Recomendaciones
        * Sólo envíe los campos mínimos y los que se desee modificar. Por ejemplo, para cambiar el nombre, sólo incluya `rut.value`, `email.value` y `name`. Para validar la cédula contra el SRCeI, sólo incluya `rut.value`, `email.value` y `rut.status`.
        * Si se desea cambiar la clave del cliente, valide la clave anterior en primer lugar
        
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
        - in: body
          name: user
          description: Parámetros a modificar
          required: true
          schema:
            $ref: '#/definitions/NewUser'
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User'
        '404':
          description: Cliente no existe
        '422':
          description: El Cliente contiene datos inválidos
          schema:
            $ref: '#/definitions/ErrorObj'
  /users/find:
    get:
      summary: Buscar
      tags: 
        - clientes
      description: |
        Busca a un cliente por rut, por email o por celular
      parameters:
        - name: "rut"
          in: "query"
          description: "Rut sin puntos ni dígito verificador"
          type: integer
        - name: "email"
          in: "query"
          description: "Email"
          type: string
        - in: "query"
          name: "cellphone"
          description: "Celular (9 dígitos)"
          type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User'
        '404':
          description: Cliente no existe
  /users/login:
    get:
      summary: Buscar por ID y clave
      tags: 
        - clientes
      description: |
        Busca a un cliente por (rut y clave) o por (email y clave)
      consumes:
        - application/x-www-form-urlencoded
      parameters:
        - name: rut
          in: formData
          description: "Rut sin puntos ni dígito verificador"
          type: integer
        - name: email
          in: formData
          description: "Email"
          type: string
        - in: formData
          name: clave
          description: "Clave de 4 dígitos"
          type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/User'
        '404':
          description: Cliente no existe (puede representar clave inválida)
  /users/{user_id}/mail:
    post:
      summary: Enviar correo
      tags: 
        - contacto
      description: |
        Envía una comunicación o correo de validación al cliente

        ### Notas
        * `template_data` debe incluirse si el `template` requiere datos mínimos. Los datos deben ir en formato JSON. En caso contrario, el servicio retornará `422`.
        * `user_callback_uri` debe incluirse si el `template` incluye un link para que el usuario haga click. En caso contrario, el servicio retornará `422`.
        * Si se incluye `user_callback_uri`, no se incluye `address`, y el usuario hace clic en el link que indica el correo, el sistema actualizará automáticamente a `validado` el campo `email.status` del Cliente. Esto se logra incluyendo en el correo un link a una URI temporal que realiza el cambio y luego redirige a `user_callback_uri`.
        * `address` permite cambiar el correo electrónico cuando el cliente tiene un correo validado. Si se incluye tanto `user_callback_uri`  como `address`, y el usuario hace clic en el link que indica el correo, el sistema cambiará automáticamente el correo del cliente a la dirección que indica `address` y lo dejará como `validado`. 
        * La validación de correos se logra incluyendo en el correo un link a una URI temporal que realiza el cambio de estatus y luego redirige a `user_callback_uri`.
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
        - in: body
          name: mail
          description: Correo electrónico a enviar
          required: true
          schema:
            type: object
            required: 
              - template
            properties:
              template:
                type: string
                description: Tipo de correo electrónico a enviar
                example: "Prepago/ValidacionCorreo"
              template_data:
                type: string
                description: JSON con tantos pares llave-valor como requiera el template del correo a enviar
                example: "{'saludo': 'Estimado Pepito', 'despedida': 'Chao!'}"
              user_callback_uri:
                type: string
                description: Link que incluirá el correo si el `template` lo soporta
                example: "https://www.multicaja.cl/prepago/registro?u=3242343"
              address:
                type: string
                description: Correo electrónico al que se enviará este mensaje. Si no se incluye este campo, se usará el campo `email.value`  del Cliente.
                example: "pepito@gmail.com"
      responses:
        '201':
          description: OK
          schema:
            type: boolean
        '404':
          description: Cliente no existe
        '422':
          description: El mail contiene datos inválidos
          schema:
            $ref: '#/definitions/ErrorObj'
  /users/{user_id}/sms:
    post:
      summary: Enviar sms
      tags: 
        - contacto
      description: |
        Permite mandar un mensaje por sms al cliente
        ### Notas
        * Sólo incluir `cellphone` si el usuario ya tiene celular e intenta cambiarlo
        * Si el `template` requiere datos mínimos, debe incluirse estos datos en formato JSON mediante el campo `template_data`
        * Si el cliente indica no haber recibido el sms, reintente el envío cambiando `gateway` por `"secondary"`
        * No intente enviar códigos de validación a mano. Use un `template` que lo soporte.
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
        - in: body
          name: sms
          description: SMS a enviar
          required: true
          schema:
            type: object
            required: 
              - template
            properties:
              template:
                type: string
                description: Tipo de sms a enviar
                example: "Prepago/ValidacionCelular"
              gateway:
                type: string
                enum:
                  - primary
                  - secondary
                description: |
                  Gateway por el que se enviará el SMS
                  * primary: Gateway primaria (default)
                  * secondary: Gateway secundaria, usar sólo si el cliente dice no haber recibido el SMS
              cellphone:
                type: string
                description: Celular al que se enviará este mensaje. Corresponde a los 9 números que siguen a '+56'.  Si no se incluye este campo, se usará el campo `cellphone.value`  del Cliente.
                example: "912345678"
      responses:
        '201':
          description: OK
          schema:
            type: boolean
        '404':
          description: Cliente no existe
        '422':
          description: El sms contiene datos inválidos
          schema:
            $ref: '#/definitions/ErrorObj'
    put:
      summary: Validar código sms
      tags: 
        - contacto
      description: |
        Valida un código enviado mediante POST a `/users/{user_id}/sms`
        ### Notas
        * Sólo invocar este método para validar celular si se ha enviado previamente un código por SMS haciendo POST a `/users/{user_id}/sms`
        * Dependiendo del template usado en el POST a `/users/{user_id}/sms`, esta llamada podría cambiar `cellphone.status` a `"validado"`. Esto ocurrirá sólo si el código proporcionado corresponde al que fue enviado al celular`.
        * Si el código ingresado no corresponde al que fue enviado al cliente, el servicio retornará `422`.
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
        - in: body
          name: sms_code
          description: Código ingresado por el cliente
          required: true
          schema:
            type: integer
            example: "123456"
      responses:
        '201':
          description: OK
          schema:
            type: boolean
        '404':
          description: Cliente no existe
        '422':
          description: El código ingresado no es válido
          schema:
            $ref: '#/definitions/ErrorObj'
  /users/{user_id}/bank_accounts:
    get:
      summary: Listar
      tags: 
        - cuentas
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
      responses:
        '201':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/BankAccount'
        '404':
          description: Cliente no existe
    post:
      summary: Crear
      tags: 
        - cuentas
      description: |
        Crea una nueva cuenta bancaria para este cliente
        
        * La terna (`account.bank_id`, `account.acc_type`, `account.acc_number`) debe ser única para este usuario. De lo contrario, el servicio retornará `405`
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
        - in: body
          name: account
          description: Cuenta bancaria
          required: true
          schema:
            $ref: '#/definitions/NewBankAccount'
      responses:
        '201':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/BankAccount'
        '404':
          description: Cliente no existe
        '405':
          description: La cuenta ya existe
        '422':
          description: La cuenta contiene datos inválidos
          schema:
            $ref: '#/definitions/ErrorObj'
  /users/{user_id}/bank_accounts/{acc_id}:
    delete:
      summary: Eliminar
      tags: 
        - cuentas
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
        - in: path
          name: acc_id
          description: ID de la cuenta
          required: true
          type: "integer"
      responses:
        '200':
          description: OK
        '404':
          description: Cliente o Cuenta no existen
  /users/{user_id}/addresses:
    get:
      summary: Listar
      tags: 
        - direcciones
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
      responses:
        '201':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Address'
        '404':
          description: Cliente no existe
    post:
      summary: Crear
      tags: 
        - direcciones
      description: |
        Crea una nueva dirección para este cliente
        
        * La terna (`address.line_1`, `address.commune`, `address.region`) debe ser única para este usuario. De lo contrario, el servicio retornará `405`
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
        - in: body
          name: address
          description: Dirección
          required: true
          schema:
            $ref: '#/definitions/NewAddress'
      responses:
        '201':
          description: OK
          schema:
            type: array
            items:
              $ref: '#/definitions/Address'
        '404':
          description: Cliente no existe
        '405':
          description: La dirección ya existe
        '422':
          description: La dirección contiene datos inválidos
          schema:
            $ref: '#/definitions/ErrorObj'
  /users/{user_id}/addresses/{addr_id}:
    delete:
      summary: Eliminar
      tags: 
        - direcciones
      parameters:
        - in: path
          name: user_id
          description: ID del usuario
          required: true
          type: "integer"
        - in: path
          name: addr_id
          description: ID de la dirección
          required: true
          type: "integer"
      responses:
        '200':
          description: OK
        '404':
          description: Cliente o Dirección no existen          
definitions:
  NewUser:
    type: object
    description: |
      Cliente **(Request)**

      * Si el RUT es inferior a 50.000.000, corresponde a Persona Natural y `company_data` deberá ser `null`.
      * Si el RUT es igual o superior a 50.000.000, corresponde a Empresa y `company_data` debe existir.
    allOf:
      - $ref: "#/definitions/UserBasicFields"
      - type: object
        required:
          - rut
          - email
        properties:
          rut:
            $ref: '#/definitions/NewRut'
          cellphone:
            $ref: '#/definitions/NewCellPhone'
          email:
            $ref: '#/definitions/NewEmail'
          company_data:
            $ref: "#/definitions/NewCompanyData"
          password:
            type: string
            description: Clave de autenticación de 4 dígitos. Campo write-only.
            example: 8922
  User:
    type: object
    description: |
      Cliente **(Response)**

      * Este objeto representa tanto a una persona natural como a una empresa
      * Si el RUT es inferior a 50.000.000, corresponde a Persona Natural y `company_data` deberá ser `null`.
      * Si el RUT es igual o superior a 50.000.000, corresponde a Empresa y `company_data` es obligatorio
    allOf:
      - $ref: "#/definitions/UserBasicFields"
      - type: object
        required:
          - id 
          - rut
          - email
          - timestamps
          - globalStatus
        properties:
          id:
            type: integer
            description: Identificador interno. Campo read-only.
            example: 7783834
          rut:
            $ref: '#/definitions/Rut'
          cellphone:
            $ref: '#/definitions/CellPhone'
          email:
            $ref: '#/definitions/Email'
          company_data:
            $ref: "#/definitions/CompanyData"
          globalStatus:
            type: string
            enum:
              - pre-registro
              - activo
              - bloqueado
              - borrado
            description: |
              Estado del cliente. Campo read-only.
              * "pre-registro": cliente no posee clave
              * "activo": cliente con clave que puede transar
              * "bloqueado": cuenta temporalmente congelada
              * "borrado": eliminación lógica del cliente, no admite ningún cambio
          has_clave:
            type: string
            description: |
              `"true"` si el usuario tiene `clave`; `"false"` en otro caso
            example: "true"
          timestamps:
            $ref: '#/definitions/Timestamps'
  UserBasicFields:
    type: object
    description: |
      Nombre, Sexo, y Fecha de nacimiento de una persona
      Padre de `User` y `NewUser`
      **No se usa de manera independiente en la API**
    properties:
      name:
        type: string
        description: Nombre o nombres de pila
        example: "Juan Carlos"
      lastname_1:
        type: string
        description: Apellido paterno
        example: "López"
      lastname_2:
        type: string
        description: Apellido materno
        example: "Carrasco"
      gender:
        type: string
        enum: ["M", "F", "N"]
        description: |
          Sexo de la persona
          * M: Masculino
          * F: Femenino
          * N: Otro / prefiere no responder
      birthday:
        type: string
        format: date
        description: Fecha de nacimiento
        example: "1977-1-14"
  NewRut:
    type: object
    description: |
      Identificador Chileno **(Request)**
      
      **No se usa de manera independiente en la API**
    required:
      - value
    properties:
      value:
        type: integer
        description: El rut sin puntos, guión, ni dígito verificador
        example: 14569484
      serial_number:
        type: string
        description: Número de serie o número de documento. Éste es un campo write-only, por lo que *nunca* vendrá como respuesta de la API
        example: "A026582309"
      dv:
        type: string
        description: digito verificador
        example: "K"
  Rut:
    type: object
    description: |
      Identificador Chileno **(Response)**
      
      **No se usa de manera independiente en la API**
    allOf:
      - $ref: "#/definitions/NewRut"
      - type: object
        required:
          - status
          - timestamps
        properties:
          status:
            type: string
            enum:
              - no_validado
              - validado_srcei
              - validado_tef
            description: |
              Estado de validación del rut
              * no_validado: el rut no ha sido validado o las validaciones no han sido exitosas
              * validado_srcei: el rut fue validado exitosamente contra el registro civil
              * validado_tef: la validación más fuerte, ya que el usuario ha realizado un aviso de depósito seguido de una transferencia desde una cuenta correspondiente a su rut
          timestamps:
            $ref: '#/definitions/Timestamps'
  NewEmail:
    type: object
    description: |
      Correo Electrónico **(Request)**
      
      **No se usa de manera independiente en la API**
    required:
      - value
    properties:
      value:
        type: string
        format: email
        example: "pepito@gmail.com"
  Email:
    type: object
    description: |
      Correo Electrónico **(Response)**
      
      **No se usa de manera independiente en la API**
    allOf:
      - $ref: "#/definitions/NewEmail"
      - type: object
        required:
          - status
          - timestamps
        properties:
          status:
            type: string
            enum:
              - no_validado
              - en_proceso_de_validacion
              - validado
            description: |
              Estado de validación del email
              * no_validado: el email no ha sido validado
              * en_proceso_de_validacion: se ha enviado al menos un correo de validación, pero el usuario no ha hecho clic en el link
              * validado: el usuario demostró tener acceso a la casilla haciendo clic en un link enviado a ésta
          timestamps:
            $ref: '#/definitions/Timestamps'
  NewCellPhone:
    type: object
    description: |
      Teléfono Celular **(Request)**
      
      **No se usa de manera independiente en la API**
    required:
      - value
    properties:
      value:
        type: string
        description: Los 9 números que siguen a '+56'
        example: "912345678"
  CellPhone:
    type: object
    description: |
      Teléfono Celular **(Response)**
      
      **No se usa de manera independiente en la API**
    allOf:
      - $ref: "#/definitions/NewCellPhone"
      - type: object
        required:
          - status
          - timestamps
        properties:
          status:
            type: string
            enum:
              - no_validado
              - en_proceso_de_validacion
              - validado
            description: |
              Estado de validación del celular
              * no_validado: el celular no ha sido validado
              * en_proceso_de_validacion: se ha enviado al menos un sms de validación, pero el usuario no ha usado el código
              * validado: el usuario demostró tener acceso al celular usando el código enviado a éste
          timestamps:
            $ref: '#/definitions/Timestamps'
  NewCompanyData:
    type: object
    description: |
      Datos de la empresa a la que corresponde este Cliente **(Request)**
      **No se usa de manera independiente en la API**
    required:
      - business_name
    properties:
      business_name:
        type: string
        description: Nombre legal de la empresa
        example: "Reparaciones Joselito Ltda."
      commercial_activity:
        type: integer
        example: 772
        description: ID del giro (ver /params/giros)
  CompanyData:
    type: object
    description: |
      Datos de la empresa a la que corresponde este Cliente **(Response)**
      
      **No se usa de manera independiente en la API**
    allOf:
      - $ref: "#/definitions/NewCompanyData"
      - type: object
        required:
          - status
          - timestamps
        properties:
          status:
            type: string
            enum:
              - no_validado
              - validado_sii
            description: |
              Estado de validación de la razón social
              * no_validado: la razón social no ha sido validada
              * validado_sii: la razón social fue validada mediante el SII
          timestamps:
            $ref: '#/definitions/Timestamps'
  Timestamps:
    type: object
    description: |
      Fecha de creación y de última modificación.  Campo read-only.
      Componente de `Address`, `User`, `Rut`, `CellPhone`, `Email`, `BankAccount` y `CompanyData`

      **No se usa de manera independiente en la API**
    properties:
      created_at:
        type: string
        format: date-time
        example: "2018-01-14T15:27:42.669Z"
      updated_at:
        type: string
        format: date-time
        example: "2018-03-02T10:03:12.123Z"
  NewAddress:
    type: object
    description: Dirección física **(Request)**
    required:
      - line_1
    properties:
      alias:
        type: string
        description: Nombre que el usuario le da a esta dirección
        example: "Casa"
      line_1:
        type: string
        description: Lo que se une a región y comuna para determinar el código postal
        example: Suecia 1414
      line_2:
        type: string
        description: Información adicional como número de departamento. No afecta el código postal.
        example: Depto 502
      region_id:
        type: integer
        example: 13
        description: ID de la comuna (ver /params/regions)
      commune_id:
        type: integer
        example: 230
        description: ID de la comuna (ver /params/communes)
      postal_code:
        type: string
        description: Identificador de (`address.line_1`, `address.commune`, `address.region`)
        example: 7710787
  Address:
    type: object
    description: Dirección física **(Response)**
    allOf:
      - $ref: "#/definitions/NewAddress"
      - type: object
        required:
          - id
          - timestamps
        properties:
          id:
            type: integer
            description: Identificador interno. Campo read-only.
            example: 7783834
          timestamps:
            $ref: '#/definitions/Timestamps'
  NewBankAccount:
    type: object
    description: Cuenta bancaria personal **(Request)**
    required:
      - bank_id
      - acc_type
      - acc_number
    properties:
      bank_id:
        type: integer
        description: ID del banco (revisar /params/banks)
        example: 4
      acc_type:
        type: string
        description: Tipo de cuenta
        enum:
          - vista
          - corriente
          - ahorro
      acc_number:
        type: string
        description: Número de cuenta sin puntos, guiones, ni ceros a la izquierda
  BankAccount:
    type: object
    description: Cuenta bancaria personal **(Response)**
    allOf:
      - $ref: "#/definitions/NewBankAccount"
      - type: object
        required:
          - id
          - status
          - timestamps
        properties:
          id:
            type: integer
            description: Identificador interno. Campo read-only.
            example: 7783834
          bank_id:
            type: integer
            description: ID del banco (revisar /params/banks)
            example: 4
          acc_type:
            type: string
            description: Tipo de cuenta
            enum:
              - vista
              - corriente
              - ahorro
          acc_number:
            type: string
            description: Número de cuenta sin puntos, guiones, ni ceros a la izquierda
          status:
            type: string
            enum:
              - no_validada
              - validada
            description: |
              Estado de validación de la cuenta
              * no_validada: estado por defecto
              * validada: el usuario hizo una aviso de depósito seguido de una transferencia desde esta cuenta
          timestamps:
            $ref: '#/definitions/Timestamps'
  ErrorObj:
    type: object
    description: Error que devuelve la api ante un `HTTP 422` **(Response)**
    required:
      - code
    properties:
      code:
        type: integer
        format: int32
        description: Código que representa el error. No será igual al código HTTP.
        example: 1024
      message:
        type: string
        description: Descripción corta del error
        example: "El cliente no pasó la validación"
      details:
        type: array
        items:
          $ref: '#/definitions/ErrorObjDetail'
  ErrorObjDetail:
    type: object
    description: |
      Cuando un error está compuesto por una lista de sub-errores, vendrán en este objeto
      Componente de `ErrorObj`
      
      **No se usa de manera independiente en la API**
    properties:
      code:
        type: integer
        format: int32
        description: Código que representa el sub-error
        example: 227
      message:
        type: string
        description: Descripción del sub-error
        example: "El nombre no puede estar vacío"