Skip to main content
GET
/
pix
/
get
Buscar PIX
curl --request GET \
  --url https://api.abacatepay.com/v2/pix/get \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "txn_abc123xyz",
    "status": "PENDING",
    "devMode": false,
    "receiptUrl": "https://app.abacatepay.com/receipt/txn_abc123xyz",
    "amount": 10000,
    "platformFee": 100,
    "createdAt": "2024-11-04T18:38:28.573Z",
    "updatedAt": "2024-11-04T18:38:28.573Z",
    "externalId": "pix-123"
  },
  "error": null,
  "success": true
}
Retorna os dados de uma transação PIX pelo seu id.

Requer a permissão WITHDRAW:READ.
Use para acompanhar o status de um envio após criar a transação. Valores de status:
ValorSignificado
PENDINGAguardando processamento
COMPLETEEnviado com sucesso — receiptUrl disponível
CANCELLEDCancelado
REFUNDEDReembolsado

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

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

Example:

"txn_abc123xyz"

​
externalId
string

Identificador único do PIX em seu sistema.

Example:

"pix-123"

Response

Detalhes do PIX retornados com sucesso.

​
data
object

Dados de uma transação PIX.

​
error
string | null
Example:

null

​
success
boolean

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

Example:

true