交易状态查询（巴西）

在巴西（BRL）查询收款/代付状态，请传 orderNo 和/或 tradeNo。

Request

POST/v2.0/inquiry-status

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/inquiry-status
production: https://gateway.smilepayz.com/v2.0/inquiry-status

Header Parameters

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	Request signature; Signature Generation.
X-PARTNER-ID	M	String	merchantID (alphanumeric).

Body Parameters

Field	Required	Type	Description
tradeType	M	Number	1 = Pay-in, 2 = Pay-out.
orderNo	C	String(32)	Merchant order id (use when no tradeNo).
tradeNo	C	String(32)	Platform trade id (use when no orderNo).

条件

须至少提供 tradeNo 或 orderNo 之一。

---

Example Body – Inquiry Status Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00-03:00
X-SIGNATURE: 85be817c55b2c135157c7e89f52499bf0c25ad6eeebe04a986e8c862561b19a5
X-PARTNER-ID: 20001

{
    "tradeType": 1,
    "orderNo": "2000112900000000000001"
}

{
    "tradeType": 2,
    "tradeNo": "122200312406111311517153"
}

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 = success; other codes = error.
message	M	String	Result text (UTF-8).
tradeNo	O	String	Platform trade id.
tradeType	O	Number	1 Pay-in / 2 Pay-out.
paymentMethod	O	String	Channel code (PIX, CPF, …); see Payment methods.
money	O	Object	Money Model.
currency	M	String	BRL.
amount	M	Number	Integer centavos (e.g. 20000 = BRL 200.00).
status	O	String	Transaction Status.
remark	O	String	Extra notes when present.

Example Body – Inquiry Status Response:

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

{
    "code": "00",
    "message": "Successful",
    "money": {
        "amount": 20000,
        "currency": "BRL"
    },
    "paymentMethod": "CPF",
    "status": "SUCCESS",
    "tradeNo": "122200312406111311517153",
    "tradeType": 2
}