> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Buscar delivery por ID
> O registro completo de uma tentativa de entrega — o corpo que saiu daqui e a resposta que o seu servidor deu.
`GET /webhooks/deliveries/:id`
Faz parte do recurso [Webhooks](/pt-BR/webhooks) — o cadastro e o catálogo de eventos estão lá.
Retorna uma entrega inteira, com o `payload` exato que enviamos e o que voltou do seu servidor. É
a leitura de depuração: quando algo "não chegou", é aqui que se vê se saiu, para onde, e o que o
seu endpoint respondeu.
**Três campos respondem "de quem é a culpa".** `returnStatus` é o HTTP que o seu servidor
devolveu; `returnData`, o corpo dessa resposta; `errorMessage`, o motivo quando não houve
resposta nenhuma (timeout, DNS, conexão recusada). `returnStatus: null` com `errorMessage`
preenchido significa que a requisição não chegou a ser respondida.
**`payload` é o envelope como o seu servidor o recebeu** — mesmo `id`, mesmo `occurredAt`. Um
reenvio não regrava esses valores, o que é justamente o que permite deduplicar pelo `id` e
descartar evento antigo pelo `occurredAt`. O formato está em
[Recebendo eventos](/pt-BR/webhooks/visao-geral#o-envelope-do-evento).
**`attemptCount` conta todas as tentativas daquela entrega**, automáticas e manuais. Chegando a
7, o ciclo automático se esgotou; daí em diante só cresce por
[reprocessamento](/pt-BR/webhooks/deliveries-retry).
## Exemplo
```bash theme={null}
curl https://api.sandbox.z2pay.com/v1/webhooks/deliveries/whd_t3ysa1qmxmusn47dhojdraxdi \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX"
```
```json Resposta 200 theme={null}
{
"id": "whd_t3ysa1qmxmusn47dhojdraxdi",
"webhookId": "whk_k9clfafnldd96dbbxruh34233",
"eventType": "transaction.paid",
"url": "https://meusite.com/webhooks/z2pay",
"payload": {
"id": "whd_t3ysa1qmxmusn47dhojdraxdi",
"type": "transaction.paid",
"data": { "id": "txn_fcfcvfq9ryd6t3yczj6e87gyh" },
"occurredAt": "2026-06-24T13:46:00.000Z"
},
"status": "failed",
"attemptCount": 7,
"returnStatus": 500,
"returnData": { "error": "internal server error" },
"errorMessage": "Request failed with status code 500",
"lastAttemptAt": "2026-06-25T20:16:00.000Z",
"createdAt": "2026-06-24T13:46:00.000Z",
"updatedAt": "2026-06-25T20:16:00.000Z"
}
```
## OpenAPI
````yaml openapi/psp.json GET /webhooks/deliveries/{id}
openapi: 3.0.3
info:
title: Z2Pay PSP API
version: 1.0.0
description: API pública do PSP — autenticação via API Key (Credential)
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Cards
description: Cartões salvos de um cliente
- name: Chargebacks
description: Gerenciamento de chargebacks
- name: Customers
description: Gerenciamento de clientes (compradores)
- name: Fees
description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
- name: Recipients
description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
- name: Refunds
description: Gerenciamento de reembolsos e estornos
- name: Splits
description: Regras de divisão do valor de uma venda entre recebedores
- name: Transactions
description: Gerenciamento de transações e payments
- name: Wallets
description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
- name: Webhooks
description: Configuração, gerenciamento e histórico de entregas de webhooks
- name: Withdrawals
description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
/webhooks/deliveries/{id}:
get:
tags:
- Webhooks
summary: Buscar delivery por ID
description: Retorna os dados de uma entrega específica incluindo payload e response
operationId: DeliveryController_getById
parameters:
- name: id
in: path
required: true
description: ID da delivery
schema:
type: string
responses:
'200':
description: Dados da delivery
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: Identificador único do registro.
webhookId:
type: string
description: ID do webhook relacionado ao registro.
eventType:
type: string
description: 'Tipo do evento entregue (ex.: transaction.paid).'
url:
type: string
description: URL de destino do webhook ou link de download do arquivo.
payload:
type: object
description: Conteúdo (payload) enviado na entrega do webhook.
status:
type: string
description: >-
Situação da entrega. Valores: `pending`, `success`,
`failed`, `retrying`.
attemptCount:
type: integer
description: Número de tentativas de entrega já realizadas.
returnStatus:
type: integer
nullable: true
description: Código de status HTTP retornado pelo endpoint na entrega.
returnData:
type: object
nullable: true
description: Corpo da resposta retornada pelo endpoint na entrega.
errorMessage:
type: string
nullable: true
description: Mensagem de erro quando o processamento falha.
lastAttemptAt:
type: string
format: date-time
nullable: true
description: Data e hora da última tentativa de entrega (ISO 8601).
createdAt:
type: string
format: date-time
description: Data e hora de criação do registro (ISO 8601).
updatedAt:
type: string
format: date-time
description: Data e hora da última atualização do registro (ISO 8601).
example:
id: whd_w2wwfrrrvwx9axbb1wj1bgg75
webhookId: whk_tnuvglgyl74mm7k3cx18mmd6h
eventType: transaction.refused
url: https://api.minhaloja.com.br/webhooks/z2pay
payload:
id: whd_w2wwfrrrvwx9axbb1wj1bgg75
type: transaction.refused
data:
id: txn_wb8adjjeajavewrebxzvv1wna
amount: 9990
status: refused
occurredAt: '2025-06-29T13:50:00.000Z'
status: failed
attemptCount: 3
returnStatus: 500
returnData:
error: Internal Server Error
errorMessage: Request failed with status code 500
lastAttemptAt: '2025-06-29T14:02:30.000Z'
createdAt: '2025-06-29T13:50:00.000Z'
updatedAt: '2025-06-29T14:02:30.000Z'
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
'404':
description: Delivery não encontrada
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: NOT_FOUND
message: Delivery not found
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````