> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Procesar un cash-in entrante del upstream

> Procesa un cash-in entrante del upstream: resuelve la cuenta de crédito por el documento del receptor, aplica el tratamiento especial para pagos originados por Bacen (ISPB 99999), deduplica sobre el end-to-end id y acredita al cliente exactamente una vez (idempotencia de Midaz indexada por el end-to-end id). Una cuenta no resuelta o un pagador Bacen devuelve un acuse de cuenta-no-encontrada con forma de éxito y sin crédito.



## OpenAPI

````yaml es/openapi/v3-current/pix.yaml POST /v1/webhooks/cash-ins
openapi: 3.0.3
info:
  title: Plugin BR Pix Directo - API completa
  description: >
    API completa para el sistema de pagos instantáneos Pix de Brasil,

    que incluye operaciones del diccionario de claves Pix,
    generación/decodificación

    de códigos QR, transacciones y límites transaccionales.
  version: 1.0.0
servers:
  - url: https://plugin-pix-direct.api.lerian.net
  - url: https://plugin-pix-direct-qrcode.api.lerian.net
security:
  - bearerAuth: []
paths:
  /v1/webhooks/cash-ins:
    post:
      tags:
        - Webhooks API
      summary: Procesar un cash-in entrante del upstream
      description: >-
        Procesa un cash-in entrante del upstream: resuelve la cuenta de crédito
        por el documento del receptor, aplica el tratamiento especial para pagos
        originados por Bacen (ISPB 99999), deduplica sobre el end-to-end id y
        acredita al cliente exactamente una vez (idempotencia de Midaz indexada
        por el end-to-end id). Una cuenta no resuelta o un pagador Bacen
        devuelve un acuse de cuenta-no-encontrada con forma de éxito y sin
        crédito.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CashInBody'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashInResponse'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Detail'
          description: Error
