> ## 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. # Processar cash-in de entrada do upstream > Processa um cash-in de entrada do upstream: resolve a conta de crédito pelo documento do recebedor, aplica o tratamento especial para pagamentos originados pelo Bacen (ISPB 99999), deduplica pelo id ponta a ponta e credita o cliente exatamente-uma-vez (idempotência do Midaz chaveada no id ponta a ponta). Uma conta não resolvida ou um pagador Bacen retorna um reconhecimento de conta-não-encontrada com formato de sucesso e sem crédito. ## OpenAPI ````yaml pt/openapi/v3-current/pix.yaml POST /v1/webhooks/cash-ins openapi: 3.0.3 info: title: Plugin BR Pix Direct - API Completa description: > API completa para o sistema de pagamentos instantaneos PIX brasileiro, incluindo operacoes de dicionario de chaves PIX, geracao/decodificacao de QR codes, transacoes e limites de transacao. 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: Processar cash-in de entrada do upstream description: >- Processa um cash-in de entrada do upstream: resolve a conta de crédito pelo documento do recebedor, aplica o tratamento especial para pagamentos originados pelo Bacen (ISPB 99999), deduplica pelo id ponta a ponta e credita o cliente exatamente-uma-vez (idempotência do Midaz chaveada no id ponta a ponta). Uma conta não resolvida ou um pagador Bacen retorna um reconhecimento de conta-não-encontrada com formato de sucesso e sem 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: Erro components: schemas: CashInBody: additionalProperties: false properties: bankIdPss: description: ISPB do participante PSS de Saque/troco (uma string v5.5.0). type: string chave: description: A chave Pix (presente para cash-ins iniciados por chave). type: string cnpjIniciadorPagamento: description: CNPJ do iniciador de pagamento (uma string v5.5.0). type: string dtContabil: description: Data contábil (opcional). type: string dtHrLiquidacao: description: Data/hora de liquidação (opcional). type: string dtHrOp: description: Data/hora da operação (ISO-8601). type: string endToEndId: description: Id ponta a ponta do SPI (chave de idempotência + dedup). type: string finalidade: description: Finalidade (eFinality). format: int64 type: integer idConciliacaoRecebedor: description: >- Id de conciliação do recebedor (estampado na linha + no marcador de 24h). type: string idReqJdPi: description: >- Id da requisição upstream (torna-se o id da linha local quando um UUID). type: string infEntreClientes: description: Informação inter-clientes em texto livre. type: string modalidadeAgente: description: Modalidade do agente (eModalityAgent). format: int64 type: integer pagador: $ref: '#/components/schemas/PartyBlock' prioridadePagamento: description: Prioridade de pagamento (ePaymentPriority). format: int64 type: integer recebedor: $ref: '#/components/schemas/PartyBlock' tpIniciacao: description: >- Tipo de iniciação (eStartupType: Chave -> rota in, QR -> rota inQrCode). format: int64 type: integer tpPrioridadePagamento: description: Tipo de prioridade de pagamento. format: int64 type: integer valor: description: Valor em reais (um número JSON). format: double type: number vlrDetalhe: description: Entradas opcionais de detalhe de valor. 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: >- carimbo de data/hora de crédito do gateway de liquidação (ISO-8601), em um resultado creditado. type: string dtHrReqJdPi: description: Data/hora da requisição (ISO-8601). type: string endToEndIdDevolucao: description: Id ponta a ponta de retorno ecoado. type: string endToEndIdOriginal: description: Id ponta a ponta original ecoado. type: string idCreditoSgct: description: >- id do lançamento de crédito do gateway de liquidação (GUID), em um resultado creditado. type: string idReqJdPi: description: Id da requisição upstream ecoado. type: string idReqSistemaCliente: description: Id de requisição do sistema cliente ecoado. type: string type: object Detail: additionalProperties: false properties: code: description: >- Código de erro de domínio estável e legível por máquina, escopado ao serviço emissor (formato: -NNNN). type: string detail: description: Uma explicação legível específica desta ocorrência do problema. type: string errors: description: Lista opcional de detalhes individuais de erro items: $ref: '#/components/schemas/ErrorDetail' type: array nullable: true instance: description: >- Uma referência URI que identifica a ocorrência específica do problema. format: uri type: string status: description: Código de status HTTP format: int64 type: integer title: description: >- Um resumo curto e legível do tipo de problema. Este valor não deve mudar entre ocorrências do erro. type: string type: default: about:blank description: Uma referência URI para a documentação legível do erro. format: uri type: string type: object PartyBlock: additionalProperties: false properties: cpfCnpj: description: CPF/CNPJ do titular (uma string v5.5.0). type: string ispb: description: ISPB do participante (uma string v5.5.0). type: string nome: description: Nome do titular. type: string nrAgencia: description: Número da agência (a fonte da agência do participante). type: string nrConta: description: Número da conta (NUNCA usado como agência). type: string tpConta: description: 'Tipo de conta (eAccountType: 0=corrente).' format: int64 type: integer tpPessoa: description: 'Tipo de pessoa (ePersonType: 0=natural, 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 detalhe de valor. format: int64 type: integer vlrTarifaDinheiroCompra: description: Valor da tarifa de compra à vista (reais). format: double type: number required: - vlrTarifaDinheiroCompra - tipo type: object ErrorDetail: additionalProperties: false properties: location: description: Onde o erro ocorreu, ex. 'body.items[3].tags' ou 'path.thing-id' type: string message: description: Texto da mensagem de erro type: string value: description: O valor no local informado type: object securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Autenticacao por token JWT Bearer. Obtenha o token no endpoint `/v1/login/oauth/access_token` usando credenciais do cliente (clientId e clientSecret). Inclua o token no header Authorization: `Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...` O token expira apos 3600 segundos (1 hora). ````