生成 PIX 收款（Cash-In）
生成动态二维码，用于通过 PIX 接收付款。
需要在 Authorization 头中提供 Bearer 令牌。
| 字段 | 类型 | 必填 | 描述 |
|---|
transaction | object | 是 | 交易数据 |
transaction.value | number | 是 | 金额（巴西雷亚尔，最多 2 位小数） |
transaction.description | string | 是 | 交易描述 |
transaction.externalId | string | 是 | 外部交易 ID（唯一标识符） |
transaction.expirationTime | number | 否 | 过期时间（秒），最短 5 分钟，最长 7 天。默认值：86400 |
transaction.generateQrCode | boolean | 否 | 如果为 true，以 Base64 格式返回二维码。默认值：false |
payer | object | 是 | 付款人数据 |
payer.fullName | string | 是 | 付款人全名 |
payer.document | string | 是 | 付款人 CPF 或 CNPJ（仅数字） |
additionalInfo | object | 否 | 附加信息（string:string 键值对，最多 10 个键） |
{
"transaction": {
"value": 0.05,
"description": "Cobrança de teste",
"externalId": "external-teste-01",
"expirationTime": 86400,
"generateQrCode": true
},
"payer": {
"fullName": "John Marvin",
"document": "12312312387"
},
"additionalInfo": {
"orderId": "ORD-12345"
}
}
| 字段 | 类型 | 描述 |
|---|
transactionId | string | 生成的交易唯一标识符 |
correlationId | string | 交易关联 ID（UUID） |
externalId | string | 外部交易 ID（与输入值相同） |
status | string | 交易状态（PENDING、CONFIRMED、ERROR） |
pixCode | string | 标准 EMV 格式的 PIX 代码 |
generateTime | string | PIX 生成日期和时间（ISO 8601） |
expirationDate | string | PIX 过期日期和时间（ISO 8601） |
qrCodeImage | string | Base64 格式的二维码（仅当 generateQrCode=true 时返回） |
{
"transactionId": "123",
"correlationId": "550e8400-e29b-41d4-a716-446655440000",
"externalId": "external-teste-01",
"status": "PENDING",
"pixCode": "00020126580014br.gov.bcb.pix...",
"generateTime": "2024-01-15T10:30:00.000Z",
"expirationDate": "2024-01-16T10:30:00.000Z",
"qrCodeImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
}
| 状态码 | 描述 |
|---|
| 400 | 数据无效 |
| 401 | 令牌缺失或无效 |
| 500 | 生成 PIX 收款时出错 |
