发送 PIX 付款(Cash-Out)
向 PIX 密钥发送 PIX 付款。
需要在 Authorization 头中提供 Bearer 令牌。
| 字段 | 类型 | 必填 | 描述 |
|---|
value | number | 是 | 交易金额(巴西雷亚尔,最多 2 位小数) |
externalId | string | 是 | 交易的唯一外部标识符 |
description | string | 否 | 可选的交易描述 |
details | object | 是 | 目标 PIX 密钥信息 |
details.key | string | 是 | 目标 PIX 密钥 |
details.keyType | string | 是 | PIX 密钥类型:EMAIL、PHONE、DOCUMENT、RANDOM |
details.name | string | 是 | PIX 密钥持有人姓名 |
details.document | string | 是 | 持有人证件(CPF 或 CNPJ,仅数字) |
{
"value": 15.50,
"externalId": "external-teste-001",
"description": "Pagamento fornecedor XYZ",
"details": {
"key": "12312312387",
"keyType": "DOCUMENT",
"name": "John Marvin",
"document": "12312312387"
}
}
| 字段 | 类型 | 描述 |
|---|
transactionId | string | 生成的交易内部标识符 |
externalId | string | 请求中提供的外部标识符 |
status | string | 当前交易状态(PENDING、CONFIRMED、ERROR) |
generateTime | string | 交易生成日期/时间(ISO 8601) |
{
"transactionId": "456",
"externalId": "external-teste-001",
"status": "PENDING",
"generateTime": "2024-01-15T10:30:00.000Z"
}
| 状态码 | 描述 |
|---|
| 400 | 数据无效或余额不足 |
| 401 | 令牌缺失或无效 |
| 500 | 处理 PIX 付款时出错 |