[Cielo2] Consultar transação de Pix

Requisição

AmbienteMétodoEndpoint
Sandboxhttps://apiquerysandbox.braspag.com.br/v2/sales/{PaymentId}
Produçãohttps://apiquery.braspag.com.br/v2/sales/{PaymentId}

Parâmetro do path

CampoTipoDescrição
PaymentIdstringNúmero de identificação do pagamento, retornado pela API na criação do QR Code Pix. Tamanho: 36.

Parâmetros do cabeçalho

PropriedadeDescriçãoTipoTamanhoObrigatório
MerchantIdIdentificador da loja no Gateway de Pagamentos.text36Sim
MerchantKeyChave pública para autenticação dupla no Gateway de Pagamentos.text40Sim

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:

CampoTipoDescrição
MerchantOrderIdtextNúmero de identificação do pedido.
Payment.PaymentIdtextIdentificador da transação.
Payment.EndToEndIdtextIdentificador de um Pix pago.
Payment.SentOrderIdtextIdentificador do pedido de geração do QR code. Representa o txid.
Payment.StatusnumberStatus da transação.
Payment.ReasonCodenumberCódigo de retorno

Mudanças nos campos

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

CamposAntesDepois
SentOrderIdRepresentava o MerchantOrderIdPassou a representar o txid
AcquirerTransactionIdRepresentava o ID do QR Code.Não existe mais.
ProofOfSaleRepresentava o NSU do Pix.Não existe mais.
EndToEndIdNão existia.Representa o identificador do Pix pago.

Os demais campos se mantém iguais.