Pular para o conteúdo principal
GET
Get payment by ID

📌 Endpoint

GET /stores/{storeId}/payments/{paymentId} Retorna um pagamento específico da loja com os produtos (id, name, price, image, description) e a metadata do pagamento — que guarda o snapshot dos produtos (items[].product), quantidade, ciclo de cobrança e o cupom aplicado (items[].coupon) quando houver.

🔐 Autenticação

  • Rota privada.
  • Requer header Authorization com sua API key e plano ativo.

🧾 Parâmetros de rota


✅ Exemplo de requisição


📦 Resposta de sucesso (200)


⚠️ Possíveis erros

  • 400 INVALID_DATA → parâmetros inválidos
  • 401 API_KEY_NOT_PROVIDED → header Authorization não enviado
  • 401 INVALID_API_KEY → API key inválida
  • 401 UNAUTHENTICATED → usuário não autenticado
  • 403 USER_DISABLED → usuário desativado ou removido
  • 403 NO_ACTIVE_SUBSCRIPTION → plano inativo ou expirado
  • 404 STORE_NOT_FOUND → loja não encontrada
  • 404 PAYMENT_NOT_FOUND → pagamento não encontrado
  • 429 RATE_LIMIT_EXCEEDED → limite de requisições por minuto do plano excedido
  • 503 SERVICE_UNAVAILABLE → serviço temporariamente indisponível

Autorizações

Authorization
string
header
padrão:YOUR_API_KEY_HERE
obrigatório

Parâmetros de caminho

storeId
string
obrigatório
Required string length: 1 - 50
paymentId
string
obrigatório
Required string length: 1 - 50

Resposta

Get payment by ID.

code
string
obrigatório
Exemplo:

"PAYMENT_FETCHED"

payment
object
obrigatório

Store payment/charge.