Este endpoint permite criar uma transação do tipo Pix, na qual o pagamento deverá ser realizado pelo cliente final por meio da leitura de um QRCode gerado, utilizando o aplicativo do banco em que possui conta.
A transação é criada inicialmente com o status pendente e permanecerá válida por um período determinado, conforme definido no campo SegundosExpiracao. Se o pagamento for efetuado dentro do prazo, a transação será confirmada na URL de notificação informada pelo integrador. Caso o tempo expire sem o pagamento, o status será alterado para cancelado, e essa atualização também será enviada para a URL de notificação.
Pix Estático vs Pix Dinâmico
Atualmente, o gateway suporta dois modelos de transação Pix, definidos pelo parâmetro Tipo:
- E: Pix Estático
- D: Pix Dinâmico
A principal diferença entre eles está nas funcionalidades e no comportamento do QRCode:
Pix Estático: Utilizável múltiplas vezes, com informações fixas.
Pix Dinâmico: Gera um QRCode exclusivo por transação, aceita configurações adicionais como data de vencimento, descontos, multa e/ou juros, e pode ser configurado para uso único.
Além disso, o payload enviado para criação do Pix Dinâmico possui pequenas variações em relação ao do Pix Estático.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Tipo | Texto | Informar D = para tipo de pix dinâmico, e E = para tipo de pix estático | Sim |
| Valor | Numérico | Valor da compra | Sim |
| SegundosExpiracao | Número | Tempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 até 2592000 (30 dias) para Pix Estático e 86400 (24 horas) para Pix Dinâmico | Não(1)(3) |
| DataVencimento | Data | Data de validade do pagamento via Pix | Não(2)(3) |
| DataLimitePagamento | Data | Data limite do pagamento via Pix | Não |
| URLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final | Não |
| ClienteDescricao | Texto | Descrição da compra | Sim |
| ClienteIP | Texto | IP do cliente final da transação | Não |
| ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação | Sim |
| ClienteNome | Texto | Nome do cliente final da transação | Sim |
| ClienteEmail | Texto | E-mail do cliente final da transação | Não |
| NumeroPedido | Texto | Número interno do pedido | Não |
| Referencia | Texto | Referência para localização futura da transação | Não |
| TipoMulta | Texto | Tipo da multa a ser aplicada - NaoTemMulta, ValorFixo, ValorPercentual | Não |
| ValorMulta | Numérico | Valor da multa a ser aplicada | Não (4) |
| TipoJuros | Texto | Tipo do juro a ser aplicado - ValorAoDia, TaxaMensal, Isento | Não |
| ValorJuros | Numérico | Valor do Juros a ser aplicado | Não (5) |
| TipoDesconto | Texto | Tipo do desconto a ser aplicado - NaoTemDesconto, ValorFixoAteDataInformada, PercentualADataInformada | Não |
| ValorDesconto | Numérico com 2 decimais | Valor do desconto a ser aplicado | Não (6) |
| DescontosDataFixa | Array de Objeto | Desconto concedido por data fixa | Não (6) |
| Data | Data | Data do desconto | Não (7) |
| ValorDesconto | Numérico | Valor do desconto | Não (7) |
| -- | -- | -- | -- |
| Pdv | Booleano | Indica se a transação foi realizada em um ponto de venda físico (PDV). Quando definido como true, a transação passa a seguir regras e validações específicas. | Não |
(1) - Obrigatório informar quando PDV = true, e devem estar entre 30 e 2.592.000 segundos (30 dias)
(2) - Quando PDV = true, deve ser informado apenas o campo SegundosExpiracao
(3) - Quando Tipo = "D" (Dinâmico) deve ser informado somente SegundosExpiracao ou DataVencimento
(4) - Obrigatório informar caso TipoMulta for enviado
(5) - Obrigatório informar caso TipoJuros for enviado
(6) - Quando for enviado TipoDesconto um dos campos ValorDesconto ou DescontosDataFixa deve ser informado
(7) - Obrigatório informar caso DescontosDataFixa for informado
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Retorno | Texto | Retorno da chamada, podendo possuir os valores OK ou ERRO |
| DetalhesErro | Texto | Detalhes do erro gerado, caso o retorno seja ERRO |
| Identificador | Texto | Identificador da transação |
| QRCodeTexto | Texto | Texto do QRCode para realizar o pagamento via Pix |
| QRCodeImagem | Texto | URL que gera a imagem do QRCode relacionado a transação |
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||