Skip to content

创建换汇代付

创建换汇代付订单。

接口

POST /cashout/exchange/pay-for-pix-key

认证

Merchant Credential。详见 认证

重要说明

警告

注意:如果接口响应超时或者响应了非200的HTTP状态码,请务必通过Check Exchange Cashout接口查询订单状态

请求头

名称位置类型必填说明示例
Content-Typeheaderstringapplication/json
X-Nonceheaderstringa9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Idheaderstring2492265300
X-Timestampheaderstring1638123456
DigestheaderstringSHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
AuthorizationheaderstringSignature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

请求体

字段类型必填说明
amountnumber金额 — 支持小数点后两位 (min=10; max=50000)
mchOrderNostring商户订单号 — 商户订单号,支持A-Za-z0-9|_|- (maxLength=32; pattern=^[A-Za-z0-9|_|-]{1-32})
keystring账号 — 不同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-]+)+$
confirmAmtnumber确认兑换数量
settlementstring结算周期
pairstring配对类型
priceIdstring汇率版本ID

请求示例

json
{
  "mchOrderNo": "payout_16622125006",
  "key": "00020101021226880014br.gov.bcb.pix2566qrcodes.saq.digital/v2/qr/cob/da6433a8-1c96-49c7-a3b0-91846b2a0f375204000053039865802BR5925WR COMERCIO E INDUSTRIA D6009SAO PAULO62070503***6304F644",
  "amount": 521,
  "confirmAmt": 100,
  "settlement": "T0",
  "pair": "USDT_BRL",
  "priceId": 12
}

响应

HTTP 200 — 成功

字段类型必填说明
statusinteger
msgnull
dataobject

data 字段

字段类型必填说明
mchOrderNostring
platOrderNostring
applyTimeinteger
amountinteger
receivedAmountinteger
orderStatusstring
priceIdinteger
settlementstring
pricenumber
confirmAmtinteger
pairstring

响应示例

json
{
  "status": 200,
  "msg": null,
  "data": {
    "mchOrderNo": "payout_16622125006",
    "platOrderNo": "PO_250508VcTNg0zWbfj9H312ccFQ",
    "applyTime": 16622125006,
    "amount": 521,
    "receivedAmount": 521,
    "orderStatus": "PENDING",
    "priceId": 12,
    "settlement": "T0",
    "price": 5.21,
    "confirmAmt": 100,
    "pair": "USDT_BRL"
  }
}

  1. 0-9 a-z ↩︎

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