---
title: "Payment paid"
method: POST
path: "PAYMENT_PAID"
tags: ["Webhooks"]
---

# Payment paid

`POST PAYMENT_PAID` (webhook)

Funds were received and the net amount was credited to your balance.

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.
  - `txId` string — Payment transaction id.
  - `status` 'PAID' — Always `PAID`.
  - `amount` number — Gross amount in BRL.
  - `paidAt` string, date-time, nullable — Settlement timestamp. `null` when not recorded.
  - `endToEndId` string, nullable — PIX end-to-end identifier, safe for bank reconciliation. `null` when the network did not supply one.
  - `payer` WebhookPayerBlock — 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 the masked string the settling PIX provider reported (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-service-production.skmtc.workers.dev/v1/apis/yuvexpay/yuvexpay-api/revisions/746526879975/schema)