- checkout.completed
- checkout.disputed
- checkout.refunded
Disparado quando um pagamento via checkout é realizado. O
payerInformation varia conforme o método.- PIX
- Cartão
- Boleto
{
"event": "checkout.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"checkout": {
"id": "bill_abc123xyz",
"externalId": "pedido-123",
"url": "https://app.abacatepay.com/pay/bill_abc123xyz",
"amount": 10000,
"paidAmount": 10000,
"platformFee": 80,
"frequency": "ONE_TIME",
"items": [{ "id": "prod_xyz", "quantity": 1 }],
"status": "PAID",
"methods": ["PIX"],
"customerId": "cust_abc123",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"installmentsCount": null,
"createdAt": "2024-12-06T18:56:15.538Z",
"updatedAt": "2024-12-06T18:56:20.000Z"
},
"customer": {
"id": "cust_abc123",
"name": "João Silva",
"email": "joao@exemplo.com",
"taxId": "123.***.***-**"
},
"payerInformation": {
"method": "PIX",
"PIX": {
"name": "João Silva",
"taxId": "123.***.***-**",
"isSameAsCustomer": true
}
}
}
}
{
"event": "checkout.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"checkout": {
"id": "bill_abc123xyz",
"externalId": "pedido-123",
"url": "https://app.abacatepay.com/pay/bill_abc123xyz",
"amount": 10000,
"paidAmount": 10000,
"platformFee": 120,
"frequency": "ONE_TIME",
"items": [{ "id": "prod_xyz", "quantity": 1 }],
"status": "PAID",
"methods": ["CARD"],
"customerId": "cust_abc123",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"installmentsCount": 3,
"createdAt": "2024-12-06T18:56:15.538Z",
"updatedAt": "2024-12-06T18:56:20.000Z"
},
"customer": {
"id": "cust_abc123",
"name": "João Silva",
"email": "joao@exemplo.com",
"taxId": "123.***.***-**"
},
"payerInformation": {
"method": "CARD",
"CARD": {
"number": "1234",
"brand": "VISA"
}
}
}
}
{
"event": "checkout.completed",
"apiVersion": 2,
"devMode": false,
"data": {
"checkout": {
"id": "bill_abc123xyz",
"externalId": "pedido-123",
"url": "https://app.abacatepay.com/pay/bill_abc123xyz",
"amount": 10000,
"paidAmount": 10000,
"platformFee": 100,
"frequency": "ONE_TIME",
"items": [{ "id": "prod_xyz", "quantity": 1 }],
"status": "PAID",
"methods": ["BOLETO"],
"customerId": "cust_abc123",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"installmentsCount": null,
"createdAt": "2024-12-06T18:56:15.538Z",
"updatedAt": "2024-12-06T18:56:20.000Z"
},
"customer": {
"id": "cust_abc123",
"name": "João Silva",
"email": "joao@exemplo.com",
"taxId": "123.***.***-**"
},
"payerInformation": {
"method": "BOLETO",
"BOLETO": {
"name": "João Silva",
"taxId": "123.***.***-**",
"isSameAsCustomer": true
}
}
}
}
Disparado quando um pagamento via checkout sofre uma disputa. O
payerInformation varia conforme o método.- PIX
- Cartão
- Boleto
{
"event": "checkout.disputed",
"apiVersion": 2,
"devMode": false,
"data": {
"checkout": {
"id": "bill_abc123xyz",
"externalId": "pedido-123",
"url": "https://app.abacatepay.com/pay/bill_abc123xyz",
"amount": 10000,
"paidAmount": 10000,
"platformFee": 80,
"frequency": "ONE_TIME",
"items": [{ "id": "prod_xyz", "quantity": 1 }],
"status": "PAID",
"methods": ["PIX"],
"customerId": "cust_abc123",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"installmentsCount": null,
"createdAt": "2024-12-06T18:56:15.538Z",
"updatedAt": "2024-12-06T18:56:20.000Z"
},
"customer": {
"id": "cust_abc123",
"name": "João Silva",
"email": "joao@exemplo.com",
"taxId": "123.***.***-**"
},
"payerInformation": {
"method": "PIX",
"PIX": {
"name": "João Silva",
"taxId": "123.***.***-**",
"isSameAsCustomer": true
}
},
"reason": "requested_by_customer"
}
}
{
"event": "checkout.disputed",
"apiVersion": 2,
"devMode": false,
"data": {
"checkout": {
"id": "bill_abc123xyz",
"externalId": "pedido-123",
"url": "https://app.abacatepay.com/pay/bill_abc123xyz",
"amount": 10000,
"paidAmount": 10000,
"platformFee": 120,
"frequency": "ONE_TIME",
"items": [{ "id": "prod_xyz", "quantity": 1 }],
"status": "PAID",
"methods": ["CARD"],
"customerId": "cust_abc123",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"installmentsCount": 3,
"createdAt": "2024-12-06T18:56:15.538Z",
"updatedAt": "2024-12-06T18:56:20.000Z"
},
"customer": {
"id": "cust_abc123",
"name": "João Silva",
"email": "joao@exemplo.com",
"taxId": "123.***.***-**"
},
"payerInformation": {
"method": "CARD",
"CARD": {
"number": "1234",
"brand": "VISA"
}
},
"reason": "requested_by_customer"
}
}
{
"event": "checkout.disputed",
"apiVersion": 2,
"devMode": false,
"data": {
"checkout": {
"id": "bill_abc123xyz",
"externalId": "pedido-123",
"url": "https://app.abacatepay.com/pay/bill_abc123xyz",
"amount": 10000,
"paidAmount": 10000,
"platformFee": 100,
"frequency": "ONE_TIME",
"items": [{ "id": "prod_xyz", "quantity": 1 }],
"status": "PAID",
"methods": ["BOLETO"],
"customerId": "cust_abc123",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"installmentsCount": null,
"createdAt": "2024-12-06T18:56:15.538Z",
"updatedAt": "2024-12-06T18:56:20.000Z"
},
"customer": {
"id": "cust_abc123",
"name": "João Silva",
"email": "joao@exemplo.com",
"taxId": "123.***.***-**"
},
"payerInformation": {
"method": "BOLETO",
"BOLETO": {
"name": "João Silva",
"taxId": "123.***.***-**",
"isSameAsCustomer": true
}
},
"reason": "requested_by_customer"
}
}
Disparado quando um pagamento via checkout é reembolsado. O
payerInformation varia conforme o método.- PIX
- Cartão
- Boleto
{
"event": "checkout.refunded",
"apiVersion": 2,
"devMode": false,
"data": {
"checkout": {
"id": "bill_abc123xyz",
"externalId": "pedido-123",
"url": "https://app.abacatepay.com/pay/bill_abc123xyz",
"amount": 10000,
"paidAmount": 10000,
"platformFee": 80,
"frequency": "ONE_TIME",
"items": [{ "id": "prod_xyz", "quantity": 1 }],
"status": "PAID",
"methods": ["PIX"],
"customerId": "cust_abc123",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"installmentsCount": null,
"createdAt": "2024-12-06T18:56:15.538Z",
"updatedAt": "2024-12-06T18:56:20.000Z"
},
"customer": {
"id": "cust_abc123",
"name": "João Silva",
"email": "joao@exemplo.com",
"taxId": "123.***.***-**"
},
"payerInformation": {
"method": "PIX",
"PIX": {
"name": "João Silva",
"taxId": "123.***.***-**",
"isSameAsCustomer": true
}
},
"reason": "requested_by_customer"
}
}
{
"event": "checkout.refunded",
"apiVersion": 2,
"devMode": false,
"data": {
"checkout": {
"id": "bill_abc123xyz",
"externalId": "pedido-123",
"url": "https://app.abacatepay.com/pay/bill_abc123xyz",
"amount": 10000,
"paidAmount": 10000,
"platformFee": 120,
"frequency": "ONE_TIME",
"items": [{ "id": "prod_xyz", "quantity": 1 }],
"status": "PAID",
"methods": ["CARD"],
"customerId": "cust_abc123",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"installmentsCount": 3,
"createdAt": "2024-12-06T18:56:15.538Z",
"updatedAt": "2024-12-06T18:56:20.000Z"
},
"customer": {
"id": "cust_abc123",
"name": "João Silva",
"email": "joao@exemplo.com",
"taxId": "123.***.***-**"
},
"payerInformation": {
"method": "CARD",
"CARD": {
"number": "1234",
"brand": "VISA"
}
},
"reason": "requested_by_customer"
}
}
{
"event": "checkout.refunded",
"apiVersion": 2,
"devMode": false,
"data": {
"checkout": {
"id": "bill_abc123xyz",
"externalId": "pedido-123",
"url": "https://app.abacatepay.com/pay/bill_abc123xyz",
"amount": 10000,
"paidAmount": 10000,
"platformFee": 100,
"frequency": "ONE_TIME",
"items": [{ "id": "prod_xyz", "quantity": 1 }],
"status": "PAID",
"methods": ["BOLETO"],
"customerId": "cust_abc123",
"receiptUrl": "https://app.abacatepay.com/receipt/...",
"installmentsCount": null,
"createdAt": "2024-12-06T18:56:15.538Z",
"updatedAt": "2024-12-06T18:56:20.000Z"
},
"customer": {
"id": "cust_abc123",
"name": "João Silva",
"email": "joao@exemplo.com",
"taxId": "123.***.***-**"
},
"payerInformation": {
"method": "BOLETO",
"BOLETO": {
"name": "João Silva",
"taxId": "123.***.***-**",
"isSameAsCustomer": true
}
},
"reason": "requested_by_customer"
}
}