Skip to main content
GET
/
transparents
/
list
Listar Checkouts Transparentes
curl --request GET \
  --url https://api.abacatepay.com/v2/transparents/list \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "pix_char_123456",
      "amount": 100,
      "status": "PENDING",
      "devMode": true,
      "brCode": "00020101021226950014br.gov.bcb.pix",
      "brCodeBase64": "data:image/png;base64,iVBORw0KGgoAAA",
      "platformFee": 80,
      "createdAt": "2025-03-24T21:50:20.772Z",
      "updatedAt": "2025-03-24T21:50:20.772Z",
      "expiresAt": "2025-03-25T21:50:20.772Z",
      "metadata": {}
    }
  ],
  "success": true,
  "error": null,
  "pagination": {
    "hasMore": true,
    "next": "<string>",
    "before": "<string>"
  }
}
Retorna todos os checkouts transparentes (PIX QR Code) da sua loja.

Requer a permissão CHECKOUT:READ.
Use limit, after e before para paginar. Cada item segue o mesmo formato da resposta do Criar QRCode PIX, incluindo status, brCode, amount e expiresAt.

Authorizations

​
Authorization
string
header
required

Todas as requisições devem incluir sua chave de API no header Authorization usando o formato Bearer <abacatepay-api-key>. Sem esse header a requisição será rejeitada.

Saiba mais sobre como criar e usar chaves de API na documentação de autenticação.

Query Parameters

​
after
string

Cursor para buscar itens após este ponto

​
before
string

Cursor para buscar itens antes deste ponto

​
limit
integer
default:100

Quantidade de itens por página (1-100)

Required range: 1 <= x <= 100
Example:

100

​
id
string

Filtrar por identificador único do QRCode Pix

Example:

"pix_char_123456"

​
status
enum<string>

Filtrar por status do QRCode Pix

Available options:
PENDING,
EXPIRED,
CANCELLED,
PAID,
REFUNDED

Response

Checkouts transparentes listados com sucesso.

​
data
object[]

Lista de Checkouts Transparentes (QRCodes PIX).

​
success
boolean

Se a requisição obteve sucesso ou não.

Example:

true

​
error
string | null
Example:

null

​
pagination
object

Informações de paginação baseada em cursor.