Skip to main content

​
Estrutura

Uma cobrança via QRCode Pix é representada em nossa API pela seguinte estrutura:
json
{
  "id": "pix_charabc123456789",
  "amount": 4000,
  "status": "PAID",
  "devMode": true,
  "method": "PIX",
  "brCode": "...",
  "brCodeBase64": "...",
  "platformFee": 80,
  "description": "Pagamento PIX com AbacatePay",
  "metadata": {
    "pedidoId": "123"
  },
  "createdAt": "2024-12-06T18:56:15.538Z",
  "updatedAt": "2024-12-06T18:56:15.538Z",
  "expiresAt": "2024-12-06T18:56:15.538Z"
}

​
Atributos:

json
{
"id": "abc123uA0M0xwg5R4mSyr0n2PjHQXY"
}
id : string.
Identificador único da cobrança.
json
{
"amount": 4000
}
amount : number.
Valor da cobrança em centavos (ex: 4000 = R$ 40,00)
json
{
"status": "PAID"
}
status : string.
Status da cobrança. Pode ser PENDING, EXPIRED, CANCELLED, PAID, REFUNDED.
StatusDescrição
PENDINGA cobrança está com o pagamento pendente
EXPIREDO tempo limite de pagamento foi excedido
CANCELLEDA cobrança foi cancelada por você
PAIDA cobrança foi paga com sucesso pelo cliente
REFUNDEDO valor foi devolvido ao cliente
json
{
"devMode": true
}
devMode : boolean.
Indica se a cobrança está em ambiente de testes (true) ou produção (false).
json
{
"method": "PIX"
}
method : string.
Método de pagamento.
json
{
"brCode": "..."
}
brCode : string.
Código PIX (copia-e-cola) para pagamento.
json
{
"brCodeBase64": "..."
}
brCodeBase64 : string.
Código PIX no formato Base64 (útil para exibição em imagens).
json
{
"platformFee": 80
}
platformFee : number.
Taxa da plataforma em centavos. Exemplo: 80 significa R$ 0,80.
json
{
"description": "Pagamento PIX com AbacatePay"
}
description : string.
Descrição da cobrança.
json
{
"createdAt": "2024-12-06T18:56:15.538Z"
}
createdAt : date-time.
Data e hora da criação da cobrança.
json
{
"updatedAt": "2024-12-06T18:56:15.538Z"
}
updatedAt : date-time.
Última atualização da cobrança.
json
{
"expiresAt": "2024-12-06T18:56:15.538Z"
}
expiresAt : date-time.
Data e hora de expiração do QRCode.