Documentação das APIs

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.


Diferenças entre Pix Estático e Pix Dinâmico


Atualmente nosso gateway dispõe de 2 modelos de pix, sendo diferenciados no parâmetro “Tipo”, sendo E (para estático) e D (para dinâmico). Além disso, o payload disponível para o pix dinâmico é ligeiramente diferente.
A principal diferença entre eles está no fato de que o Pix Dinâmico aceita data de vencimento, descontos, multa e/ou juros, até de ser utilizável apenas uma vez.

Requisição – Pix Estático

CampoTipoDescrição
TipoTextoE (tipo de PIX estático)
ValorNumérico com 2 decimaisValor da compra
SegundosExpiracaoNuméricoTempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 (5 minutos) até 2592000 (30 dias).
URLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado final.
ClienteDescricaoTextoDescrição da compra.
ClienteIPTextoIP do cliente final da transação.
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteNomeTextoNome do cliente final da transação.
ClienteEMailTextoE-Mail do cliente final da transação (opcional).
NumeroPedidoTextoNúmero interno do pedido.

Resposta – Pix Estático

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.

Requisição – Pix Dinâmico

CampoTipoDescrição
TipoTextoD (tipo de Pix dinâmico).
ValorNumérico com 2 decimaisValor da compra.
DataVencimentoDataData de vencimento no formato YYYY-MM-DD
URLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado final.
ClienteDescricaoTextoDescrição da compra.
ClienteIPTextoIP do cliente final da transação.
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteNomeTextoNome do cliente final da transação.
ClienteEmailTextoE-Mail do cliente final da transação (opcional).
NumeroPedidoTextoNúmero interno do pedido (opcional).
TipoMultaTextoTipo da multa a ser aplicada, sendo os valores possíveis: NaoTemMulta, ValorFixo ou ValorPercentual.
ValorMultaNumérico com 2 decimaisValor da multa a ser aplicada.
TipoJurosTextoTipo do juro a ser aplicado, sendo os valores possíveis: Isento, ValorAoDia ou TaxaMensal.
ValorJurosNumérico com 2 decimaisValor do Juros a ser aplicado.
TipoDescontoTextoTipo do desconto a ser aplicado, sendo os valores possíveis: NaoTemDesconto, ValorFixoAteDataInformada ou PercentualADataInformada.
ValorDescontoNumérico com 2 decimaisValor do desconto a ser aplicado.
DescontosDataFixaArrayDesconto concedido por data fixa, sendo composto por: Data (no formato YYYY-MM-DD) e ValorDesconto(numérico com 2 casas decimais).

Resposta – Pix Dinâmico

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
Authorization
OAuth2
Click Try It! to start a request and see the response here!