创建 PIX 代付

创建 PIX 代付订单。

接口

POST /cashout/pix/create

认证

Merchant Credential。详见 认证。

重要说明

警告

注意：如果接口响应超时或者响应了非200的HTTP状态码，请务必通过Check Pix Out接口查询订单状态

请求头

名称	位置	类型	必填	说明	示例
Content-Type	header	string	是		application/json
X-Nonce	header	string	是		a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Id	header	string	是		2492265300
X-Timestamp	header	string	是		1638123456
Digest	header	string	是		SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
Authorization	header	string	是		Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

请求体

字段	类型	必填	说明
amount	number	是	金额 — 支持小数点后两位 (min=10; max=50000)
mchOrderNo	string	是	商户订单号 — 商户订单号，支持A-Za-z0-9|_|- (maxLength=32; pattern=^[A-Za-z0-9|_|-]{1-32})
document	string	否	税号，个人主体为CPF，公司主体为CNPJ — 该字段必须真实有效
key	string	是	账号 — 不同pixKey，格式不一样 CPF：^\d{11}$ CNPJ：^\d{14}$ EVP：[1]{8}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{12}$ PHONE：^+55\d{11}$ EMAIL：[2]+@[A-Za-z0-9-]+(?:.[A-Za-z0-9-]+)+$

请求示例

{
  "mchOrderNo": "payout_16622125006",
  "key": "test@gmail.com",
  "amount": 180.5,
  "document": "45920019932"
}

响应

HTTP 200 — 成功

字段	类型	必填	说明
status	integer	是	状态 — 200成功
msg	string|null	是	信息
data	object	是

data 字段

字段	类型	必填	说明
applyTime	integer	是	申请时间
amount	number	是	订单金额
platOrderNo	string	是	平台订单号
mchOrderNo	string	是	商户订单号
orderStatus	string	是	订单状态 (enum=SUCCESS, FAILED, PENDING, REFUND)
receivedAmount	number	是	到账金额

响应示例

{
  "status": 200,
  "msg": null,
  "data": {
    "mchOrderNo": "payout_1662104438",
    "platOrderNo": "wussXUCOoXO3yptr7rQV",
    "applyTime": 1662104742,
    "amount": 180.34,
    "receivedAmount": 0,
    "orderStatus": "PENDING"
  }
}

---

1. 0-9 a-z ↩︎

2. A-Za-z0-9.!#$%&'*+/=?^_`{|}~- ↩︎