Cancelar pagamento
Cancele uma cobrança Pix ainda ativa.
Cancela uma cobrança Pix ainda ativa, alterando o status do pagamento para CANCELLED.
PATCH /payments/:pix_id/cancel
Requer autenticação. Envie suas credenciais no header Authorization. Veja Autenticação.
O cancelamento só é possível enquanto o pagamento ainda estiver ativo. Pagamentos já concluídos ou expirados retornam erro 422.
Se o pagamento já estiver cancelado, repetir a chamada de cancelamento retorna sucesso com status CANCELLED.
Requisição
PATCH /payments/{pix_id}/cancel
Authorization: Basic <suas_credenciais_em_base64>Este endpoint não recebe corpo.
Parâmetros
Prop
Type
Resposta
{
"pix_id": "ba5ce1d5cd58ff77d99b36cee2224e37",
"status": "CANCELLED"
}Campos da resposta
Prop
Type
Códigos de status
| Status | Descrição |
|---|---|
| 200 | Pagamento cancelado ou já cancelado |
| 401 | Não autenticado |
| 404 | Pagamento não encontrado |
| 422 | Pagamento concluído ou expirado, e não pode mais ser cancelado |
Exemplos
curl -X PATCH https://public-api.paggpix.com/payments/{pix_id}/cancel \
-H "Authorization: Basic <suas_credenciais_em_base64>"const axios = require('axios');
const CLIENT_ID = '<seu_client_id>';
const CLIENT_SECRET = '<seu_client_secret>';
const CREDENTIALS = Buffer.from(`${CLIENT_ID}:${CLIENT_SECRET}`).toString('base64');
const BASE_URL = 'https://public-api.paggpix.com';
async function cancelPayment(pixId) {
try {
const { data } = await axios.patch(
`${BASE_URL}/payments/${pixId}/cancel`,
{},
{ headers: { Authorization: `Basic ${CREDENTIALS}` } },
);
console.log(`Payment cancelled: id = ${data.pix_id}, status = ${data.status}`);
} catch (error) {
console.error(error.response ? error.response.data : error.message);
}
}