Safira Paydocs

发送 PIX 付款(Cash-Out)

POST /api/pix/cash-out

向 PIX 密钥发送 PIX 付款。

认证

需要在 Authorization 头中提供 Bearer 令牌。

请求体

字段类型必填描述
valuenumber交易金额(巴西雷亚尔,最多 2 位小数)
externalIdstring交易的唯一外部标识符
descriptionstring可选的交易描述
detailsobject目标 PIX 密钥信息
details.keystring目标 PIX 密钥
details.keyTypestringPIX 密钥类型:EMAILPHONEDOCUMENTRANDOM
details.namestringPIX 密钥持有人姓名
details.documentstring持有人证件(CPF 或 CNPJ,仅数字)
{
  "value": 15.50,
  "externalId": "external-teste-001",
  "description": "Pagamento fornecedor XYZ",
  "details": {
    "key": "12312312387",
    "keyType": "DOCUMENT",
    "name": "John Marvin",
    "document": "12312312387"
  }
}

响应 (201)

字段类型描述
transactionIdstring生成的交易内部标识符
externalIdstring请求中提供的外部标识符
statusstring当前交易状态(PENDINGCONFIRMEDERROR
generateTimestring交易生成日期/时间(ISO 8601)
{
  "transactionId": "456",
  "externalId": "external-teste-001",
  "status": "PENDING",
  "generateTime": "2024-01-15T10:30:00.000Z"
}

错误

状态码描述
400数据无效或余额不足
401令牌缺失或无效
500处理 PIX 付款时出错

本页目录