Skip to main content
GET
Get payment status

📌 Endpoint

GET /stores/{storeId}/payments/status/{uuid} Returns the current status of a store payment by its public uuid. Ideal for checkout polling after generating a PIX or boleto charge.

🔐 Authentication

  • Public route (no Authorization header required).
  • The store linked to storeId must have an active plan.

🧾 Path parameters


✅ Request example


📦 Success response (200)

Possible payment.status values: PENDING, APPROVED, REJECTED, CANCELLED, REFUNDED, CHARGED_BACK, EXPIRED.

⚠️ Possible errors

  • 400 INVALID_DATA → invalid storeId or uuid is not a valid UUID
  • 401 UNAUTHENTICATED → store without an associated owner or unavailable database connection
  • 403 NO_ACTIVE_SUBSCRIPTION → store has no active plan or plan expired
  • 404 STORE_NOT_FOUND → store not found
  • 404 PAYMENT_NOT_FOUND → payment not found in this store
  • 429 RATE_LIMIT_EXCEEDED → plan per-minute rate limit exceeded
  • 503 SERVICE_UNAVAILABLE → service temporarily unavailable

Path Parameters

storeId
string
required
Required string length: 1 - 50
uuid
string<uuid>
required

Response

Payment status retrieved successfully.

code
string
required
Example:

"PAYMENT_STATUS"

payment
object
required