Listar PIX

Consulta um envio de PIX pelo id. Apesar do nome, esta rota não pagina nem aceita filtros: id é obrigatório e o contrato é o mesmo de /pix/get.

get/pix/list

Query parameters

idstring required
Example:pix_out_abc123xyz

Identificador único do PIX enviado

externalIdstring
Example:pix-123

Identificador do PIX no seu sistema

Response

Lista de PIX retornada com sucesso.

successboolean

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

errorstring nullable

Example response

{
  "data": [
    {
      "id": "txn_abc123xyz",
      "status": "PENDING",
      "receiptUrl": "https://app.abacatepay.com/receipt/txn_abc123xyz",
      "amount": 10000,
      "platformFee": 100,
      "externalId": "pix-123",
      "createdAt": "2024-11-04T18:38:28.573Z",
      "updatedAt": "2024-11-04T18:38:28.573Z"
    }
  ],
  "success": true
}

Changes