v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBCriaTransacaoPixSimples
Cria uma transação via pix
Este método permite criar uma transação do tipo Pix, sendo que o pagamento deverá ser efetuado pelo cliente final abrindo o aplicativo do banco no qual possua conta e efetuando a leitura do QRCode gerado. <br /> A transação via Pix é criada no estado pendente, e será válida por um determinado tempo definido (SegundosExpiracao). Caso a transação seja paga dentro do prazo proposto, esta será confirmada na URL de confirmação informada pelo integrador, o qual deve consultar o estado da mesma. Caso o tempo máximo seja ultrapassado, a transação terá seu estado alterado para Cancelada e será confirmada na URL de confirmação informada pelo integrador. <br />
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| Valor | Numérico com 2 decimais | Valor da compra | Sim |
| SegundosExpiracao | Numérico | Tempo de validade do pagamento via Pix, em segundos. Quando PDV = true: intervalo de 30 a 2.592.000 segundos. Quando PDV = false: intervalo de 300 a 2.592.000 segundos | Sim |
| 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 | Não |
| ClienteIP | Texto | IP do cliente final da transação | Não |
| ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação | Não |
| ClienteNome | Texto | Nome do cliente final da transação | Não |
| 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 |
| 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 |
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/CriaTransacaoPixSimples
Headers
Aeskeystring required
Request body
Example request
{
"Valor": 13.02,
"SegundosExpiracao": 300,
"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",
"Referencia": "Referencia para a transação",
"Pdv": false
}Response
Método executado com sucesso