Pular para o conteúdo principal
GET
Get payment status

📌 Endpoint

GET /stores/{storeId}/payments/status/{uuid} Retorna o status atual de um pagamento específico da loja a partir do uuid público. Ideal para polling no checkout após gerar um PIX ou boleto.

🔐 Autenticação

  • Rota pública (não exige Authorization).
  • A loja vinculada ao storeId precisa estar com plano ativo.

🧾 Parâmetros de rota


✅ Exemplo de requisição


📦 Resposta de sucesso (200)

Valores possíveis para payment.status: PENDING, APPROVED, REJECTED, CANCELLED, REFUNDED, CHARGED_BACK, EXPIRED.

⚠️ Possíveis erros

  • 400 INVALID_DATA → storeId inválido ou uuid não é um UUID válido
  • 401 UNAUTHENTICATED → loja sem proprietário associado ou conexão indisponível
  • 403 NO_ACTIVE_SUBSCRIPTION → loja sem plano ativo ou plano expirado
  • 404 STORE_NOT_FOUND → loja não encontrada
  • 404 PAYMENT_NOT_FOUND → pagamento não encontrado nesta loja
  • 429 RATE_LIMIT_EXCEEDED → limite de requisições por minuto do plano excedido
  • 503 SERVICE_UNAVAILABLE → serviço temporariamente indisponível

Parâmetros de caminho

storeId
string
obrigatório
Required string length: 1 - 50
uuid
string<uuid>
obrigatório

Resposta

Payment status retrieved successfully.

code
string
obrigatório
Exemplo:

"PAYMENT_STATUS"

payment
object
obrigatório