PayZuDocs

每家店铺一个账户,通过 API 操作:Pix 收款、提现、Pix 复制粘贴码付款、转账和账单。

每个凭证只操作一个账户:没有任何路由接收 accountId。要操作两个账户,请使用两个凭证。

从哪里开始

如果你想从这里开始
发起第一次调用快速开始 → 身份认证
通过 Pix 收款Pix 收款
向他人付款Pix 提现 或 支付 Pix 复制粘贴码
在店铺之间转移余额账户间转账
对账余额、账单与限额
跟踪每一次变化Webhooks
直接查看路由API 参考

约定

项目规则
Base URLhttps://api.hub.payzu.com.br/api/v1
金额整数,单位为分:1500 即 R$ 15,00。
百分比以基点表示:150 即 1.5%。
日期UTC 时间的 ISO 8601,例如 2026-10-05T14:32:05.123Z。
列表按游标分页:把响应中的 nextCursor 放入下一次调用的 cursor 参数。最后一页不返回它。
错误{ "message", "code", "details" }。按 code 处理;message 是用于展示的文本。

余额何时变化

操作余额变化的时间
收款客户付款时。会收到 PAYMENT_PAID Webhook。
提现和 Pix 复制粘贴码付款发起请求时:金额和手续费从可用余额中扣出。操作失败时退回。
账户间转账立即:响应中已带有结果。
无收款单的入账 PixPix 到账时。会收到 DEPOSIT_RECEIVED Webhook。
退款和退回存款发起请求时:金额和手续费从可用余额中扣出。退款失败时退回。

API 不涵盖的内容

  • Boleto 和银行卡。 API 不开具 boleto,也不进行银行卡收款。银行卡请见银行卡 API。
  • 答复 MED 争议。 API 显示争议;答复在控制台中进行。
  • 创建或更换凭证。 由账户持有人在控制台 hub.payzu.com.br 中完成。

帮助

本页内容