---
title: "Payment cancelled"
method: POST
path: "PAYMENT_CANCELLED"
tags: ["Webhooks"]
---

# Payment cancelled

`POST PAYMENT_CANCELLED` (webhook)

The payment was cancelled or definitively failed before completing.

The HTTP body is this object exactly — there is no envelope and no `type` field. The event name is delivered in the `X-Webhook-Event` header. Most optional fields arrive as an explicit `null`; a few keys are dropped from the JSON entirely when unset, and those are marked as such below. Read values with a null-safe accessor rather than testing key presence.

## Payload

- object
  - `id` string, uuid — Payment id. Present only on some cancellation paths.
  - `txId` string — Payment transaction id.
  - `status` 'CANCELLED' — Always `CANCELLED`.
  - `amount` number — Gross amount in BRL. Present only on some cancellation paths.
  - `reason` string — Provider-supplied reason, when available.

## Acknowledgement `200`

Return a 2xx status to acknowledge receipt.

---

[API](https://skmtc.dev/yuvexpay/apis/yuvexpay-api.md) · [All operations](https://skmtc.dev/yuvexpay/apis/yuvexpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/yuvexpay/yuvexpay-api/revisions/9d4ba1cc037c/schema)