Skip to main content
GET
Listar PIX
Retorna todas as transações PIX enviadas pela sua conta.
Requer a permissão WITHDRAW:READ.
Use limit, after e before para paginar e startDate/endDate (YYYY-MM-DD) para filtrar por data de criação. Consulte Paginação e filtro por data. Cada item segue o mesmo formato da resposta do Enviar PIX, incluindo status, amount, platformFee e receiptUrl.

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

id
string
required

Identificador único do PIX enviado

Example:

"pix_out_abc123xyz"

externalId
string

Identificador do PIX no seu sistema

Example:

"pix-123"

Response

Lista de PIX retornada com sucesso.

data
object[]

Lista de transações PIX criadas.

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.