跳转到主要内容

创建 PIX 收款

POST/api/v1/bank/wallet/charge/pix/Bearer Token

请求头

请求头必填
AuthorizationBearer {A55_ACCESS_TOKEN}
Content-Typeapplication/json
Idempotency-Key(幂等键)UUID v4建议

请求体

字段类型必填说明
wallet_uuidstring (UUID)接收资金的钱包
merchant_idstring (UUID)商户标识符
payer_namestring付款人全名
payer_emailstring付款人电子邮箱
payer_tax_idstringCPF 或 CNPJ(例如 123.456.789-09
payer_cell_phonestring含国家代码的手机号码
amountnumber收款金额,单位为 BRL(例如 100.00
currencystring必须为 BRL
due_datestring过期日期 YYYY-MM-DD
descriptionstring显示给付款人的收款描述
webhook_urlstring覆盖默认 webhook URL
payer_addressobject账单地址(street、city、state、postal_code)

响应字段

字段类型说明
charge_uuidstring唯一收款标识符
statusstringissued——等待付款人扫描二维码
pix_payloadobjectPIX 支付数据
pix_payload.qr_code_base64stringBase64 编码的二维码 PNG 图片
pix_payload.copy_pastestringEMV 复制粘贴字符串(pix copia e cola)
pix_payload.expirationstring二维码过期时间 ISO 8601 时间戳
local_currencynumberBRL 金额
charge_payment_urlstring托管支付页面 URL
渲染二维码

解码 qr_code_base64 并将其显示为 <img> 标签:

<img src="data:image/png;base64,{qr_code_base64}" alt="PIX QR Code" width="250" />

或者,显示 copy_paste 字符串,以便付款人将其粘贴到银行应用程序中。


HTTP 状态码

状态码说明
200PIX 收款已创建——已返回二维码
400请求体无效或缺少必填字段
401Bearer Token(持有者令牌)无效或已过期
403该钱包权限不足
404钱包未找到
422验证错误(CPF 无效、货币非 BRL)
429超出速率限制
500服务器内部错误 - 请使用指数退避重试

代码示例

curl -s -X POST https://core-manager.a55.tech/api/v1/bank/wallet/charge/pix/ \
-H "Authorization: Bearer $A55_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 660e8400-e29b-41d4-a716-446655440001" \
-d '{
"wallet_uuid": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
"merchant_id": "11111111-1111-1111-1111-111111111111",
"payer_name": "王芳",
"payer_email": "wangfang@example.com",
"payer_tax_id": "111.222.333-44",
"payer_cell_phone": "+5521977777777",
"amount": 149.90,
"currency": "BRL",
"due_date": "2026-12-31",
"description": "订单 #100——PIX",
"webhook_url": "https://your-app.com/webhooks/a55",
"payer_address": {
"street": "Av. Rio Branco",
"address_number": "200",
"complement": "Sala 301",
"neighborhood": "Centro",
"city": "Rio de Janeiro",
"state": "RJ",
"postal_code": "20040-002",
"country": "BR"
}
}'

错误响应示例

{
"charge_uuid": null,
"status": "error",
"message": [
{
"code": "INVALID_TAX_ID",
"source": "validation",
"description": "payer_tax_id is not a valid CPF or CNPJ"
}
]
}