> ## Documentation Index > Fetch the complete documentation index at: https://docs.ephra.io/llms.txt > Use this file to discover all available pages before exploring further. # Consultar entrega de webhook > Devolve o payload que a Ephra enviou, o status HTTP e o corpo que o seu servidor respondeu em cada tentativa. É por aqui que se descobre se a falha foi da notificação ou do endpoint. Responde 404 quando a entrega não existe ou é de outra empresa. ## OpenAPI ````yaml /openapi.yaml get /v1/webhook-deliveries/{deliveryId} openapi: 3.0.3 info: title: Ephra API description: >- API pública da Ephra: cobranças (PIX, cartão e boleto), transações, webhooks e a API do vendedor sobre catálogo, checkout, vendas, reembolsos, financeiro, crescimento e plataforma. **Limite de requisições.** 1000 requisições por minuto por IP de origem. Toda resposta traz `x-ratelimit-limit`, `x-ratelimit-remaining` e `x-ratelimit-reset` (segundos até a janela zerar); ao estourar o limite a resposta é `429` com `retry-after`. **Erros.** Toda falha responde o mesmo envelope: `{ "success": false, "message": "..." }`. version: 1.0.0 servers: - url: https://api.ephra.io description: Servidor de produção security: [] tags: - name: Catálogo description: Produtos, ofertas, categorias e cupons — o que a empresa vende. - name: Checkout description: Checkouts, order bumps, upsells e links de pagamento. - name: Vendas description: Vendas, clientes, assinaturas e entregas já realizadas. - name: Reembolsos description: Pedidos de reembolso, contestações e o quiz de retenção. - name: Financeiro description: Saldo, saques, antecipações, taxas e extratos da empresa. - name: Crescimento description: Afiliados, coprodução, indicações, pixels e integrações de marketing. - name: Plataforma description: Conta, membros, chaves de API, webhooks e configurações gerais. paths: /v1/webhook-deliveries/{deliveryId}: get: tags: - Plataforma summary: Consultar entrega de webhook description: >- Devolve o payload que a Ephra enviou, o status HTTP e o corpo que o seu servidor respondeu em cada tentativa. É por aqui que se descobre se a falha foi da notificação ou do endpoint. Responde 404 quando a entrega não existe ou é de outra empresa. operationId: getWebhookDelivery parameters: - schema: type: string minLength: 1 in: path name: deliveryId required: true description: Identificador da entrega. responses: '200': description: Entrega encontrada, com payload e tentativas. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `true` em uma resposta bem-sucedida. data: type: object properties: id: type: string description: Identificador da entrega. transactionId: type: string nullable: true description: Venda que originou o evento, quando houver. type: type: string enum: - transaction - transfer - infraction description: 'Origem do evento: venda, saque ou contestação.' event: type: string enum: - transaction_created - transaction_paid - transaction_refunded - transaction_updated - transfer_completed - transfer_canceled - transfer_created - transfer_updated - infraction - cart_abandoned - sale_lost - card_declined - product_canceled - company_approved - product_approved - product_refused - withdrawal_requested - withdrawal_sent - transaction_reversal - release_access - vturb_paid - vk_metrics_purchase - refund_requested description: Evento notificado. eventType: type: string description: Rótulo do evento como enviado no corpo da notificação. status: type: string enum: - pending - success - error - failed - suppressed description: >- Situação da entrega: pendente, entregue, com erro ou suprimida. url: type: string description: URL que recebeu (ou receberá) o POST. retries: type: integer description: Quantidade de retentativas já feitas. createdAt: type: string format: date-time description: Momento em que o evento foi enfileirado. updatedAt: type: string format: date-time description: Momento da última tentativa. payload: description: >- Corpo JSON exatamente como foi enviado ao endpoint do vendedor. attempts: type: array items: type: object properties: id: type: integer description: Identificador da tentativa. httpStatus: type: integer description: >- Status HTTP devolvido pelo servidor do vendedor nesta tentativa. response: description: >- Corpo da resposta recebida, como veio do servidor do vendedor. attemptedAt: type: string format: date-time description: Momento desta tentativa. required: - id - httpStatus - attemptedAt additionalProperties: false description: >- Tentativas já feitas, da mais antiga para a mais recente. required: - id - transactionId - type - event - eventType - status - url - retries - createdAt - updatedAt - attempts additionalProperties: false required: - success - data additionalProperties: false description: Entrega encontrada, com payload e tentativas. example: success: true data: id: clx9f1m2p0004qz0a7h8i9j0k transactionId: clx9e0k1n0002qz0a5f6g7h8i type: transaction event: transaction_paid eventType: transaction.paid status: error url: https://erp.minhaloja.com.br/integracoes/ephra retries: 3 createdAt: '2026-09-10T14:22:05.000Z' updatedAt: '2026-09-10T14:38:41.000Z' payload: event: transaction.paid data: id: clx9e0k1n0002qz0a5f6g7h8i amount: 49900 status: paid paymentMethod: pix customer: name: Marina Ribeiro document: 123.456.789-09 email: marina.ribeiro@exemplo.com.br attempts: - id: 90114 httpStatus: 500 response: error: internal server error attemptedAt: '2026-09-10T14:22:07.000Z' - id: 90118 httpStatus: 502 response: Bad Gateway attemptedAt: '2026-09-10T14:38:41.000Z' '401': description: Token ausente, inválido, expirado ou de empresa bloqueada. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: Token ausente, inválido, expirado ou de empresa bloqueada. example: success: false message: Token inválido ou expirado '404': description: O recurso não existe, foi excluído ou pertence a outra empresa. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- O recurso não existe, foi excluído ou pertence a outra empresa. example: success: false message: Recurso não encontrado '422': description: A requisição não passou na validação de schema. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: A requisição não passou na validação de schema. example: success: false message: 'name: Nome é obrigatório' '429': description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Requisições demais: o limite é de 1000 requisições por minuto por IP de origem. Espere o número de segundos do header `retry-after` e repita com recuo exponencial. example: success: false message: Muitas requisições. Tente novamente em breve. headers: retry-after: $ref: '#/components/headers/retry-after' x-ratelimit-limit: $ref: '#/components/headers/x-ratelimit-limit' x-ratelimit-remaining: $ref: '#/components/headers/x-ratelimit-remaining' x-ratelimit-reset: $ref: '#/components/headers/x-ratelimit-reset' '500': description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. content: application/json: schema: type: object properties: success: type: boolean description: Sempre `false` em uma resposta de erro. message: type: string description: Mensagem legível explicando a falha. required: - success - message additionalProperties: false description: >- Falha interna ao processar a requisição. Repita; se persistir, abra chamado com o horário e a rota. example: success: false message: Erro interno do servidor security: - bearerAuth: [] components: headers: retry-after: description: Segundos a esperar antes de repetir a requisição. schema: type: integer x-ratelimit-limit: description: Teto de requisições na janela (1000). Presente em toda resposta. schema: type: integer x-ratelimit-remaining: description: >- Quantas requisições ainda cabem na janela atual. Presente em toda resposta. schema: type: integer x-ratelimit-reset: description: Segundos até o contador da janela zerar. Presente em toda resposta. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````