Criar pagamento com QR Code Pix

✅
Essa é a nova integração Pix que você deve seguir a partir de 01/10.

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

Para gerar um QR code Pix através da Gateway de Pagamentos, faça a integração conforme a especificação a seguir.

O campo obrigatório Payment.Type deve ser enviado como "Pix". A resposta da requisição irá retornar o código base64 da imagem do QR Code Pix, que a loja deverá disponibilizar ao comprador.

⚠️
O tempo de expiração máximo do QR Code Pix pela Cielo é 24 horas. Esse tempo de expiração pode ser alterado no campo Payment.QrCodeExpiration.

Requisição

Ambiente	Método	Endpoint
Produção	post	`https://api.braspag.com.br/v2/sales/`

{
    "MerchantOrderId": "1234567890",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "077...",
        "IdentityType": "CPF"
    },
    "Payment": {
        "Type": "Pix",
        "Amount": 100,
        "Provider": "Cielo2"       
    }
}

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
`RequestId`	Identificador da requisição, usado quando a loja usa diferentes servidores para cada GET/POST/PUT.	Text	36	Não

Parâmetros do corpo

Campo	Tipo	Descrição
`MerchantOrderId`	text	Número de identificação do pedido. Caracteres especiais não são permitidos. Tamanho: 25
`Customer.Name`	text	Nome do comprador. Tamanho: 255.
`Customer.Identity`	text	Número do CPF ou CNPJ do comprador. Tamanho: 18.
`Payment.Type`	text	Tipo do meio de pagamento. Neste caso, insira “Pix”. Tamanho: 15.
`Payment.Provider`	text	Nome do provedor do meio de pagamento. Neste caso, "Cielo2"
`Payment.Amount`	number	Valor do pedido, em centavos.
`Payment.QrCodeExpiration`	number	Tempo de expiração do QR Code, em segundos. (Ex: 30 minutos = 1800). O envio é opcional; Caso não seja informado, o valor padrão será 86400 (24 horas).

Resposta

{
    "MerchantOrderId": "7a8...",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "211...",
        "IdentityType": "CPF"
    },
    "Payment": {
        "QrCodeBase64Image": "iVB...",
        "QrCodeString": "00020...",
        "SentOrderId": "f72...",
        "PaymentId": "f72...",
        "Type": "Pix",
        "Amount": 100,
        "ReceivedDate": "2024-11-25 11:30:33",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Cielo2",
        "ReasonCode": 0,
        "ReasonMessage": "Successful",
        "Status": 12,
        "ProviderReturnCode": "0",
        "ProviderReturnMessage": "OPERACAO REALIZADA COM SUCESSO",
        "Links": [
            {
                "Method": "GET",
                "Rel": "self",
                "Href": "https://apiquerysandbox.braspag.com.br/v2/sales/f72965cb-e5d3-42fd-8fc3-4eaa51c9427e"
            }
        ]
    }
}

Parâmetros da reposta

A tabela a seguir apresenta os principais parâmetros que podem ser retornados pelo Gateway na geração de um QR code para pagamento em Pix:

Campo	Tipo	Descrição
`Payment.QrCodeBase64Image`	text	Base64 da imagem do QRCode gerado para pagamento do Pix.
`Payment.QrCodeString`	text	Código do pix (Copia e cola) que pode ser usado para pagamento.
`Payment.SentOrderId`	text	Identificador da transação Pix, representa o `txid`.
`Payment.ReturnCode`	number	Código de retorno.
`Payment.ReturnMessage`	text	Mensagem de retorno.
`Payment.PaymentId`	text	Identificador da transação usado para consulta.
`Payment.ProviderReturnCode`	text	Código de retorno do provedor.
`Payment.ProviderReturnMessage`	text	Mensagem de retorno do provedor.

A nova integração Pix ainda não tem ambiente sandbox disponível.

Mudança nos campos

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

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

Os demais campos se mantém iguais.

✅Essa é a nova integração Pix que você deve seguir a partir de 01/10.

ℹ️

⚠️

Requisição

Resposta

Mudança nos campos

✅
Essa é a nova integração Pix que você deve seguir a partir de 01/10.