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.


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.

Requisição

CampoTipoDescriçãoOrigatório
ValorNumérico com 2 decimaisValor da compraSim
SegundosExpiracaoNuméricoTempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 (5 minutos) até 86400 (1 dia)Sim
URLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado finalNão
ClienteDescricaoTextoDescrição da compraNão
ClienteIPTextoIP do cliente final da transaçãoNão
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transaçãoNão
ClienteNomeTextoNome do cliente final da transaçãoNão
ClienteEMailTextoE-mail do cliente final da transaçãoNão
NumeroPedidoTextoNúmero interno do pedidoNão
ReferenciaTextoReferência para localização futura da transaçãoNão

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO
IdentificadorTextoIdentificador da transação
QRCodeTextoTextoTexto do QRCode para realizar o pagamento via Pix
QRCodeImagemTextoURL que gera a imagem do QRCode relacionado a transação
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!