Criar QR Code Pix

⚠️

O meio de pagamento Pix estará disponível em breve.

O exemplo a seguir considera que o consumidor está realizando uma compra na plataforma do master:

  1. O comprador escolhe pagar com Pix na plataforma do master;
  2. O master solicita a criação do QR Code Pix do valor total da transação e solicita a divisão entre os participantes (Split transacional);
  3. A API transacional retorna o QR Code Pix (código em base 64). Nesse momento a transação estará com o status 12 Pendente;
  4. O master apresenta o QR Code Pix ao comprador para pagamento (leitura do QR Code ou Pix copia-e-cola);
  5. O comprador efetua pagamento no aplicativo ou ambiente do banco;
  6. O banco confirma o pagamento para a API transacional;
  7. A API transacional envia notificação para o master informando que houve atualização no status da transação;
  8. O master realiza uma consulta na API de consulta transacional para verificar o status atualizado e obter detalhes da transação;
  9. O Split de Pagamento retorna o status atualizado ( status 2, Pago) e os detalhes da transação.

Requisição

AmbienteMétodoEndpoint
Sandboxhttps://apisandbox.braspag.com.br/v2/sales/
Produçãohttps://api.braspag.com.br/v2/sales/
{
    "MerchantOrderId": "202412100002",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "11122233344",
        "IdentityType": "CPF"
    },
    "Payment": {
        "Type": "Pix",
        "Amount": 20000,
        "Provider": "Braspag",
        "SplitPayments": [
            {
                "SubordinateMerchantId": "768d0acf-9502-4411-9ec0-c5413c671771",
                "Amount": 15000,
                "Fares": {
                    "Mdr": 50.0,
                    "Fee": 100
                }
            },
            {
                "SubordinateMerchantId": "d436ad59-6be9-4146-a757-35b97659bedc",
                "Amount": 5000,
                "Fares": {
                    "Mdr": 50.0,
                    "Fee": 100
                }
            }
        ]
    }
}

Parâmetros no header

PropriedadeTipoTamanhoObrigatórioDescrição
MerchantIdString36SimIdentificador da loja no Gateway de Pagamento.
MerchantKeyString40SimChave pública para autenticação dupla no Gateway de Pagamento.
RequestIdString36NãoIdentificador do Request, utilizado quando o lojista usa diferentes servidores para cada GET/POST/PUT.
Content-typeHeader40Simapplication/json

Parâmetros no body

