收款（Pay-In · 巴西）

巴西地区 收款（Pay-in） 接口（BRL）。详见 支付方式。

Request

POST/v2.0/transaction/pay-in

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/transaction/pay-in
production: https://gateway.smilepayz.com/v2.0/transaction/pay-in

Header Parameters

Field	Required	Type	Description
Content-Type	M	String	application/json 请求体。
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. Brazil BRT −03:00).
X-SIGNATURE	M	String	请求体签名（见产品文档 签名生成）。
X-PARTNER-ID	M	String	Your merchantID

Body Parameters

Field	Required	Type	Description
orderNo	M	String(32)	商户唯一订单号
purpose	M	String(64)	展示用摘要
merchant	M	Object	含 merchantId 及可选子商户字段。
merchantId	M	String	Smilepayz merchantId。
merchantName	O	String	商户展示名。
subMerchantId	O	String	可选子商户编号。
subMerchantName	O	String	subMerchantId 的名称。
money	M	Object	currency 与 amount 金额对象。
currency	M	String	本笔币种代码。
amount	M	Number	金额
payer	O	Object	pixType、pixAccount。推荐。
pixType	O	String	推荐。CPF 或 CNPJ；
pixAccount	O	String	推荐。纯数字 11/14 位。
paymentMethod	M	String	通道编码（见 支付方式 文档）。
expiryPeriod	O	Number	ExpiryPeriod，默认 3600。
redirectUrl	O	String(256)	支付后 HTTPS 回跳，最长 256。
callbackUrl	O	String(256)	异步通知 HTTPS，最长 256。

---

Example Body – Transaction Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-03:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

{
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "purpose": "Online order — São Paulo",
    "merchant": {
        "merchantId": "20011"
    },
    "money": {
        "currency": "BRL",
        "amount": 5000
    },
    "payer": {
        "pixType": "CPF",
        "pixAccount": "12345678901"
    },
    "paymentMethod": "PIX",
    "redirectUrl": "https://www.google.com/webhp"
}

Responses

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json 响应或回调体。
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

Field	Required	Type	Description
code	M	String	00 成功，其余失败。
message	M	String	UTF-8 结果说明。
orderNo	M	String	商户唯一订单号
tradeNo	O	String	平台 tradeNo。
merchant	M	Object	含 merchantId 及可选子商户字段。
merchantId	M	String	Smilepayz merchantId。
merchantName	O	String	商户展示名。
subMerchantId	O	String	可选子商户编号。
subMerchantName	O	String	subMerchantId 的名称。
accountNo	O	String	结算 accountNo（若返回）。
money	M	Object	currency 与 amount 金额对象。
currency	M	String	本笔币种代码。
amount	M	Number	金额
transactionTime	M	String	yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. BRT −03:00).
channel	M	Object	通道数据（paymentUrl、qrString 等）。
paymentMethod	M	String	Code（见 支付方式 文档）。
paymentUrl	M	String	收银台跳转 URL。
qrString	O	String	通道返回的复制串（若有）。
status	O	String	订单或支付状态枚举值。

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-03:00

{
    "code": "00",
    "message": "Successful",
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "tradeNo": "131200112412130836186234",
    "merchant": {
        "merchantId": "20011",
        "merchantName": "Smilepayz Demo Store",
        "accountNo": "11320011202402290943"
    },
    "money": {
        "currency": "BRL",
        "amount": 5000
    },
    "transactionTime": "2024-12-12T23:36:19-03:00",
    "channel": {
        "paymentMethod": "PIX",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=131200112412130836186234",
        "qrString": "00020101021226800014br.gov.bcb.pix2558pix.delbank.com.br/v2/cob/vcharge1f6aed0623644c24bbdc174ce5204000053039865802BR5907DELBANK6007ARACAJU62070503***6304BC39"
    },
    "status": "PROCESSING"
}

{
    "code": "00",
    "message": "Successful",
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "tradeNo": "131200112412130836186234",
    "merchant": {
        "merchantId": "20011",
        "merchantName": "Smilepayz Demo Store",
        "accountNo": "11320011202402290943"
    },
    "money": {
        "currency": "BRL",
        "amount": 5000
    },
    "transactionTime": "2024-12-12T23:36:19-03:00",
    "channel": {
        "paymentMethod": "PIX",
        "paymentUrl": "https://gateway.smilepayz.com/cashier/#/loading?tradeNo=131200112412130836186234",
        "qrString": ""
    },
    "status": "PROCESSING"
}

Notification/Callback

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json 响应或回调体。
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	回调体签名（见 回调验签 文档）。

Body Parameters

Field	Required	Type	Description
orderNo	M	String	商户唯一订单号
tradeNo	M	String	平台 tradeNo。
merchantId	M	String	Smilepayz merchantId。
merchantName	M	String	商户展示名。
subMerchantId	O	String	可选子商户编号。
subMerchantName	O	String	subMerchantId 的名称。
paymentMethod	M	String	通道编码（见 支付方式 文档）。
transactionTime	M	String	Format: yyyy-MM-ddTHH:mm:ss
status	M	String	订单或支付状态枚举值。
money	M	Object	currency 与 amount 金额对象。
currency	M	String	本笔币种代码。
amount	M	Number	金额

Return

Important

Respond with the string SUCCESS only.

{
    "orderNo": "20011db2773a6fb2542dfa5cb34c",
    "tradeNo": "131200112412130836186234",
    "merchantId": "20011",
    "merchantName": "Smilepayz Demo Store",
    "subMerchantId": "",
    "subMerchantName": "",
    "paymentMethod": "PIX",
    "transactionTime": "2024-12-12T23:36:19-03:00",
    "status": "SUCCESS",
    "money": {
        "currency": "BRL",
        "amount": 5000
    }
}

SUCCESS