v2

latestOpenAPI 3.1.02026-07-314524165.2 KB

Buscar PIX

Permite que você recupere os detalhes de uma transação PIX específica usando o ID ou externalId.

Você pode buscar usando:

id: Identificador único da transação PIX na AbacatePay
externalId: Identificador único do PIX em seu sistema

Importante: Você deve fornecer pelo menos um dos parâmetros (id ou externalId).

get/pix/get

Query parameters

idstring

Example:txn_abc123xyz

Identificador único da transação PIX na AbacatePay.

externalIdstring

Example:pix-123

Identificador único do PIX em seu sistema.

Response

Detalhes do PIX retornados com sucesso.

errorstring nullable

successboolean

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

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
}