Skip to main content

📌 Endpoint

DELETE /stores/:storeId/payments/:paymentId Exclui um pagamento expirado da loja.

🔐 Autenticação

  • Rota privada.
  • Requer header Authorization com sua API key e plano ativo.
{
	"Authorization": "SUA_API_KEY_AQUI"
}

🧾 Parâmetros de rota

ParâmetroTipoObrigatórioDescrição
storeIdstringSimID da loja
paymentIdstringSimID do pagamento

✅ Exemplo de requisição

curl -X DELETE "https://api.cabrapi.com.br/stores/STORE_ID/payments/PAYMENT_ID" \
	-H "Authorization: SUA_API_KEY_AQUI"

🧩 Snippet (JavaScript - fetch, só trocar Authorization)

const API_BASE = "https://api.cabrapi.com.br";
const AUTHORIZATION = "SUA_API_KEY_AQUI";

const storesResponse = await fetch(`${API_BASE}/stores`, {
	headers: { Authorization: AUTHORIZATION }
});
const storesData = await storesResponse.json();
const storeId = storesData?.stores?.[0]?.id;

if (!storeId) throw new Error("Nenhuma loja encontrada para essa API key.");

const paymentsResponse = await fetch(`${API_BASE}/stores/${storeId}/payments`, {
	headers: { Authorization: AUTHORIZATION }
});
const paymentsData = await paymentsResponse.json();
const paymentId = paymentsData?.payments?.find((p) => p?.status === "EXPIRED")?.id;

if (!paymentId) {
	throw new Error("Nenhum pagamento EXPIRED encontrado para excluir.");
}

const response = await fetch(`${API_BASE}/stores/${storeId}/payments/${paymentId}`, {
	method: "DELETE",
	headers: { Authorization: AUTHORIZATION }
});

const data = await response.json();
console.log({ status: response.status, data });

📦 Resposta de sucesso (200)

{
	"status": true,
	"code": "PAYMENT_DELETED",
	"message": "Pagamento deletado com sucesso"
}

⚠️ Possíveis erros

  • 400 INVALID_DATA → parâmetros inválidos
  • 404 STORE_NOT_FOUND → loja não encontrada
  • 404 PAYMENT_NOT_FOUND → pagamento não encontrado
  • 403 DELETE_NOT_ALLOWED → apenas pagamentos com status EXPIRED podem ser removidos
  • 500 INTERNAL_SERVER_ERROR → erro interno