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, only to the fields returned in the response. See details below.

Request

Ambiente	Método	Endpoint
Sandbox	get	`https://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}`
Produção	get	`https://apiquery.braspag.com.br/v2/sales/{PaymentId}`

Path parameter

Field	Type	Description
`PaymentId`	string	Payment identifier returned by the API when creating the Pix QR Code. Length: 36.

Header parameters

Property	Description	Type	Length	Required
`MerchantId`	Merchant identifier in the Gateway de Pagamento.	text	36	Yes
`MerchantKey`	Public key for dual authentication in the Gateway de Pagamento.	text	40	Yes

Response

{
    "MerchantOrderId": "2cb...",
    "Customer": {
        "Name": "Luke Mueller",
        "Identity": "732...",
        "Address": {}
    },
    "Merchant": {
        "Id": "94e...",
        "TradeName": "BRASPAG..."
    },
    "Payment": {
        "EndToEndId": "E010...",
        "PaymentId": "5ad...",
        "Type": "Pix",
        "SentOrderId": "5ad...",
        "Amount": 268,
        "ReceivedDate": "2024-07-11 10:19:53",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Cielo2Pix",
        "ProviderDescription": "Cielo2Pix",
        "ReasonCode": 0,
        "Status": 2,
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/5ad96db9-f771-4588-aee6-adb2abfd719b"
            }
        ]
    }
}

The following table lists the main parameters that may be returned by the Gateway de Pagamento when querying a Pix transaction:

Field	Type	Description
`MerchantOrderId`	text	Order identification number.
`Payment.PaymentId`	text	Transaction identifier.
`Payment.EndToEndId`	text	Identifier of a completed Pix payment.
`Payment.SentOrderId`	text	Identifier of the QR code generation request. Represents the `txid`.
`Payment.Status`	number	Transaction status.
`Payment.ReasonCode`	number	Return code.

Field Changes

Check the changes in the fields returned in the query when updating the provider from Cielo30 to Cielo2:

Fields	Previous integration	New integration (Cielo2)
`SentOrderId`	Represented the `MerchantOrderId`.	Now represents the `txid`.
`AcquirerTransactionId`	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.

All other fields remain the same.