---
title: "Payment free"
method: POST
path: "PAYMENT_FREE"
tags: ["Webhooks"]
---

# Payment free

`POST PAYMENT_FREE` (webhook)

A coupon discounted the whole amount of the payment and the order completed without a charge. A free order never sends `PAYMENT_PAID`.

Opt-in: delivered only to endpoints that selected this event, never to the others, and never for sandbox payments. A resend from the dashboard or by support repeats the exact body of the original delivery.

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.

## Payload

- object
  - `id` string, uuid, required: Payment id.
  - `txId` string, required: Payment transaction id.
  - `status` 'FREE', required: Always `FREE`.
  - `amount` 0, required: Always `0`.
  - `paidAt` string, date-time, required: When the order completed. `GET /v1/payments/{paymentId}` returns this time as `completedAt`, with `paidAt: null`.
  - `endToEndId` unknown, required
  - `payer` WebhookPayerBlock, required: Payer block. `null` when every field would be null.
    - `name` string, nullable: Payer name as reported by the settling institution.
    - `document` string, nullable: Payer CPF or CNPJ, as digits, or a masked string (for example `***405566**`) when no full document is on file. `null` when neither was captured. Match on `*` before parsing the value as a CPF or CNPJ.
    - `documentType` string, nullable: `CPF` or `CNPJ`.
    - `institutionName` string, nullable: Payer institution name.
    - `institutionIspb` string, nullable: Payer institution ISPB code.

## 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.dev/yuvexpay/apis/yuvexpay-api/revisions/a5e417a542bc?raw)