components:
  schemas:
    CashInBody:
      additionalProperties: false
      properties:
        bankIdPss:
          description: ISPB del participante PSS de Saque/troco (una cadena v5.5.0).
          type: string
        chave:
          description: La clave Pix (presente en los cash-ins iniciados por clave).
          type: string
        cnpjIniciadorPagamento:
          description: CNPJ del iniciador del pago (una cadena v5.5.0).
          type: string
        dtContabil:
          description: Fecha contable (opcional).
          type: string
        dtHrLiquidacao:
          description: Marca de tiempo de liquidación (opcional).
          type: string
        dtHrOp:
          description: Marca de tiempo de la operación (ISO-8601).
          type: string
        endToEndId:
          description: End-to-end id del SPI (clave de idempotencia + deduplicación).
          type: string
        finalidade:
          description: Finalidad (eFinality).
          format: int64
          type: integer
        idConciliacaoRecebedor:
          description: >-
            Id de conciliación del beneficiario (estampado en el registro + el
            marcador de 24 h).
          type: string
        idReqJdPi:
          description: >-
            Id de solicitud del upstream (se convierte en el id de la fila local
            cuando es un UUID).
          type: string
        infEntreClientes:
          description: Información entre clientes de texto libre.
          type: string
        modalidadeAgente:
          description: Modalidad del agente (eModalityAgent).
          format: int64
          type: integer
        pagador:
          $ref: '#/components/schemas/PartyBlock'
        prioridadePagamento:
          description: Prioridad del pago (ePaymentPriority).
          format: int64
          type: integer
        recebedor:
          $ref: '#/components/schemas/PartyBlock'
        tpIniciacao:
          description: >-
            Tipo de iniciación (eStartupType: Chave -> ruta in, QR -> ruta
            inQrCode).
          format: int64
          type: integer
        tpPrioridadePagamento:
          description: Tipo de prioridad del pago.
          format: int64
          type: integer
        valor:
          description: Monto en reales (un número JSON).
          format: double
          type: number
        vlrDetalhe:
          description: Entradas de detalle de valores opcionales.
          items:
            $ref: '#/components/schemas/ValueDetailBlock'
          type: array
          nullable: true
      required:
        - idReqJdPi
        - endToEndId
        - tpIniciacao
        - pagador
        - recebedor
        - dtHrOp
        - valor
      type: object
    CashInResponse:
      additionalProperties: false
      properties:
        dtHrCreditoSgct:
          description: >-
            Marca de tiempo del crédito del settlement-gateway (ISO-8601), en un
            resultado acreditado.
          type: string
        dtHrReqJdPi:
          description: Marca de tiempo de la solicitud (ISO-8601).
          type: string
        endToEndIdDevolucao:
          description: End-to-end id de retorno, reflejado.
          type: string
        endToEndIdOriginal:
          description: End-to-end id original, reflejado.
          type: string
        idCreditoSgct:
          description: >-
            Id de lançamento de crédito del settlement-gateway (GUID), en un
            resultado acreditado.
          type: string
        idReqJdPi:
          description: Id de solicitud del upstream, reflejado.
          type: string
        idReqSistemaCliente:
          description: Id de solicitud del sistema cliente, reflejado.
          type: string
      type: object
    Detail:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de error de dominio estable y legible por máquina, acotado al
            servicio emisor (formato: <SERVICE>-NNNN).
          type: string
        detail:
          description: >-
            Una explicación legible para humanos específica de esta ocurrencia
            del problema.
          type: string
        errors:
          description: Lista opcional de detalles de error individuales
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type: array
          nullable: true
        instance:
          description: >-
            Una referencia URI que identifica la ocurrencia específica del
            problema.
          format: uri
          type: string
        status:
          description: Código de estado HTTP
          format: int64
          type: integer
        title:
          description: >-
            Un resumen breve y legible para humanos del tipo de problema. Este
            valor no debería cambiar entre ocurrencias del error.
          type: string
        type:
          default: about:blank
          description: >-
            Una referencia URI a la documentación legible para humanos del
            error.
          format: uri
          type: string
      type: object
    PartyBlock:
      additionalProperties: false
      properties:
        cpfCnpj:
          description: CPF/CNPJ del documento del titular (una cadena v5.5.0).
          type: string
        ispb:
          description: ISPB del participante (una cadena v5.5.0).
          type: string
        nome:
          description: Nombre del titular.
          type: string
        nrAgencia:
          description: >-
            Número de agencia/sucursal (la fuente de la agencia del
            participante).
          type: string
        nrConta:
          description: Número de cuenta (NUNCA se usa como agencia).
          type: string
        tpConta:
          description: 'Tipo de cuenta (eAccountType: 0=corriente).'
          format: int64
          type: integer
        tpPessoa:
          description: 'Tipo de persona (ePersonType: 0=física, 1=jurídica).'
          format: int64
          type: integer
      required:
        - ispb
        - tpPessoa
        - cpfCnpj
        - nrAgencia
        - tpConta
        - nrConta
        - nome
      type: object
    ValueDetailBlock:
      additionalProperties: false
      properties:
        tipo:
          description: Tipo de detalle de valor.
          format: int64
          type: integer
        vlrTarifaDinheiroCompra:
          description: Monto de la tarifa de compra en efectivo (reales).
          format: double
          type: number
      required:
        - vlrTarifaDinheiroCompra
        - tipo
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Dónde ocurrió el error, p. ej. 'body.items[3].tags' o
            'path.thing-id'
          type: string
        message:
          description: Texto del mensaje de error
          type: string
        value:
          description: El valor en la ubicación indicada
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Autenticación con token JWT Bearer. Obtén el token desde el endpoint
        `/v1/login/oauth/access_token`

        usando credenciales de cliente (`clientId` y `clientSecret`).


        Incluye el token en el encabezado Authorization:

        `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...`


        El token expira después de 3600 segundos (1 hora).

````