Criar QR Code para autorização e pagamento de Pix Automático

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

Nesta jornada, o QR Code representa tanto a autorização quanto o pagamento do Pix Automático, que é realizado imediatamente pelo comprador. Ao efetuar esse pagamento, o cliente também confirma a autorização para futuras cobranças automáticas. Essa é a Jornada 3 definida pelo Banco Central.

Quando usar:

Quando o serviço ou produto começa imediatamente;
Quando o primeiro pagamento precisa ocorrer no ato da contratação.

Para criar um QR Code com autorização e pagamento imediato, o campo Payment.RecurrentPayment.AuthorizeNow deve ser enviado como "true".

ℹ️
Para criar um QR Code apenas para autorização, veja Criar QR Code para autorização de Pix Automático.

Requisição

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

{
    "MerchantOrderId": "1234567890",
    "OrderDescription": "Academia",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "123...",
        "IdentityType": "CPF"
    },
    "Payment": {
        "Type": "Pix",
        "Provider": "Cielo2",
        "RecurrentPayment": {
            "RecurrenceType": "SelfManagedConsent",
            "AuthorizeNow": true,
            "StartDate": "2025-01-01",
            "EndDate": "2030-12-31",
            "Interval": "Monthly",
            "RetryPolicy": "Allowed_3R_7D",
            "Amount": 200,
            "Plan": "Convênio"
        }     
    }
}

{
    "MerchantOrderId": "1234567890",
    "OrderDescription": "Academia",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "123...",
        "IdentityType": "CPF"
    },
    "Payment": {
        "Type": "Pix",
        "Amount": 200,
        "Provider": "Cielo2",
        "RecurrentPayment": {
            "RecurrenceType": "SelfManagedConsent",
            "AuthorizeNow": true,
            "StartDate": "2025-01-01",
            "EndDate": "2030-12-31",
            "Interval": "Monthly",
            "RetryPolicy": "Allowed_3R_7D",
            "MinimumAmount": 100,
            "Plan": "Convênio"
        }     
    }
}

Parâmetros no header

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 no body

Parâmetro	Descrição	Tipo	Tamanho	Obrigatório?
`MerchantOrderId`	Número de identificação do pedido. O `MerchantOrderId` será encaminhado para o provedor de Pix como o número do contrato de recorrência, ou código que representa a autorização. Atenção: Os caracteres permitidos são apenas a-z, A-Z, 0-9. Não são permitidos caracteres especiais e espaços em branco..	string	35	Sim
`OrderDescription`	É a descrição do objeto a ser contratado de forma recorrente. Ex.: serviço de streaming, matrícula de academia, conta recorrente de energia elétrica etc.	string	35	Não
`Customer.Name`	Nome do comprador. Atenção: Os caracteres permitidos são apenas a-z, A-Z. Não são permitidos caracteres especiais e números.	string	140	Sim
`Customer.Identity`	Número do CPF ou CNPJ do comprador.	enum	18	Sim
`Customer.IdentityType`	Tipo de documento de identificação do comprador (CPF ou CNPJ).	string	14	Sim
`Payment.Type`	Tipo do meio de pagamento. Neste caso, use "Pix".	enum		Sim
`Payment.Amount`	Valor do pedido. Condicional: envie somente quando há uma cobrança no momento da confirmação da recorrência.	number	15	Condicional
`Payment.Provider`	Nome do provedor do meio de pagamento. Neste caso, use "Cielo2".	enum		Sim
`Payment.RecurrentPayment.RecurrenceType`	Identificador do tipo de recorrência. Neste caso, use "SelfManagedConsent".	enum		Sim
`Payment.RecurrentPayment.AuthorizeNow`	Indica se é uma recorrência com cobrança inicial ("true") ou não ("false"). Neste caso, use "true".	boolean		Sim
`Payment.RecurrentPayment.StartDate`	Data da primeira cobrança da recorrência. Formato: 2030-12-31 (YYYY-MM-DD).	date	10	Sim
`Payment.RecurrentPayment.EndDate`	Data para término da recorrência. Se não for enviado, a recorrência será cobrada até ser cancelada. Formato: 2030-12-31 (YYYY-MM-DD).	date	10	Não
`Payment.RecurrentPayment.Interval`	Intervalo da recorrência. Valores possíveis: Weekly_ (semanal) Monthly_ (mensal) Quarterly_ (trimestral) SemiAnnual_ (semestral) Annual_ (anual)	enum	10	Sim
`Payment.RecurrentPayment.RetryPolicy`	Indica se permitirá retentativa da cobrança. Valores possíveis: NotAllowed: não permite retentativa no caso de falha na cobrança; Allowed_3R_7D: permite três retentativas durante sete dias conforme regras do BACEN.	enum		Sim
`Payment.RecurrentPayment.Amount`	Valor fixo da cobrança recorrente. Condicional: envie apenas quando o valor não está sujeito a alteração por toda a duração da recorrência.	number		Condicional
`Payment.RecurrentPayment.MinimumAmount`	É o valor mínimo de cobrança definido para loja. Se o comprador atribuir um valor máximo para as cobranças recorrentes, esse valor não poderá ser inferior ao valor mínimo definido neste campo. Não pode ser enviado em recorrências de valor fixo, ou seja, quando`Payment.RecurrentPayment.Amount` for informado	number		Opcional e condicional
`Payment.RecurrentPayment.Plan`	Convênio entre usuário pagador e recebedor, se houver.	string	60	Não

