---
updatedAt: 2025-06-06T21:20:54.000Z
agentTools:
  projectIndex: https://devs.bs2.com/llms.txt
---

# Endpoint para receber Webhook de Recebimento Finalizado

**Características:**
- Endpoint que deve ser implementado pelo cliente para receber Webhook de Recebimento Finalizado.
**Requisitos:**
Realizar a configuração/cadastro do Webhook no Contexto do PIX Indireto

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Bs2.Pix.Indireto.Webhook.Mock",
    "version": "v1"
  },
  "paths": {
    "/bs2/pix/indireto/webhook/mock/recebimento": {
      "post": {
        "tags": [
          "RecebimentoFinalizadoWebhook"
        ],
        "summary": "Endpoint para receber Webhook de Recebimento Finalizado",
        "description": "**Características:**\r\n- Endpoint que deve ser implementado pelo cliente para receber Webhook de Recebimento Finalizado.\r\n**Requisitos:**\r\nRealizar a configuração/cadastro do Webhook no Contexto do PIX Indireto",
        "parameters": [
          {
            "name": "apikey",
            "in": "header",
            "description": "api key",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "description": "Webhook com dados do Recebimento",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/bs2.core2.pix.indireto.webhook.mock.controllers.webhook.recebimentoFinalizado.RecebimentoFinalizadoRequest"
              }
            },
            "text/json": {
              "schema": {
                "$ref": "#/components/schemas/bs2.core2.pix.indireto.webhook.mock.controllers.webhook.recebimentoFinalizado.RecebimentoFinalizadoRequest"
              }
            },
            "application/*+json": {
              "schema": {
                "$ref": "#/components/schemas/bs2.core2.pix.indireto.webhook.mock.controllers.webhook.recebimentoFinalizado.RecebimentoFinalizadoRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Webhook recebido com sucesso.",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/microsoft.aspNetCore.mvc.NoContentResult"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/microsoft.aspNetCore.mvc.NoContentResult"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/microsoft.aspNetCore.mvc.NoContentResult"
                }
              }
            }
          },
          "400": {
            "description": "Ocorreu um erro ao receber o Webhook."
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "bs2.core2.pix.indireto.webhook.mock.compartilhados.CodigoRejeicao": {
        "enum": [
          "AB03",
          "AB09",
          "AB11",
          "AG12",
          "AG13",
          "AGNT",
          "AM01",
          "AM04",
          "AM12",
          "AM18",
          "AC03",
          "AC06",
          "AC07",
          "AC14",
          "AG03",
          "AM02",
          "AM09",
          "BE01",
          "BE17",
          "BE05",
          "CH11",
          "CH16",
          "DT02",
          "DS0G",
          "DS27",
          "DS04",
          "DS24",
          "DT05",
          "ED05",
          "FF07",
          "FF08",
          "MD01",
          "RR04",
          "RC09",
          "RC10",
          "SL02",
          "BE15",
          "CN01",
          "DUPL",
          "FRAD",
          "UPAY"
        ],
        "type": "string"
      },
      "bs2.core2.pix.indireto.webhook.mock.compartilhados.MotivoRejeicao": {
        "type": "object",
        "properties": {
          "codigo": {
            "$ref": "#/components/schemas/bs2.core2.pix.indireto.webhook.mock.compartilhados.CodigoRejeicao"
          },
          "descricao": {
            "type": "string",
            "description": "Descricção do erro\r\nDescrição do erro definido pela tabela de dominio do BACEN",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "bs2.core2.pix.indireto.webhook.mock.compartilhados.StatusRecebimento": {
        "enum": [
          "AguardandoValidacao",
          "Autorizado",
          "NaoAutorizado",
          "Efetivado",
          "Rejeitado",
          "Erro"
        ],
        "type": "string",
        "description": "1 - AguardandoValidacao - Aguardando Validação do Recebimento pelo Cliente\r\n2 - Autorizado\r\n3 - NaoAutorizado\r\n4 - Efetivado\r\n5 - Rejeitado\r\n99 - Erro"
      },
      "bs2.core2.pix.indireto.webhook.mock.controllers.webhook.recebimentoFinalizado.RecebimentoFinalizadoRequest": {
        "type": "object",
        "properties": {
          "chaveIdempotencia": {
            "type": "string",
            "format": "uuid"
          },
          "endToEndId": {
            "type": "string",
            "description": "EndToEndId da transação",
            "nullable": true,
            "example": "E710278662022121316173321926315P"
          },
          "transactionId": {
            "type": "string",
            "description": "Id de conciliação definido na geração do QRCode utilizado para fins de conciliação",
            "nullable": true
          },
          "valor": {
            "type": "number",
            "format": "double"
          },
          "solicitadoEmUtc": {
            "type": "string",
            "description": "Data do Recebimento",
            "format": "date-time"
          },
          "dataContabil": {
            "type": "string",
            "description": "Data contabil do Recebimento",
            "format": "date-time",
            "nullable": true
          },
          "liquidadoEmUtc": {
            "type": "string",
            "description": "Data de Liquidação",
            "format": "date-time",
            "nullable": true
          },
          "status": {
            "$ref": "#/components/schemas/bs2.core2.pix.indireto.webhook.mock.compartilhados.StatusRecebimento"
          },
          "motivoRejeicao": {
            "$ref": "#/components/schemas/bs2.core2.pix.indireto.webhook.mock.compartilhados.MotivoRejeicao"
          },
          "erroDescricao": {
            "type": "string",
            "nullable": true
          }
        },
        "additionalProperties": false
      },
      "microsoft.aspNetCore.mvc.NoContentResult": {
        "type": "object",
        "properties": {
          "statusCode": {
            "type": "integer",
            "format": "int32"
          }
        },
        "additionalProperties": false
      }
    }
  },
  "security": [
    {}
  ]
}
```