GET Estado Atual do Pagamento
Devolve o mesmo formato do data dos eventos payment.*. Serve para reconciliar: como a entrega de webhooks não é ordenada, o consumidor pode reconsultar o estado atual do recurso e comparar o version. O id é o da movimentação financeira.
Autenticação necessária
Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.
Permissão necessária
Exige a permissão manage_webhooks.
Endpoint
GET https://api-dev.imagemais.com.br/api/webhooks/resources/payments/{id}
Parâmetros de Rota
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
id | number | ✅ | ID do pagamento (movimentação) |
Requisição
curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/webhooks/resources/payments/1' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {accessToken}'
Respostas
200 Sucesso
{
"object": "payment",
"id": 880,
"version": 1759771930123,
"status": "PAID",
"amount": "150.00",
"currency": "BRL",
"method": "CARTAO_CREDITO",
"card": {
"brand": "visa",
"installments": 1
},
"budget_id": 5501,
"appointment_ids": [
98765
],
"cash_register_id": 31,
"cancellation_reason": null,
"created_at": "2026-10-06T14:30:00-03:00",
"updated_at": "2026-10-06T14:32:10-03:00"
}
Valores de status: PENDING, PAID, CANCELED. card só vem para pagamentos em cartão (crédito, crédito via link e débito); nos demais é null. method é o nome da forma de pagamento cadastrada.
400 Requisição inválida
Retornado quando o id não é numérico.
{
"message": "Validation failed (numeric string is expected)",
"error": "Bad Request",
"statusCode": 400
}
403 Sem permissão
{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}
404 Não encontrado
{
"message": "Pagamento não encontrado",
"error": "Not Found",
"statusCode": 404
}