Documentação das APIs

Consulta os dados de uma transação

Este método permite consultar uma determinada transação pela identificação, sendo utilizado principalmente para os comércios detectarem se uma determinada transação associada a uma compra foi paga ou cancelada.

Requisição

CampoTipoDescrição
IdentificadorTextoIdentificador da transação a ser consultada.

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
TipoTextoTipo da transação, podendo ser: “Boleto”, “Cartao” ou “Pix”.
EstadoTextoEstado da transação, podendo ser: “Pendente”, “Aprovada”, “Rejeitada” ou “Cancelada”.
MotivoCancelamentoTextoMotivo de cancelamento da transação, caso tenha sido cancelada.
DataPagamentoData/horaData/hora de pagamento da transação.
ValorNumérico com 2 decimaisValor da transação.
ValorPagoNumérico com 2 decimaisValor pago da transação, pode ser menor (no caso de descontos) ou maior(no caso de juros) que o valor original solicitado.
ConfirmadaURLTextoIndica se a transação foi confirmada na URL do comércio.
SplitsTransacaoSplitLista de “splits” relacionados a transação, indicando o código do cliente e o respectivo valor relacionado.
ClienteDescricaoTextoDescrição do cliente final da transação.
ClienteIPTextoIP do cliente final da transação.
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteNomeTextoNome do cliente final da transação.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!