# API 端点 (/zh/docs/conta-digital/endpoints)

<QuickLinks>
  <QuickLink href="/docs/conta-digital/getting-started" title="快速开始" />

  <QuickLink href="/docs/conta-digital/authentication" title="身份认证" />

  <QuickLink href="/docs/conta-digital/webhooks" title="Webhooks" />

  <QuickLink href="/docs/conta-digital/error-codes" title="错误代码" />
</QuickLinks>

Base URL：`https://api.hub.payzu.com.br/api/v1`。`GET /status` 无需凭证；其他路由使用凭证，见[身份认证](/docs/conta-digital/authentication)。每个路由都会注明所需的作用域。

## 典型集成流程 [#典型集成流程]

<Mermaid
  chart="`
flowchart LR
  A[&#x22;POST /oauth/token&#x22;] --> B[&#x22;POST /transactions/payment&#x22;]
  B --> C[&#x22;Webhook PAYMENT_PAID&#x22;]
  C --> D[&#x22;GET /transactions/payment/{paymentId}&#x22;]
  D --> E[&#x22;POST /transactions/withdraw&#x22;]

  click A &#x22;/docs/conta-digital/endpoints/authentication/post_oauth_token&#x22; &#x22;获取访问令牌&#x22;
  click B &#x22;/docs/conta-digital/endpoints/charges/post_payment&#x22; &#x22;创建 Pix 收款&#x22;
  click C &#x22;/docs/conta-digital/webhooks&#x22; &#x22;Webhooks&#x22;
  click D &#x22;/docs/conta-digital/endpoints/charges/get_payment&#x22; &#x22;查询收款&#x22;
  click E &#x22;/docs/conta-digital/endpoints/withdrawals/post_withdraw&#x22; &#x22;提现到 Pix 密钥&#x22;

  style B fill:#14ce71,stroke:#0eb464,color:#ffffff
`"
/>

## 身份认证 [#身份认证]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/authentication/post_oauth_token" title="获取访问令牌" method="POST" path="/oauth/token" />
</QuickLinks>

## 收款 [#收款]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/charges/post_payment" title="创建 Pix 收款" method="POST" path="/transactions/payment" />

  <QuickLink href="/docs/conta-digital/endpoints/charges/get_payments" title="列出收款" method="GET" path="/transactions/payment" />

  <QuickLink href="/docs/conta-digital/endpoints/charges/get_payment" title="查询收款" method="GET" path="/transactions/payment/{paymentId}" />

  <QuickLink href="/docs/conta-digital/endpoints/charges/get_payment_receipt" title="收款凭证" method="GET" path="/transactions/payment/{paymentId}/receipt" />

  <QuickLink href="/docs/conta-digital/endpoints/charges/post_payment_refund" title="退款" method="POST" path="/transactions/payment/{paymentId}/refund" />
</QuickLinks>

## 提现 [#提现]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/withdrawals/post_withdraw" title="提现到 Pix 密钥" method="POST" path="/transactions/withdraw" />

  <QuickLink href="/docs/conta-digital/endpoints/withdrawals/get_withdraws" title="列出提现" method="GET" path="/transactions/withdraw" />

  <QuickLink href="/docs/conta-digital/endpoints/withdrawals/get_withdraw" title="查询提现" method="GET" path="/transactions/withdraw/{withdrawId}" />

  <QuickLink href="/docs/conta-digital/endpoints/withdrawals/get_withdraw_receipt" title="提现凭证" method="GET" path="/transactions/withdraw/{withdrawId}/receipt" />
</QuickLinks>

## Pix 复制粘贴码与收款方 [#pix-复制粘贴码与收款方]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/pix/post_pix_decode" title="解析 Pix 复制粘贴码" method="POST" path="/transactions/pix/decode" />

  <QuickLink href="/docs/conta-digital/endpoints/pix/post_pix_destination" title="查询收款方" method="POST" path="/transactions/pix/destination" />

  <QuickLink href="/docs/conta-digital/endpoints/pix/post_pix_qr_payment" title="支付 Pix 复制粘贴码" method="POST" path="/transactions/pix/qr-payments" />
</QuickLinks>

## Pix 密钥 [#pix-密钥]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/pix-keys/get_pix_keys" title="列出 Pix 密钥" method="GET" path="/transactions/pix-keys" />

  <QuickLink href="/docs/conta-digital/endpoints/pix-keys/post_pix_key" title="创建 Pix 密钥" method="POST" path="/transactions/pix-keys" />

  <QuickLink href="/docs/conta-digital/endpoints/pix-keys/put_pix_key_default" title="设置默认密钥" method="PUT" path="/transactions/pix-keys/{pixKeyId}/default" />

  <QuickLink href="/docs/conta-digital/endpoints/pix-keys/delete_pix_key" title="删除 Pix 密钥" method="DELETE" path="/transactions/pix-keys/{pixKeyId}" />
</QuickLinks>

## 账户间转账 [#账户间转账]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/internal-transfers/post_internal_transfer" title="转账到另一个 PayZu 账户" method="POST" path="/transactions/internal-transfer" />

  <QuickLink href="/docs/conta-digital/endpoints/internal-transfers/get_internal_transfers" title="列出转账" method="GET" path="/transactions/internal-transfer" />

  <QuickLink href="/docs/conta-digital/endpoints/internal-transfers/get_internal_transfer" title="查询转账" method="GET" path="/transactions/internal-transfer/{transferId}" />

  <QuickLink href="/docs/conta-digital/endpoints/internal-transfers/get_internal_transfer_receipt" title="转账凭证" method="GET" path="/transactions/internal-transfer/{transferId}/receipt" />
</QuickLinks>

## 存款 [#存款]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/deposits/get_deposit" title="查询存款" method="GET" path="/transactions/deposit/{depositId}" />

  <QuickLink href="/docs/conta-digital/endpoints/deposits/get_deposit_receipt" title="存款凭证" method="GET" path="/transactions/deposit/{depositId}/receipt" />

  <QuickLink href="/docs/conta-digital/endpoints/deposits/post_deposit_refund" title="退回存款" method="POST" path="/transactions/deposit/{depositId}/refund" />
</QuickLinks>

## 余额、账单与限额 [#余额账单与限额]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/account/get_balance" title="查询余额" method="GET" path="/transactions/balance" />

  <QuickLink href="/docs/conta-digital/endpoints/account/get_statement" title="查询账单" method="GET" path="/transactions/statement" />

  <QuickLink href="/docs/conta-digital/endpoints/account/get_limits" title="查询限额和费用" method="GET" path="/transactions/limits" />

  <QuickLink href="/docs/conta-digital/endpoints/account/get_metrics" title="查询指标" method="GET" path="/transactions/metrics" />
</QuickLinks>

## MED 争议 [#med-争议]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/infractions/get_infractions" title="列出 MED 争议" method="GET" path="/transactions/infractions" />

  <QuickLink href="/docs/conta-digital/endpoints/infractions/get_infraction" title="查询 MED 争议" method="GET" path="/transactions/infractions/{protocol}" />
</QuickLinks>

## Webhooks [#webhooks]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/webhooks/get_webhooks" title="列出 webhook 端点" method="GET" path="/transactions/webhooks" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/post_webhook" title="注册 webhook 端点" method="POST" path="/transactions/webhooks" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/put_webhook" title="修改 webhook 端点" method="PUT" path="/transactions/webhooks/{webhookId}" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/delete_webhook" title="删除 webhook 端点" method="DELETE" path="/transactions/webhooks/{webhookId}" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/get_callback_secret" title="查询回调密钥" method="GET" path="/transactions/callback-secret" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/post_callback_secret" title="签发回调密钥" method="POST" path="/transactions/callback-secret" />

  <QuickLink href="/docs/conta-digital/endpoints/webhooks/post_callback_secret_rotate" title="轮换回调密钥" method="POST" path="/transactions/callback-secret/rotate" />
</QuickLinks>

## 状态 [#状态]

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/status/get_status" title="服务健康状态" method="GET" path="/status" />
</QuickLinks>

## Webhook 事件 [#webhook-事件]

每个事件中发送到你端点的内容。签名校验方法和重试时机见 [Webhooks](/docs/conta-digital/webhooks)。

<QuickLinks>
  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_payment_created" title="PAYMENT_CREATED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_payment_paid" title="PAYMENT_PAID" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_payment_refunded" title="PAYMENT_REFUNDED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_payment_expired" title="PAYMENT_EXPIRED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_withdraw_created" title="WITHDRAW_CREATED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_withdraw_completed" title="WITHDRAW_COMPLETED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_withdraw_failed" title="WITHDRAW_FAILED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_refund_completed" title="REFUND_COMPLETED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_refund_failed" title="REFUND_FAILED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_deposit_received" title="DEPOSIT_RECEIVED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_internal_transfer_sent" title="INTERNAL_TRANSFER_SENT" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_internal_transfer_received" title="INTERNAL_TRANSFER_RECEIVED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_withdraw_refund_received" title="WITHDRAW_REFUND_RECEIVED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_infraction_opened" title="INFRACTION_OPENED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_infraction_closed" title="INFRACTION_CLOSED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_infraction_deadline" title="INFRACTION_DEADLINE" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_account_blocked" title="ACCOUNT_BLOCKED" />

  <QuickLink href="/docs/conta-digital/endpoints/webhook-events/webhook_account_unblocked" title="ACCOUNT_UNBLOCKED" />
</QuickLinks>