PropriedadeTipoTamanhoObrigatórioDescrição
MerchantOrderIdString50SimNúmero de identificação do pedido.
Customer.NameString255NãoNome do comprador.
Customer.IdentityString14NãoNúmero do CPF ou CNPJ do cliente.
Customer.IdentityTypeString255NãoTipo de documento de identificação do comprador (CPF ou CNPJ).
Payment.TypeString100SimTipo do meio de pagamento. "Pix"
Payment.AmountInteger15SimValor do pedido (ser enviado em centavos).
Payment.ProviderInteger15SimNome do provedor do meio de pagamento.
Payment.SplitPayments.SubordinateMerchantIdString36Sim`MerchantId (identificador) do Seller.
Payment.SplitPayments.AmountInteger--SimParte do valor total da transação referente a participação do Seller, em centavos.
Payment.SplitPayments.Fares.MdrString--NãoMDR(%) do master a ser descontado do valor referente a participação do Seller.
Payment.SplitPayments.Fares.FeeString--NãoTarifa fixa(R$) a ser descontada do valor referente a participação do seller, em centavos.

Resposta

{
    "MerchantOrderId": "202411130002",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "11122233344",
        "IdentityType": "cpf"
    },
    "Payment": {
        "QrCodeBase64Image": "iVBORw0KGgoAAAANSUhEUgAAAPQAAAD0CAYAAACsLwv+AAAACXBIWXMAAA7EAAAOxAGVKw4bAAAI7klEQVR4nO3d0W4spxIF0ETK//9ybp5yJaQjRKgq2vus9eqZ7vHYW4iGKv76+x9/ABH++gOIIdAQRKAhiEBDEIGGIAINQQQaggg0BBFoCCLQEESgIYhAQxCBhiACDUEEGoJcB/rPP//8Y9Javn17/931Tn++Ov18p+Xpu+tXf77T6+/u112Of3u/1//fp4zQEESgIYhAQ5DyQFfPiU7niNNzwurrnc75bufIp++/feaw032/2zn19P/3KSM0BBFoCCLQEKQ90K/XYXfXP51jVq9bd697T88xb+fMtz/vXne/vV73ursRGoIINAQRaAgSF+jdnLF63XR1Oydc3c65un/f22cS1c8QVt3X/5q4QMPvTKAhiEBDkLhA384ZT+dY1XPc7nXV7nXY273R3evku/v/dHGBht+ZQEMQgYYg7YHunqNUr6uemt5rvVO997r6mcOp6b3Zp742BzdCQxCBhiACDUHKA/21OezrvbyvP99tj7LX9d7Vn3/1up66mhEaggg0BBFoCHId6NfrcLd9q6vnlKfX7/a1+uHqHmI7v9tebyM0BBFoCCLQEOT5+dDTe59fr5Pefp6d6fOyb+9f/fev7gnX/ftW74MwQkMQgYYgAg1BxgN92+Or+vqn19up/n1Or396v+qeZN3na1fvpa5+JvOaERqCCDQEEWgI8ryn2O1ZVN33r75f9zODU91zyOo+6dPfb3c9evUc3AgNQQQaggg0BGkP9PQcaff66r3Kr/tO384Zp3uWrW7n8NW//+39Tu9fzQgNQQQaggg0BPlcoF/Xl76uR17d3r97jn1bP36ruz769H6r6b3vnws08N8JNAQRaAjS3pe7ei/vqel1ytPrfa0n2u5+p5/v9PWne/mn1+Gre47pKQb8kkBDEIGGIOP10Ld9lrvPkpo+L7h6zl297no6R53e675T/fm75/C3jNAQRKAhiEBDkPazrW73/t7e72s9pk697mNevS47XR/8eh/D7nr2cgO/JNAQRKAhSPle7ul63Om90Keqe5p19wjrXsd/3ZOtu+fZ9DOWlREaggg0BBFoCPJ8L/eqe845fXbT655ku+t3P1PoXqee3qvd3SPtlhEaggg0BBFoCPL8bKtV95ytel3wa+ug032wV9Xr9tVer4t3M0JDEIGGIAINQdrroW9V9xybPmvo63O26vrn7vrp7p501X+f6b3dRmgIItAQRKAhSHmgu89emu45trv+1/YK3/7+3XPIna/VH3fva3C2FfBLAg1BBBqClAe6uv61uudY99lQX+uj/brn2nQ9+e31q39fPcWA/0ygIYhAQ5Dyvtynvnae8e71p/e/XVc9vf6p7p5n3T3Xuueo3fsAnG0F/JJAQxCBhiCfq4ee7mM9vbf59POsXvc1P/080/Xp3fXP033dTxmhIYhAQxCBhiCfP9uqWvd5z93nS3f/vLsPePUzj9OfT///TfewM0JDEIGGIAINQcYDXd2n+nW9b3ef6um957fX2zn9PqrPf955vXffOjTwL4GGIAINQcbPh+7em9u9jjp99tWt7mcUt88MdtebPgtr9bW94TtGaAgi0BBEoCHI5/Zy796/M12f3f373JruufV63Xr6/qev7/68RmgIItAQRKAhyPg6dPXrV931yK/PB+6u5+3+PNX7EF7XBuzeP33WlREaggg0BBFoCFIe6Nu9tF87K+v0+t3nPVd/v9X1w937AKa//9PrT9c/r4zQEESgIYhAQ5DyQHefj3w7B6zuAXZ6/Vuv16G7e6id6n4m092TrJoRGoIINAQRaAjy49ehv97j6faZwqp63bT6fOzbvfvd6+ynqtelu+f8RmgIItAQRKAhSPs69E71HKTadH317vWr6b3U3e+fPr/59vvr3ndwyggNQQQaggg0BGlfh15Vz7Ff10937/1+Pcerfobx+qyq7n0Ot/e7ZYSGIAINQQQagozXQ6+692J3753d3X/V3Se6e127e2939zOT1fT/Q3efbiM0BBFoCCLQEOQ60N31xd09narrkV/PkatVz6mrv5/XZ41197g7ZYSGIAINQQQaglwHurpet/p603t3p58Z7O5fvXd7Vf33vb3+qdvP/7W93kZoCCLQEESgIUh7oL+2t3unew556nYd9vWc77aeubtn3Kr7rK2VdWjglwQaggg0BBnvKbaqrl+e7gt+er2d6b7d1XPw6u/ndb36655zp4zQEESgIYhAQ5DP1UN315Pe1vPu/PQ5/On1qvtkT/cN715XP73eLSM0BBFoCCLQEKS8Hvr12Uy3n6d6Tl29V7n6+5uu1+3uqz5dH7963RfeCA1BBBqCCDQEGa+HXlXPUXf3v53jd8+xd/er9rX636/tBZ8+m+qWERqCCDQEEWgIMn4+9HTPqNt64J3uveDdPcC66813qtedu8/Oqn5/NSM0BBFoCCLQEKS8Hnq63ri6nnX3+lvTZylN74W+vf7r9++ut3q9j2BlhIYgAg1BBBqCjPflnu4ZNl2P+tPOxqqec55e//b93Z9/p/rv7Wwr4F8CDUEEGoKMB7q6nrX7bKzTvd7T9dSr6r3Mu9fffj/VZ2l1n0W1spcbaCPQEESgIUh5X+5ur3tQVZ8v3F2PPF1ffXq9r52Ntft59Tq6vtzALwk0BBFoCDK+l/tU9V7iVXdf7VPVzySmP1/3uvHXzu/eXX+6/t4IDUEEGoIINAR5frbVqrvn2Glf8Oq9yjvVPbVuTffBrl63vj0f/JaeYsB/JtAQRKAhyI8P9Ov641PT9dDT9brTfcG7e9TtvO5ht/rxgQb+T6AhiEBDkLhAT8+Jbu9fva7cXV/9eo54qruv+OvzxFdxgYbfmUBDEIGGIO2Bnp5Tda8zrqrnlN09v7rXpW/3Uv8dtk9g+qwtIzQEEWgIItAQpDzQ0/Wfp6rrs7vnzLefp/r9p7rn1Ldz1Nt9AF97JmCEhiACDUEEGoJcB/r1umH3nPXr96++/k/7e1a//1b1WWunjNAQRKAhiEBDEIGGIAINQQQaggg0BBFoCCLQEESgIYhAQxCBhiACDUEEGoIINAT5H3TwUKwOudFBAAAAAElFTkSuQmCC",
        "QrCodeString": "00020101021226990014br.gov.bcb.pix2577qrcodes-h.cielo.com.br/qr-pix/qrs1/v2/01VpmMudPp69ce9UpCpP6TQAHisoVnH0D8MByj9520400005303986540530.005802BR5915RAZAO MOCK LTDA6006Recife62070503***6304289C",
        "SentOrderId": "69ffe23bc3f34d6090ac46f57d32cadb",
        "SplitPayments": [
            {
                "SubordinateMerchantId": "94e5ea52-79b0-7dba-1867-be7b081edd97",
                "Amount": 20000
            }
        ],
        "SplitTransaction": {
            "MasterRateDiscountType": "sale",
            "ReleasedToAnticipation": true
        },
        "PaymentId": "69ffe23b-c3f3-4d60-90ac-46f57d32cadb",
        "Type": "Pix",
        "Amount":20000,
        "ReceivedDate": "2025-01-16 15:09:17",
        "Currency": "BRL",
        "Country": "BRA",
        "Provider": "Braspag",
        "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/69ffe23b-c3f3-4d60-90ac-46f57d32cadb"
            }
        ]
    }
}

Parâmetros da resposta

PropriedadeTipoDescrição
Payment.QrCodeBase64ImageStringBase64 da imagem do QRCode gerado para pagamento do Pix. O prazo de expiração do QRCode gerado é de 2 horas.
Payment.QrCodeStringStringCódigo do Pix (copia e cola) que pode ser usado para pagamento. O prazo de expiração do QRCode gerado é de 2 horas.
Payment.SentOrderIdStringIdentificador da transação Pix (txid). O Gateway de Pagamento cria um código para cada QRCode solicitado.
Payment.ReturnCodeStringCódigo do motivo do erro caso ocorra algum no processo.
Payment.ReturnMessageStringMensagem de retorno.
Payment.PaymentIdStringIdentificador único externo da transação.
Payment.ProviderReturnCodeIntegerCódigo de retorno do provedor.
Payment.ProviderReturnMessageStringMensagem de retorno do provedor.