ABabacatepay

Listar Checkouts Transparentes

Changed on

Retorna todos os Checkouts Transparentes (QRCodes PIX) que você criou.

Você pode usar essa rota para listar todos os seus checkouts transparentes e visualizar seus status, valores e informações relacionadas.

get/transparents/list

Request

  • Base URL
    https://api.abacatepay.com/v2
  • URL
    https://api.abacatepay.com/v2/transparents/list
  • Auth
    HTTP bearer

Query parameters

afterstring

Cursor para buscar itens após este ponto (use o publicId retornado em pagination.next).

beforestring

Cursor para buscar itens antes deste ponto (use o publicId retornado em pagination.before).

limitinteger
Example:100

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

startDatestring date
Example:2026-01-01

Filtra registros criados a partir desta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (00:00 do dia inicial).

endDatestring date
Example:2026-01-31

Filtra registros criados até esta data (inclusive). Formato YYYY-MM-DD. O intervalo é interpretado no fuso horário America/Sao_Paulo (23:59:59.999 do dia final).

idstring
Example:pix_char_123456

Filtrar por identificador único do QRCode Pix

status'PENDING' | 'EXPIRED' | 'CANCELLED' | 'PAID' | 'REFUNDED'

Filtrar por status do QRCode Pix

externalIdstring

Filtrar por identificador do Checkout Transparente no seu sistema

method'PIX' | 'CARD' | 'PIX_QRCODE' | 'BOLETO'

Filtrar por método de pagamento

Response

Checkouts transparentes listados com sucesso.

successboolean

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

errorstring nullable

Example response

{
  "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"
    }
  ],
  "success": true
}

Changes

  • ea8a72b04f2aRevision changes
    • info

      added the new optional query request parameter externalId

    • info

      added the new optional query request parameter method

  • 6b89a7fa70f5Revision changes
    • info

      added the new optional query request parameter endDate

    • info

      added the new optional query request parameter startDate