Gerar QR Code dinâmico ou composto com recorrência

POST

/api/Pix/SolicitarDynamicQrCode

Pix

Funcionalidade principal

O endpoint SolicitarDynamicQrCode gera um QR Code dinâmico do Pix que suporta cenários avançados de cobrança. Sua principal diferença para o endpoint de e-commerce comum é a capacidade de gerar um QR Code Composto: uma funcionalidade que permite cobrar um valor imediato (pagamento) e, simultaneamente, configurar uma autorização para cobranças futuras automáticas (Pix Automático/Recorrência).

Casos de uso comuns

Assinaturas com adesão imediata: Um serviço de streaming onde o cliente paga a primeira mensalidade no ato e já autoriza os débitos automáticos dos meses seguintes via Pix.

Mensalidades escolares ou academias: Geração de um código único para o contrato anual, onde cada vencimento será processado automaticamente na conta do aluno.

Vendas com valor variável: Cobranças onde o pagador pode ter permissão para alterar o valor (doações ou pagamentos parciais), se configurado.

Requisição

Authorization

Adicionar o parâmetro

Authorization

a Cabeçalhos, cujo valor é concatenar o Token após o Bearer.

Exemplo:

Authorization: Bearer ********************

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200Correto

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/Pix/SolicitarDynamicQrCode' \
--header 'UserName;' \
--header 'RequestOrigin;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "Data": {
        "CodigoCanal": 0,
        "CodigoCliente": 0,
        "ValorQrCode": 0,
        "NsuOrigem": 0,
        "DataVencimento": "2019-08-24T14:15:22.123Z",
        "SegundosExpiracao": 0,
        "PermitirPagamentoAposExpiracao": false,
        "PermitirAlterarValorPagamento": false,
        "DadosRecorrencia": {
            "Vinculo": {
                "Devedor": {
                    "CpfCnpj": "string",
                    "Nome": "string"
                },
                "Descricao": "string",
                "Contrato": "string"
            },
            "Calendario": {
                "DataInicial": "2019-08-24T14:15:22.123Z",
                "DataFinal": "2019-08-24T14:15:22.123Z",
                "Periodicidade": "SEMANAL"
            },
            "Valor": {
                "ValorRecorrencia": 0
            },
            "PoliticaRetentativa": "NAO_PERMITE"
        },
        "Devedor": {
            "CpfCnpj": "string",
            "Nome": "string",
            "AceitaApenasTitular": true
        },
        "InfoAdicionais": [
            {
                "Nome": "string",
                "Valor": "string"
            }
        ]
    }
}'

Response Example

{
    "Data": {
        "PinbankQrCodeId": 0,
        "TextoQrCode": "string",
        "QrCodePixLink": "string",
        "Referencia": "string",
        "QrCodeURL": "string",
        "TxId": "string"
    },
    "ResultCode": 0,
    "Message": "string",
    "ValidationData": {
        "ResultCode": 0,
        "Message": "string",
        "Errors": [
            {
                "ErrorMessage": "string",
                "FieldName": "string"
            }
        ]
    }
}

Modificado em 2026-03-03 15:10:58

Página anterior

Verificar status do estorno de um Pix (Assíncrono)

Próxima página

Consultar status e dados de um QR Code dinâmico

Gerar QR Code dinâmico ou composto com recorrência

Funcionalidade principal#

Casos de uso comuns#

Requisição

Respostas

Funcionalidade principal

Casos de uso comuns