Consultar transação de Pix

ℹ️
Saiba mais sobre essa funcionalidade na documentação.

Na nova integração de Pix não há mudanças na requisição de consulta, mas sim nos campos retornados na resposta. Confira o detalhes a seguir.

Requisição

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}`

Parâmetro do path

Campo	Tipo	Descrição
`PaymentId`	string	Número de identificação do pagamento, retornado pela API na criação do QR Code Pix. Tamanho: 36.

Parâmetros do cabeçalho

Propriedade	Descrição	Tipo	Tamanho	Obrigatório
`MerchantId`	Identificador da loja no Gateway de Pagamentos.	text	36	Sim
`MerchantKey`	Chave pública para autenticação dupla no Gateway de Pagamentos.	text	40	Sim

Resposta

{
    "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"
            }
        ]
    }
}

A tabela a seguir apresenta os principais parâmetros que podem ser retornados pelo Gateway de Pagamentos na consulta de uma transação Pix:

Campo	Tipo	Descrição
`MerchantOrderId`	text	Número de identificação do pedido.
`Payment.PaymentId`	text	Identificador da transação.
`Payment.EndToEndId`	text	Identificador de um Pix pago.
`Payment.SentOrderId`	text	Identificador do pedido de geração do QR code. Representa o`txid` .
`Payment.Status`	number	Status da transação.
`Payment.ReasonCode`	number	Código de retorno

Mudanças nos campos

Confira as mudanças nos campos retornados na consulta ao atualizar o provedor Cielo30 para Cielo2:

Campos	Integração anterior	Integração nova (Cielo2)
`SentOrderId`	Representava o `MerchantOrderId`	Passou a representar o `txid`
`AcquirerTransactionId`	Representava o ID do QR Code.	Não existe mais.
`ProofOfSale`	Representava o NSU do Pix.	Não existe mais.
`EndToEndId`	Não existia.	Representa o identificador do Pix pago.

Os demais campos se mantém iguais.