Query Payment by E2E ID

Query payment status by PIX E2E ID.

Endpoint

GET /cashin/pix/check-qrcode

Authentication

Merchant Credential. See Authentication.

Important Notes

WARNING

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

Description

• Make sure to validate payAmount

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
e2eId	query	string	Yes	Bank transaction ID	E00416968202309101937aZOHAzv6vkT

Response

HTTP 200 — Success

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

data fields

Field	Type	Required	Description
orderStatus	string	Yes	Order status (enum=PENDING, SUCCESS, FAILED, REFUND)
amount	number	Yes	Order amount
fee	number	Yes	Fee amount
mchOrderNo	string	Yes	Merchant order number
platOrderNo	string	Yes	Platform order number
payerName	string	No	Payer information — Payer name
payerDocument	string	No	Payer CPF or CNPJ
payAmount	number	Yes	Actual paid amount — Actual paid amount
e2eId	string	Yes	Bank ledger ID — Bank transaction ID
applyTime	integer	Yes	Application timestamp in seconds
payTime	integer	No	Completion time — Payment timestamp in seconds
expireTime	integer	Yes	Expiration timestamp in seconds

Response example

{
  "status": 200,
  "msg": null,
  "data": {
    "mchOrderNo": "order_1662112944",
    "platOrderNo": "P5nosqyWAQsQZNtYa5OW",
    "e2eId": "E00416968202309101937aZOHAzv6vkT",
    "orderStatus": "PENDING",
    "amount": 1200,
    "payAmount": 1200,
    "fee": 14,
    "payerName": "Name",
    "payerDocument": "3777882312",
    "payTime": 1670178905,
    "applyTime": 1670178805,
    "expireTime": 1670188805
  }
}