v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB

CriaTransacaoPix

Cria uma transação via pix

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	Não
Valor	Numérico com 2 decimais	Valor da compra	Sim
SegundosExpiracao	Numérico	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)
DataVencimento	Dia/Mês/Ano	Data de validade do pagamento via Pix	Não(2)(3)
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	Sim
Referencia	Texto	Referência para localização futura da transação	Não
TipoMulta	Texto	Tipo da multa a ser aplicada	Não
ValorMulta	Numérico com 2 decimais	Valor da multa a ser aplicada	Não
TipoJuros	Texto	Tipo do juro a ser aplicado	Não
ValorJuros	Numérico com 2 decimais	Valor do Juros a ser aplicado	Não
TipoDesconto	Texto	Tipo do desconto a ser aplicado	Não
ValorDesconto	Numérico com 2 decimais	Valor do desconto a ser aplicado	Não
DescontosDataFixa	Array	Desconto concedido por data fixa, sendo composto por: Data (no formato YYYY-MM-DD) e ValorDesconto(numérico com 2 casas decimais)	Não
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) - Se o SegundosExpiracao for preenchido, o DataVencimento não deve ser preenchido! (2) - Se o DataVencimento for preenchido, o SegundosExpiracao não deve ser preenchido! (3) - Horário de vencimento: quando enviado a DataVencimento o complemento de horário deve ser informado como T23:59:59. Exemplo: DataVencimento": "2025-10-14T23:59:59".

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

post/api/CriaTransacaoPix

Headers

Aeskeystring required

Request body

Tipostring required

Valornumber double

SegundosExpiracaointeger

DataVencimentostring date-time

DataLimitePagamentostring date-time

URLConfirmacaostring

ClienteDescricaostring required

ClienteIPstring

ClienteCPFCNPJstring required

ClienteNomestring required

ClienteEmailstring

NumeroPedidostring

Referenciastring

TipoMulta'NaoTemMulta' | 'ValorFixo' | 'ValorPercentual'

ValorMultanumber double

TipoJuros'ValorAoDia' | 'TaxaMensal' | 'Isento'

ValorJurosnumber double

TipoDesconto'NaoTemDesconto' | 'ValorFixoAteDataInformada' | 'PercentualADataInformada'

ValorDescontonumber double

Pdvboolean

Example request

{
  "Tipo": "E",
  "Valor": 103.24,
  "SegundosExpiracao": 300,
  "DataVencimento": "0001-01-01T00:00:00",
  "DataLimitePagamento": "0001-01-01T00:00:00",
  "URLConfirmacao": "https://www.meusite.com.br/webhook/confirmacao-transacao",
  "ClienteDescricao": "Cliente Gold Nivel 25",
  "ClienteIP": "127.0.0.1",
  "ClienteCPFCNPJ": "48455151480",
  "ClienteNome": "Renato Samuel Augusto Baptista",
  "ClienteEmail": "renatosamuel@umdominio.com.br",
  "NumeroPedido": "pedido.2026052109",
  "Pdv": false
}

Response

Método executado com sucesso

Retorno'OK' | 'ERRO'

DetalhesErrostring

Identificadorstring

QRCodeTextostring

QRCodeImagemstring