> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cabrapi.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Payment Status

> Check the current status of a payment by its public UUID using GET /stores/{storeId}/payments/status/{uuid}.

## 📌 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

| Parameter | Type | Required | Description |
| - | - | - | - |
| `storeId` | string | Yes | Store ID |
| `uuid` | string (UUID) | Yes | Public payment UUID |

***

## ✅ Request example

```bash theme={null}
curl -X GET "https://api.cabrapi.com.br/v1/stores/STORE_ID/payments/status/PAYMENT_UUID"
```

***

## 📦 Success response (200)

```json theme={null}
{
	"code": "PAYMENT_STATUS",
	"payment": {
		"uuid": "56c4cc47-105d-4260-a938-7a4383028d2c",
		"status": "APPROVED"
	}
}
```

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


## OpenAPI

````yaml GET /stores/{storeId}/payments/status/{uuid}
openapi: 3.1.0
info:
  title: caBRAPI
  version: 1.0.0
servers:
  - url: https://api.cabrapi.com.br/v1
security: []
paths:
  /stores/{storeId}/payments/status/{uuid}:
    get:
      tags:
        - Payments
      summary: Get payment status
      operationId: getPaymentStatus
      parameters:
        - $ref: '#/components/parameters/StoreId'
        - $ref: '#/components/parameters/UUID'
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  code:
                    example: PAYMENT_STATUS
                    type: string
                  payment:
                    properties:
                      status:
                        enum:
                          - PENDING
                          - APPROVED
                          - REJECTED
                          - CANCELLED
                          - REFUNDED
                          - CHARGED_BACK
                          - EXPIRED
                        example: APPROVED
                        type: string
                      uuid:
                        example: 550e8400-e29b-41d4-a716-446655440000
                        type: string
                    required:
                      - uuid
                      - status
                    type: object
                required:
                  - code
                  - payment
                type: object
          description: Payment status retrieved successfully.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Invalid request (invalid UUID or invalid storeId).
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized (missing store owner or unavailable database).
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden (NO_ACTIVE_SUBSCRIPTION).
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Payment or store not found.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Rate limit exceeded.
        '503':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Service unavailable.
      security: []
components:
  parameters:
    StoreId:
      in: path
      name: storeId
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 50
    UUID:
      in: path
      name: uuid
      required: true
      schema:
        format: uuid
        type: string
  schemas:
    Error:
      properties:
        code:
          example: STORE_NOT_FOUND
          type: string
      required:
        - code
      type: object

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.