Documentation Index
Fetch the complete documentation index at: https://docs.abacatepay.com/llms.txt
Use this file to discover all available pages before exploring further.
- transparent.completed
- transparent.disputed
- transparent.refunded
Disparado quando um pagamento via checkout transparente é realizado. O
payerInformation varia conforme o método.- PIX
- Cartão
- Boleto
{
"event": "transparent.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "char_xyz789",
"externalId": "pedido-456",
"amount": 5000,
"paidAmount": 5000,
"platformFee": 50,
"status": "PAID",
"frequency": "ONE_TIME",
"devMode": true,
"customerId": "cust_abc123",
"methods": ["PIX"],
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"createdAt": "2024-12-06T19:00:00.000Z",
"updatedAt": "2024-12-06T19:00:05.000Z"
},
"customer": {
"id": "cust_def456",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "12.***.***/0001-**"
},
"payerInformation": {
"method": "PIX",
"PIX": {
"name": "Maria Santos",
"taxId": "12.***.***/0001-**",
"isSameAsCustomer": true
}
}
}
}
{
"event": "transparent.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "char_xyz789",
"externalId": "pedido-456",
"amount": 5000,
"paidAmount": 5000,
"platformFee": 78,
"status": "PAID",
"frequency": "ONE_TIME",
"devMode": true,
"customerId": "cust_abc123",
"methods": ["CARD"],
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"createdAt": "2024-12-06T19:00:00.000Z",
"updatedAt": "2024-12-06T19:00:05.000Z"
},
"customer": {
"id": "cust_def456",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "12.***.***/0001-**"
},
"payerInformation": {
"method": "CARD",
"CARD": {
"number": "1234",
"brand": "VISA"
}
}
}
}
{
"event": "transparent.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "bole_k8pqr2mnvx",
"externalId": "pedido-456",
"amount": 25000,
"paidAmount": 25000,
"platformFee": 250,
"status": "PAID",
"frequency": "ONE_TIME",
"devMode": false,
"customerId": "cust_abc123",
"methods": ["BOLETO"],
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"createdAt": "2024-11-04T14:22:10.381Z",
"updatedAt": "2024-11-04T14:22:15.000Z"
},
"customer": {
"id": "cust_def456",
"name": "Mariana Costa",
"email": "mariana.costa@empresa.com.br",
"taxId": "98*.***.***/0001-**"
},
"payerInformation": {
"method": "BOLETO",
"BOLETO": {
"name": "Mariana Costa",
"taxId": "98*.***.***/0001-**",
"isSameAsCustomer": true
}
}
}
}
Disparado quando um pagamento via checkout transparente sofre uma disputa. O
payerInformation varia conforme o método.- PIX
- Cartão
- Boleto
{
"event": "transparent.disputed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "char_xyz789",
"externalId": "pedido-456",
"amount": 5000,
"paidAmount": 5000,
"platformFee": 50,
"status": "PAID",
"frequency": "ONE_TIME",
"devMode": true,
"customerId": "cust_abc123",
"methods": ["PIX"],
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"createdAt": "2024-12-06T19:00:00.000Z",
"updatedAt": "2024-12-06T19:00:05.000Z"
},
"customer": {
"id": "cust_def456",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "12.***.***/0001-**"
},
"payerInformation": {
"method": "PIX",
"PIX": {
"name": "Maria Santos",
"taxId": "12.***.***/0001-**",
"isSameAsCustomer": true
}
},
"reason": "requested_by_customer"
}
}
{
"event": "transparent.disputed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "char_xyz789",
"externalId": "pedido-456",
"amount": 5000,
"paidAmount": 5000,
"platformFee": 78,
"status": "PAID",
"frequency": "ONE_TIME",
"devMode": true,
"customerId": "cust_abc123",
"methods": ["CARD"],
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"createdAt": "2024-12-06T19:00:00.000Z",
"updatedAt": "2024-12-06T19:00:05.000Z"
},
"customer": {
"id": "cust_def456",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "12.***.***/0001-**"
},
"payerInformation": {
"method": "CARD",
"CARD": {
"number": "1234",
"brand": "VISA"
}
},
"reason": "requested_by_customer"
}
}
{
"event": "transparent.disputed",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "bole_k8pqr2mnvx",
"externalId": "pedido-456",
"amount": 25000,
"paidAmount": 25000,
"platformFee": 250,
"status": "PAID",
"frequency": "ONE_TIME",
"devMode": false,
"customerId": "cust_abc123",
"methods": ["BOLETO"],
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"createdAt": "2024-11-04T14:22:10.381Z",
"updatedAt": "2024-11-04T14:22:15.000Z"
},
"customer": {
"id": "cust_def456",
"name": "Mariana Costa",
"email": "mariana.costa@empresa.com.br",
"taxId": "98*.***.***/0001-**"
},
"payerInformation": {
"method": "BOLETO",
"BOLETO": {
"name": "Mariana Costa",
"taxId": "98*.***.***/0001-**",
"isSameAsCustomer": true
}
},
"reason": "requested_by_customer"
}
}
Disparado quando um pagamento via checkout transparente é reembolsado. O
payerInformation varia conforme o método.- PIX
- Cartão
- Boleto
{
"event": "transparent.refunded",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "char_xyz789",
"externalId": "pedido-456",
"amount": 5000,
"paidAmount": 5000,
"platformFee": 50,
"status": "PAID",
"frequency": "ONE_TIME",
"devMode": true,
"customerId": "cust_abc123",
"methods": ["PIX"],
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"createdAt": "2024-12-06T19:00:00.000Z",
"updatedAt": "2024-12-06T19:00:05.000Z"
},
"customer": {
"id": "cust_def456",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "12.***.***/0001-**"
},
"payerInformation": {
"method": "PIX",
"PIX": {
"name": "Maria Santos",
"taxId": "12.***.***/0001-**",
"isSameAsCustomer": true
}
},
"reason": "requested_by_customer"
}
}
{
"event": "transparent.refunded",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "char_xyz789",
"externalId": "pedido-456",
"amount": 5000,
"paidAmount": 5000,
"platformFee": 78,
"status": "PAID",
"frequency": "ONE_TIME",
"devMode": true,
"customerId": "cust_abc123",
"methods": ["CARD"],
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"createdAt": "2024-12-06T19:00:00.000Z",
"updatedAt": "2024-12-06T19:00:05.000Z"
},
"customer": {
"id": "cust_def456",
"name": "Maria Santos",
"email": "maria@exemplo.com",
"taxId": "12.***.***/0001-**"
},
"payerInformation": {
"method": "CARD",
"CARD": {
"number": "1234",
"brand": "VISA"
}
},
"reason": "requested_by_customer"
}
}
{
"event": "transparent.refunded",
"apiVersion": 2,
"devMode": false,
"data": {
"transparent": {
"id": "bole_k8pqr2mnvx",
"externalId": "pedido-456",
"amount": 25000,
"paidAmount": 25000,
"platformFee": 250,
"status": "PAID",
"frequency": "ONE_TIME",
"devMode": false,
"customerId": "cust_abc123",
"methods": ["BOLETO"],
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"createdAt": "2024-11-04T14:22:10.381Z",
"updatedAt": "2024-11-04T14:22:15.000Z"
},
"customer": {
"id": "cust_def456",
"name": "Mariana Costa",
"email": "mariana.costa@empresa.com.br",
"taxId": "98*.***.***/0001-**"
},
"payerInformation": {
"method": "BOLETO",
"BOLETO": {
"name": "Mariana Costa",
"taxId": "98*.***.***/0001-**",
"isSameAsCustomer": true
}
},
"reason": "requested_by_customer"
}
}