post https://pagamentos.k8bank.com.br/PagamentosAPI/api/ConsultaTransacao
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
| Campo | Tipo | Descrição |
|---|---|---|
| Identificador | Texto | Identificador da transação a ser consultada. |
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. |
| Tipo | Texto | Tipo da transação, podendo ser: NaoDefinido, Boleto, Cartao, Pix, Ted, SaldoWebConta, BoletoHibrido, OpenFinance. |
| Estado | Texto | Estado da transação, podendo ser: Pendente, Aprovada, Rejeitada, Cancelada, ACancelar, pendenteCobranca, acancelarCNAB, PendenteAntifraude, AnaliseAntifraude, ProcessarInstrucao, PendenteStatusCartao, PagoeAberto, EstornarPIX, Estornado, ErroEstorno, Liquidado, FalhaCancelamento. |
| MotivoCancelamento | Texto | Motivo de cancelamento da transação, caso tenha sido cancelada. |
| DataPagamento | Texto | Data/hora de pagamento da transação. |
| Valor | Número | Valor da transação. |
| ValorPago | Número | Valor pago da transação, pode ser menor (no caso de descontos) ou maior(no caso de juros) que o valor original solicitado. |
| ConfirmaURL | Boleano | Indica se a transação foi confirmada na URL do comércio. |
| Splits | TransacaoSplit | Lista de “splits” relacionados à transação, indicando o código do cliente e o respectivo valor relacionado. |
| ClienteId | Texto | Identificador do Cliente. |
| Valor | Número | Valor da Transação. |
| ValorRoyalties | Número | Valor da parte da transação referente ao seller ou marketplace. |
| Decisão | Texto | Informa se o split já está aprovado ou não para efetivação da transferência para o recebedor. |
| Parcelas | TransacaoParcela | Número de parcelas. |
| Estado | Texto | Estado da transação, podendo ser: Pendente, Aprovada, Rejeitada, Cancelada, ACancelar, pendenteCobranca, acancelarCNAB, PendenteAntifraude, AnaliseAntifraude, ProcessarInstrucao, PendenteStatusCartao, PagoeAberto, EstornarPIX, Estornado, ErroEstorno, Liquidado, FalhaCancelamento. |
| MotivoCancelamento | Texto | Motivo de cancelamento da transação, caso tenha sido cancelada. |
| DataPagamento | Texto | Data/hora de pagamento da transação. |
| Valor | Número | Valor da transação. |
| ConfirmadaURL | Boleano | Indica se a transação foi confirmada na URL do comércio. |
| ClienteDescricao | Texto | Descrição do cliente final da transação. |
| ClienteIP | Texto | IP do cliente final da transação. |
| ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação. |
| ClienteNome | Texto | Nome do cliente final da transação. |
| NumeroPedido | Texto | Número do pedido e/ou carrinho de compras. |
| CardToken | Texto | Código identificador do token do cartão. |
| Recorrente | Boleano | Aceita os valores true ou false, informando se esse pagamento é recorrente. |
| ContaBolsao | Boleano | Retorna true ou false, para informar se os valores estão alocados em conta bolsão k8. |
| Referencia | Texto | Referência para localização futura do boleto. |
| DataLiquidacao | Texto | Data em que os valores da transação foram disponibilizados ao recebedor. |
| DataDisponibilizacao | Texto | Data da disponibilização do valor ao recebedor. |
| Liquidacao | Boleano | Retorna se foi realizada a liquidação da transação. |
| EndToEnd | Texto | Exclusivos para transação do tipo pix, retornando o end to end da transação. |