transparent.* avisam os pagamentos, reembolsos e disputas das cobranças do checkout transparente, criadas pela API sem passar pela página de pagamento. A entrega, as retentativas e a verificação estão em Webhooks.
| Evento | Quando dispara |
|---|---|
transparent.completed | Uma cobrança do checkout transparente é paga. |
transparent.refunded | Uma cobrança do checkout transparente é reembolsada. |
transparent.disputed | Uma disputa é aberta, ganha ou perdida. O status da cobrança mostra a fase. |
transparent.lost | A disputa de uma cobrança do checkout transparente é perdida. |
data chegam:
transparent: a cobrança, com o link do comprovante emreceiptUrle o seumetadata.customer: o cliente, com o CPF ou CNPJ mascarado.payerInformation: o método usado (PIX,CARDouBOLETO), as UTMs e quem pagou.reason: só notransparent.refundede notransparent.disputed.
- transparent.completed
- transparent.disputed
- transparent.refunded
Disparado quando a cobrança é paga. Pix e boleto chegam com
status: "PAID", e cartão com status: "APPROVED".- Pix
- Cartão
- Cartão parcelado
- Boleto
{
"id": "log_Qw8eR2tY4uI6oP1aS3dF5gH7",
"event": "transparent.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "pix_char_mXq2Lk7vB9nR4sT8yW1zC6dF",
"externalId": null,
"amount": 5000,
"customerFee": null,
"paidAmount": null,
"platformFee": 80,
"status": "PAID",
"items": [],
"methods": [],
"frequency": "ONE_TIME",
"coupons": [],
"devMode": false,
"customerId": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"createdAt": "2026-10-12T19:00:00.000Z",
"updatedAt": "2026-10-12T19:00:05.000Z",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"metadata": {
"pedidoId": "pedido-456"
}
},
"customer": {
"id": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "529.***.247-**"
},
"payerInformation": {
"method": "PIX",
"utms": { "source": null, "medium": null, "campaign": null, "term": null, "content": null },
"PIX": {
"name": "Maria Santos",
"taxId": "529.***.247-**",
"isSameAsCustomer": true
}
}
}
}
{
"id": "log_Zx9cV1bN3mL5kJ7hG2fD4sA6",
"event": "transparent.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "card_Wk3aD8sPq1XyZ7mN2bVc4LtR",
"externalId": null,
"amount": 10000,
"customerFee": null,
"paidAmount": null,
"platformFee": 410,
"status": "APPROVED",
"items": [],
"methods": [],
"frequency": "ONE_TIME",
"coupons": [],
"devMode": false,
"customerId": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"createdAt": "2026-10-12T14:20:31.512Z",
"updatedAt": "2026-10-12T14:20:32.104Z",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"metadata": {
"pedidoId": "pedido-123"
}
},
"customer": {
"id": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "529.***.247-**"
},
"payerInformation": {
"method": "CARD",
"utms": { "source": null, "medium": null, "campaign": null, "term": null, "content": null },
"CARD": {
"number": "4242",
"brand": "VISA"
}
}
}
}
{
"id": "log_Pl0oK9iJ8uH7yG6tF5rD4eS3",
"event": "transparent.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "card_Lr8pN3vKq2XwT6yB9mZc1HdS",
"externalId": null,
"amount": 30000,
"customerFee": null,
"paidAmount": null,
"platformFee": 811,
"status": "APPROVED",
"items": [],
"methods": [],
"frequency": "ONE_TIME",
"coupons": [],
"devMode": false,
"customerId": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"createdAt": "2026-10-12T14:25:02.118Z",
"updatedAt": "2026-10-12T14:25:02.940Z",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"metadata": {},
"installmentCount": 3,
"installmentAmount": 10000,
"installmentNumber": 1,
"installmentGroupId": "cinst_Qe5tY7uI9oP1aS3dF5gH7jK9"
},
"customer": {
"id": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "529.***.247-**"
},
"payerInformation": {
"method": "CARD",
"utms": { "source": null, "medium": null, "campaign": null, "term": null, "content": null },
"CARD": {
"number": "4242",
"brand": "VISA"
}
}
}
}
{
"id": "log_Mn4bV6cX8zL1kJ3hG5fD7sA9",
"event": "transparent.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "bole_k8pqr2mnvxT4yW6zC1dF3gH5",
"externalId": null,
"amount": 25000,
"customerFee": null,
"paidAmount": null,
"platformFee": 250,
"status": "PAID",
"items": [],
"methods": [],
"frequency": "ONE_TIME",
"coupons": [],
"devMode": false,
"customerId": "cust_Hk2mP4qR6sT8uV1wX3yZ5aB7",
"createdAt": "2026-10-04T14:22:10.381Z",
"updatedAt": "2026-10-06T10:15:00.000Z",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"metadata": {
"faturaId": "fatura-456"
}
},
"customer": {
"id": "cust_Hk2mP4qR6sT8uV1wX3yZ5aB7",
"name": "Mariana Costa",
"email": "mariana.costa@empresa.com.br",
"taxId": "12.***.678/0001-**"
},
"payerInformation": {
"method": "BOLETO",
"utms": { "source": null, "medium": null, "campaign": null, "term": null, "content": null },
"BOLETO": {
"name": "Mariana Costa",
"taxId": "12.***.678/0001-**",
"isSameAsCustomer": true
}
}
}
}
Disparado quando a disputa é aberta (
status: "UNDER_DISPUTE") e de novo quando ela termina: "PAID" se foi ganha, "REFUNDED" se foi perdida. No cartão a disputa é o chargeback, e no Pix é o MED, com o mesmo formato e payerInformation.PIX. Em reason vem o motivo informado na disputa ou "Dispute created".- Aberta
- Ganha
- Perdida
{
"id": "log_Bv3nM5qW7eR9tY1uI3oP5aS7",
"event": "transparent.disputed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "card_Wk3aD8sPq1XyZ7mN2bVc4LtR",
"externalId": null,
"amount": 10000,
"customerFee": null,
"paidAmount": null,
"platformFee": 410,
"status": "UNDER_DISPUTE",
"items": [],
"methods": [],
"frequency": "ONE_TIME",
"coupons": [],
"devMode": false,
"customerId": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"createdAt": "2026-10-12T14:20:31.512Z",
"updatedAt": "2026-10-28T09:12:40.220Z",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"metadata": {
"pedidoId": "pedido-123"
}
},
"customer": {
"id": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "529.***.247-**"
},
"payerInformation": {
"method": "CARD",
"utms": { "source": null, "medium": null, "campaign": null, "term": null, "content": null },
"CARD": {
"number": "4242",
"brand": "VISA"
}
},
"reason": "Dispute created"
}
}
{
"id": "log_Hg2fD4sA6zX8cV1bN3mL5kJ7",
"event": "transparent.disputed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "card_Wk3aD8sPq1XyZ7mN2bVc4LtR",
"externalId": null,
"amount": 10000,
"customerFee": null,
"paidAmount": null,
"platformFee": 410,
"status": "PAID",
"items": [],
"methods": [],
"frequency": "ONE_TIME",
"coupons": [],
"devMode": false,
"customerId": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"createdAt": "2026-10-12T14:20:31.512Z",
"updatedAt": "2026-11-20T15:03:11.874Z",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"metadata": {
"pedidoId": "pedido-123"
}
},
"customer": {
"id": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "529.***.247-**"
},
"payerInformation": {
"method": "CARD",
"utms": { "source": null, "medium": null, "campaign": null, "term": null, "content": null },
"CARD": {
"number": "4242",
"brand": "VISA"
}
},
"reason": "Dispute created"
}
}
{
"id": "log_Yt6rE4wQ2aS8dF0gH3jK5lZ7",
"event": "transparent.disputed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "card_Wk3aD8sPq1XyZ7mN2bVc4LtR",
"externalId": null,
"amount": 10000,
"customerFee": null,
"paidAmount": null,
"platformFee": 410,
"status": "REFUNDED",
"items": [],
"methods": [],
"frequency": "ONE_TIME",
"coupons": [],
"devMode": false,
"customerId": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"createdAt": "2026-10-12T14:20:31.512Z",
"updatedAt": "2026-11-20T15:03:11.874Z",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"metadata": {
"pedidoId": "pedido-123"
}
},
"customer": {
"id": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "529.***.247-**"
},
"payerInformation": {
"method": "CARD",
"utms": { "source": null, "medium": null, "campaign": null, "term": null, "content": null },
"CARD": {
"number": "4242",
"brand": "VISA"
}
},
"reason": "Dispute created"
}
}
Disparado quando a cobrança é reembolsada. Em
reason vem o motivo informado no reembolso ou "Refund completed". Veja Reembolsos.- Pix
- Cartão
{
"id": "log_Ui9oP1aS3dF5gH7jK9lZ2xC4",
"event": "transparent.refunded",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "pix_char_mXq2Lk7vB9nR4sT8yW1zC6dF",
"externalId": null,
"amount": 5000,
"customerFee": null,
"paidAmount": null,
"platformFee": 80,
"status": "REFUNDED",
"items": [],
"methods": [],
"frequency": "ONE_TIME",
"coupons": [],
"devMode": false,
"customerId": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"createdAt": "2026-10-12T19:00:00.000Z",
"updatedAt": "2026-10-14T11:30:00.000Z",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"metadata": {
"pedidoId": "pedido-456"
}
},
"customer": {
"id": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "529.***.247-**"
},
"payerInformation": {
"method": "PIX",
"utms": { "source": null, "medium": null, "campaign": null, "term": null, "content": null },
"PIX": {
"name": "Maria Santos",
"taxId": "529.***.247-**",
"isSameAsCustomer": true
}
},
"reason": "Cliente pediu o cancelamento"
}
}
{
"id": "log_Kj8hG6fD4sA2zX0cV8bN6mL4",
"event": "transparent.refunded",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "card_Wk3aD8sPq1XyZ7mN2bVc4LtR",
"externalId": null,
"amount": 10000,
"customerFee": null,
"paidAmount": null,
"platformFee": 410,
"status": "REFUNDED",
"items": [],
"methods": [],
"frequency": "ONE_TIME",
"coupons": [],
"devMode": false,
"customerId": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"createdAt": "2026-10-12T14:20:31.512Z",
"updatedAt": "2026-10-14T11:30:00.000Z",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"metadata": {
"pedidoId": "pedido-123"
}
},
"customer": {
"id": "cust_aB3dE5fG7hJ9kL1mN3pQ5rS7",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "529.***.247-**"
},
"payerInformation": {
"method": "CARD",
"utms": { "source": null, "medium": null, "campaign": null, "term": null, "content": null },
"CARD": {
"number": "4242",
"brand": "VISA"
}
},
"reason": "Refund completed"
}
}
Cartão: o que muda
- O status de pago é
APPROVED. Depois, quando o valor é liquidado, a cobrança passa aPAIDsem novo webhook. - Uma venda, um evento. Na venda parcelada chega um único
transparent.completed, com oidda primeira parcela,amountcom o total da venda e os camposinstallmentCount,installmentAmount,installmentNumbereinstallmentGroupId. A taxa é calculada sobre a venda inteira e dividida entre as parcelas, e oplatformFeedo evento é a parte da primeira parcela. Veja Parcelamento no cartão. - Repasse de taxa:
amounttraz o total pago pelo cliente, ecustomerFeetraz o acréscimo. Veja Repasse de taxa. - Bandeira e final do cartão ficam em
payerInformation.CARD(brandenumber). - O
cardTokennão vem no webhook. Guarde o que volta na resposta de Criar cobrança no cartão ou consulte a cobrança pela API.