Resposta

{
    "MerchantOrderId": "1234567890",
    "OrderDescription": "Academia",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "123...",
        "IdentityType": "CPF"
    },
    "Payment": {
        "QrCodeBase64Image": "iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAH0klEQVR4nO3dS44jOxIEwH7Au/+VZ2Y3QG4IIj70rjLbtpSZksrBJkhG/Puf//kDRPj3DxBDICGIQEIQgYQgAglBBBKCCCQEEUgIIpAQRCAhiEBCEIGEIAIJQQQSgggkBCkH8p9//vmz6Xt883v/0/HO0+tvP0/1eb6qn+fr9vN1f56v2+9/+/esqn4/RkgIIpAQRCAhSPte1m7T63TTz9+9t7P6fWzv9Tw9T/f1X++drjJCQhCBhCACCUHW1yGrbnvEn97/Nb0O1617Tva6V8rt9W7fn94v0ggJQQQSgggkBBmvy1rVvRdxe11wuoZP95xvumbN9hz99d/jLSMkBBFICCKQEOR5TZ2vtN4Q23OUk+k5WPectruGz8n0uuX0722EhCACCUEEEoL89YGcrmkzXbd1+zxger/I6b243XNavT3gBxNICCKQEOTHB7J7jthtu5/idj/P7rq61etNr3vq7QE/iEBCEIGEIOOB3N7rOX3+rvr67V4dJ91zytP1T16vk77eu2yEhCACCUEEEoK0BzKtV8Lr3h3VOcl2zZzT+7+m69xW957eruvenhc9vf+WERKCCCQEEUgIEt8fcvv+23VZu73u7TF9ve376e0Bv5hAQhCBhCACCUEEEoIIJAQRSAgikBBEICGIQEIQgYQgAglBBBKCCCQEEUgI8l8MBPqBjJFDzgAAAABJRU5ErkJggg==",
        "QrCodeString": "00020101021226180014br.gov.bcb.pix5204000053039865802BR5903PIX6009SAO PAULO62070503***80910014br.gov.bcb.pix2569qrcodes-h.cielo.com.br/qr-pix/v1/rec/b81ffb2c624c48d498750f8aba2a192e6304C95D",
        "SentOrderId": "03c1812596c9421db329648c191ebc3f",
        "RecurrentPayment": {
            "RecurrenceType": "SelfManagedConsent",
            "Amount": 200,
            "RetryPolicy": "Allowed_3R_7D",
            "Plan": "Convênio",
            "RecurrenceId": "45097c85-e828-49f9-8999-aa744f1d6674",
            "ReasonCode": 0,
            "ReasonMessage": "OPERACAO REALIZADA COM SUCESSO",
            "StartDate": "2025-01-01",
            "EndDate": "2030-12-31",
            "Interval": "Monthly",
            "AuthorizeNow": true
        },
        "PaymentId": "03c18125-96c9-421d-b329-648c191ebc3f",
        "Type": "Pix",
        "ReceivedDate": "2025-07-31 18:13:43",
        "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/03c18125-96c9-421d-b329-648c191ebc3f"
            }
        ]
    }
}

