Get details on a Pix transaction

ℹ️
Learn more about this feature in the documentation.

In the new Pix integration, there are no changes to the query request, but there are changes to the fields returned in the response. See the details below.

Request

Environment	Method	Endpoint
Sandbox	get	`https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/{PaymentId}`
Production	get	`https://apiquery.cieloecommerce.cielo.com.br/1/sales/{PaymentId}`

Path parameter

Field	Type	Description
`PaymentId`	string	Payment identification number, returned by the API when creating the Pix QR Code. Size: 36.

Header parameters

Property	Description	Type	Size	Required
`MerchantId`	Merchant identifier in the Cielo E-commerce API.	GUID	36	Yes
`MerchantKey`	Public key for dual authentication in the Cielo E-commerce API.	string	40	Yes
`RequestId`	Request identifier, used when the merchant uses different servers for each GET/POST/PUT.	GUID	36	No

Response

{
    "MerchantOrderId": "********************************",
    "AcquirerOrderId": "********************************",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "***********",
        "Address": {}
    },
    "Payment": {
        "Installments": 1,
        "PaymentId": "********-****-****-****-************",
        "EndToEndId": "E010...",
        "Type": "Pix",
        "Amount": 457,
        "ReceivedDate": "2024-12-02 11:15:39",
        "Currency": "BRL",
        "Country": "BRA",
        "Status": 2,
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.cieloecommerce.cielo.com.br/1/sales/660589f1-1076-4c8e-80fd-b001942f8915"
            }
        ]
    }
}

The following table presents the main parameters that can be returned by the API when querying a Pix transaction:

Field	Type	Description
`AcquirerOrderId`	string	Order identification number sent to the provider. Represents the `txid`.
`Payment.PaymentId`	string	Transaction identifier.
`Payment.EndToEndId`	string	Identifier of a paid Pix.
`Payment.Status`	number	Transaction status.

Field updates

See the changes in the fields returned in the query when updating the Cielo provider to Cielo2:

Fields	Previous integration	New integration (Cielo2)
`AcquirerOrderId`	Represented the `Ecommerce Order Id`	Now represents the `txid`
`Tid`	Represented the QR Code ID.	No longer exists.
`ProofOfSale`	Represented the Pix NSU.	No longer exists.
`EndToEndId`	Did not exist.	Represents the identifier of the paid Pix.

The other fields remain unchanged.