# 快速开始 (/zh/docs/pix-processamento/getting-started)

<PixSeal />

<QuickLinks>
  <QuickLink href="/docs/pix-processamento/endpoints" title="API 参考" />

  <QuickLink href="/docs/pix-processamento/glossary" title="术语表" />

  <QuickLink href="/docs/pix-processamento/concepts" title="概念" />

  <QuickLink href="/docs/pix-processamento/authentication" title="认证" />

  <QuickLink href="/docs/pix-processamento/webhooks" title="Webhooks" />

  <QuickLink href="/docs/pix-processamento/med" title="MED" />
</QuickLinks>

<Mermaid
  chart="`
flowchart LR
  A[&#x22;开户&#x22;] --> B[&#x22;测试 token&#x22;]
  B --> C[&#x22;创建收款&#x22;]
  C --> D[&#x22;接收 callback&#x22;]

  click A &#x22;https://abrirconta.payzu.com.br&#x22; &#x22;开通 PayZu 账户&#x22;
  click B &#x22;/zh/docs/pix-processamento/endpoints/account/get_user_balance&#x22; &#x22;GET /user/balance&#x22;
  click C &#x22;/zh/docs/pix-processamento/endpoints/pix-operations/post_pix&#x22; &#x22;POST /pix&#x22;
  click D &#x22;/zh/docs/pix-processamento/webhooks&#x22; &#x22;Webhooks&#x22;

  style A fill:#f59e0b,stroke:#d97706,color:#ffffff
  style D fill:#14ce71,stroke:#0eb464,color:#ffffff
`"
/>

<Steps>
  <Step>
    ### 开户 [#开户]

    在 [abrirconta.payzu.com.br](https://abrirconta.payzu.com.br) 开通账户。审核通过后您将获得：

    * **Bearer token**，用于所有请求。详见 [认证](/docs/pix-processamento/authentication)。
    * **Base URL**：`https://api.payzu.processamento.com/v1`。

    <Callout type="warn">
      请将 token 保存在密钥库中（Google Secret Manager、AWS Secrets 等）。
      切勿提交到代码仓库，也不要暴露在前端。
    </Callout>
  </Step>

  <Step>
    ### 测试认证 [#测试认证]

    为确认 token 有效，请使用 [`GET /user/balance`](/docs/pix-processamento/endpoints/account/get_user_balance) endpoint 查询账户余额。

    <Tabs items="['curl', 'Node']">
      <Tab value="curl">
        ```bash
        curl https://api.payzu.processamento.com/v1/user/balance \
          -H "Authorization: Bearer SEU_TOKEN" \
          -H "Content-Type: application/json"
        ```
      </Tab>

      <Tab value="Node">
        ```js
        const res = await fetch('https://api.payzu.processamento.com/v1/user/balance', {
          headers: {
            Authorization: `Bearer ${process.env.PAYZU_TOKEN}`,
            'Content-Type': 'application/json',
          },
        });
        const balance = await res.json();
        ```
      </Tab>
    </Tabs>

    如果返回包含余额的 JSON，说明认证成功。如果返回 `401`，请检查 token（空格、编码）或联系支持。详见 [术语表中的 HTTP 状态码](/docs/pix-processamento/glossary#códigos-http)。
  </Step>

  <Step>
    ### 创建首笔 Pix 收款 [#创建首笔-pix-收款]

    通过 [`POST /pix`](/docs/pix-processamento/endpoints/pix-operations/post_pix) 创建收款。完整 schema 参见 API 参考。

    <Tabs items="['curl', 'Node']">
      <Tab value="curl">
        ```bash
        curl -X POST https://api.payzu.processamento.com/v1/pix \
          -H "Authorization: Bearer SEU_TOKEN" \
          -H "Content-Type: application/json" \
          -d '{
            "amount": 10.90,
            "generatedName": "João da Silva",
            "generatedDocument": "12345678909",
            "callbackUrl": "https://seusite.com.br/webhooks/payzu",
            "clientReference": "pedido-2025-001"
          }'
        ```
      </Tab>

      <Tab value="Node">
        使用官方 [`payzu-pix`](/docs/pix-processamento/sdks) SDK：

        示例使用 ESM 和顶层 `await`。请保存为 `.mjs` 文件(或在 `package.json` 中设置 `"type": "module"`)。

        ```bash
        npm install payzu-pix
        ```

        ```js
        import { PayZu } from 'payzu-pix';

        const payzu = new PayZu({ token: process.env.PAYZU_TOKEN });

        const charge = await payzu.pix.create({
          amount: 10.90,
          generatedName: 'João da Silva',
          generatedDocument: '12345678909',
          callbackUrl: 'https://seusite.com.br/webhooks/payzu',
          clientReference: 'pedido-2025-001',
        });

        console.log(charge.id, charge.status, charge.qrCodeText);
        ```
      </Tab>
    </Tabs>

    响应返回 `qrCodeText`（copia-e-cola）、`qrCodeUrl` 以及交易的 `id`。各字段在 [术语表](/docs/pix-processamento/glossary#common-api-fields) 中均有说明。

    <Callout type="info">
      金额始终以\*\*雷亚尔（BRL）\*\*为单位。`10.90` 表示 R$ 10,90。
    </Callout>
  </Step>

  <Step>
    ### 接收 callback [#接收-callback]

    当付款方完成 Pix 支付后，PayZu 会向您提供的 `callbackUrl` 发送 `POST` 请求，携带更新后的交易对象（`status: "COMPLETED"`）。请在 5 秒内返回 `2xx` 响应。

    ```http
    POST /webhooks/payzu
    Content-Type: application/json

    {
      "id": "PAYZU20260811K7M2X9QP4T000000",
      "status": "COMPLETED",
      "amount": 10.90,
      "clientReference": "pedido-2025-001",
      "endToEndId": "E18236120202608111046s1235ee7a91",
      "paidAt": "2026-08-11T10:46:26.986Z"
    }
    ```

    重试、完整 payload 和安全性详情请参见 [Webhooks](/docs/pix-processamento/webhooks)。如需手动检查或重发，请使用 [`GET /user/callbacks`](/docs/pix-processamento/endpoints/callbacks/get_user_callbacks)。
  </Step>
</Steps>

## 下一步 [#下一步]

<QuickLinks>
  <QuickLink href="/docs/pix-processamento/tutoriais/receive-pix" title="教程 · 接收 Pix" />

  <QuickLink href="/docs/pix-processamento/webhooks" title="Webhooks" />

  <QuickLink href="/docs/pix-processamento/best-practices" title="最佳实践" />

  <QuickLink href="/docs/pix-processamento/endpoints" title="API 参考" />
</QuickLinks>