{
    "MerchantOrderId": "1234567890",
    "OrderDescription": "Academia",
    "Customer": {
        "Name": "Aline de Souza",
        "Identity": "123...",
        "IdentityType": "CPF"
    },
    "Payment": {
        "QrCodeBase64Image": "iVBORw0KGgoAAAANSUhEUgAAAOQAAADkCAYAAACIV4iNAAAACXBIWXMAAA7EAAAOxAGVKw4bAAAH0klEQVR4nO3dS44jOxIEwH7Au/+VZ2Y3QG4IIj70rjLbtpSZksrBJkhG/Puf//kDRPj3DxBDICGIQEIQgYQgAglBBBKCCCQEEUgIIpAQRCAhiEBCEIGEIAIJQQQSgggkBCkH8p9//vmz6Xt883v/0/HO0+tvP0/1eb6qn+fr9vN1f56v2+9/+/esqn4/RkgIIpAQRCAhSPte1m7T63TTz9+9t7P6fWzv9Tw9T/f1X++drjJCQhCBhCACCUHW1yGrbnvEn97/Nb0O1617Tva6V8rt9W7fn94v0ggJQQQSgggkBBmvy1rVvRdxe11wuoZP95xvumbN9hz99d/jLSMkBBFICCKQEOR5TZ2vtN4Q23OUk+k5WPectruGz8n0uuX0722EhCACCUEEEoL89YGcrmkzXbd1+zxger/I6b243XNavT3gBxNICCKQEOTHB7J7jthtu5/idj/P7rq61etNr3vq7QE/iEBCEIGEIOOB3N7rOX3+rvr67V4dJ91zytP1T16vk77eu2yEhCACCUEEEoK0BzKtV8Lr3h3VOcl2zZzT+7+m69xW957eruvenhc9vf+WERKCCCQEEUgIEt8fcvv+23VZu73u7TF9ve376e0Bv5hAQhCBhCACCUEEEoIIJAQRSAgikBBEICGIQEIQgYQgAglBBBKCCCQEEUgI8l8MBPqBjJFDzgAAAABJRU5ErkJggg==",
        "QrCodeString": "00020101021226180014br.gov.bcb.pix5204000053039865802BR5903PIX6009SAO PAULO62070503***80910014br.gov.bcb.pix2569qrcodes-h.cielo.com.br/qr-pix/v1/rec/b81ffb2c624c48d498750f8aba2a192e6304C95D",
        "SentOrderId": "03c1812596c9421db329648c191ebc3f",
        "RecurrentPayment": {
            "RecurrenceType": "SelfManagedConsent",
            "MinimumAmount": 100,
            "RetryPolicy": "Allowed_3R_7D",
            "Plan": "Convênio",
            "RecurrenceId": "45097c85-e828-49f9-8999-aa744f1d6674",
            "ReasonCode": 0,
            "ReasonMessage": "OPERACAO REALIZADA COM SUCESSO",
            "StartDate": "2025-01-01",
            "EndDate": "2030-12-31",
            "Interval": "Monthly",
            "AuthorizeNow": true
        },
        "PaymentId": "03c18125-96c9-421d-b329-648c191ebc3f",
        "Type": "Pix",
				"Amount": 200,
        "ReceivedDate": "2025-07-31 18:13:43",
        "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/03c18125-96c9-421d-b329-648c191ebc3f"
            }
        ]
    }
}

A resposta segue o padrão para as respostas de criação de QRCode do Gateway de Pagamento, com destaque para os parâmetros a seguir:

Parâmetro	Descrição	Tipo
`Payment.QrCodeString`	QR Code composto pela recorrência, com ou sem o pagamento inicial.	string
`Payment.QrCodeStringBase64`	Representa a imagem do QR Code composto pela recorrência	string
`Payment.RecurrentPayment.RecurrenceId`	Identificador da recorrência, retornado pela API no momento da criação do QR Code do Pix Automático. Importante: salve o `Payment.RecurrentPayment.RecurrenceId`, porque será usado posteriormente na criação das cobranças recorrentes.	string
`Payment.PaymentId`	Identificador do pagamento, só será retornado se houver cobrança inicial, ou seja, se `Payment.RecurrentPayment.AuthorizeNow` = true.	string

O Pix Automático não tem ambiente sandbox disponível no momento.