Query Exchange Status

Query exchange order status by merchant order number.

Endpoint

GET /cashout/exchange/check

Authentication

Merchant Credential. See Authentication.

Important Notes

WARNING

If the request times out or orderStatus is unavailable, do not infer any order status

Request headers

Name	In	Type	Required	Description	Example
X-Nonce	header	string	Yes		a9f3c1d47e8b9a2c4d1f9e8a7b6c5d4e
X-Merchant-Id	header	string	Yes		2492265300
X-Timestamp	header	string	Yes		1638123456
Digest	header	string	Yes		SHA-256=Jr9cX0nM6yT7uF9GQ5G8ZC5M8vRZrQZP9+VbQ8Z8z0Q=
Authorization	header	string	Yes		Signature keyId="m123456",alg="ES256",headers="(request-target) x-timestamp x-nonce digest",signature="MEUCIQD8VxkzR7q5hF3k9dY0v6mKk7K0Nq9nYw+7Ck8LJr9mYAIgC5VQ7J0Z9YqL5F8Wc6E2Yw5qf1z8bYyYcR9kX8pY="

Query parameters

Name	In	Type	Required	Description	Example
mchOrderNo	query	string	No	Merchant order number	order_{{$date.timestamp}}

Response

HTTP 200 — Success

Field	Type	Required	Description
status	integer	Yes	Status
msg	null	Yes	Message
data	object	Yes

data fields

Field	Type	Required	Description
mchOrderNo	string	Yes	Merchant order number
platOrderNo	string	Yes	Platform order number
price	number	No	Exchange rate
pair	string	No
orderStatus	string	Yes	Order status (enum=SUCCESS, FAILED, PENDING, REFUND)
amount	number	Yes	Order amount
receivedAmount	number	No	Amount credited
fee	number	Yes	Fee
toPix	string	Yes
toIspb	string	Yes
toName	string	Yes
fromBank	string	Yes
fromCnpj	string	Yes
fromName	string	Yes
toCpfCnpj	string	Yes
ispbName	string	Yes
payTime	integer	Yes	Payment timestamp
errMsg	string	Yes	Details — Returned on error
e2eId	string	Yes	Bank ledger — Returned on success