post
https://pagamentos.meuk8.com.br/PagamentosAPI/api/ConsultaTransacoes
Este recurso possibilita a consulta das transações criadas dentro de um intervalo de datas específico, com a opção adicional de filtrar por tipo de pagamento e estado, se desejado.
Ao utilizar este método, é retornado um agrupamento das transações que correspondem aos filtros informados, fornecendo uma lista das transações que atendem aos critérios especificados.
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| DataHoraInicial | Data | Data/hora inicial de consulta | Sim |
| DataHoraFinal | Data | Data/hora final de consulta | Sim |
| Tipo | Texto | Tipo da transação - Boleto, Cartao, Pix, Ted, SaldoWebConta, BoletoHibrido, OpenFinance, Manual | Sim |
| Estado | Texto | Estado da transação - Pendente, Aprovada, Rejeitada, Cancelar, ACancelar, pendenteCobranca, acancelarCNAB, PendenteAntifraude, AnaliseAntifraude, ProcessarInstrucao, EmProcessamento, PagoeAberto, EstornarPIX, Estornado, ErroEstorno, Liquidado, FalhaCancelamento, CartaoPreAutorizado, CartaoCancelametoFuturo, ErroGerarPixBH | Não |
| TipoFiltro | Texto | Tipo do filtro para a consulta - dataemissao, datapagamento, checkout | 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 |
| Transacoes | Array de Objetos | Transações que correspondem aos filtros informados na requisiçã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 | GUID | Identificador único da transação |
| Tipo | Texto | Tipo da transação - Boleto, Cartao, Pix, Ted, SaldoWebConta, BoletoHibrido, OpenFinance, Manual |
| Estado | Texto | Estado da transação - Pendente, Aprovada, Rejeitada, Cancelar, ACancelar, pendenteCobranca, acancelarCNAB, PendenteAntifraude, AnaliseAntifraude, ProcessarInstrucao, EmProcessamento, PagoeAberto, EstornarPIX, Estornado, ErroEstorno, Liquidado, FalhaCancelamento, CartaoPreAutorizado, CartaoCancelametoFuturo, ErroGerarPixBH |
| TipoPagamento | Texto | Tipo do pagamento - naodefinido, boleto, cartao, pix, ted, SaldoWebConta, OpenFinance, Manual |
| MotivoCancelamento | Texto | Motivo de cancelamento da transação, caso tenha sido cancelada |
| DataPagamento | Data | Data/hora de pagamento da transação |
| Valor | Numérico | Valor da transação destinado ao Marketplace ou Seller |
| ValorPago | Numérico | Valor pago da transação, pode ser menor (no caso de descontos) ou maior(no caso de juros) que o valor original solicitado |
| ValorTaxas | Numérico | Valor total das taxas cobradas sobre a transação |
| DetalhesValores | Objeto | Detalhamento dos valores de desconto, multa e juros da transação, caso houver |
| ValorDesconto | Numérico | Valor de desconto concedido na transação, caso tenha sido concedido algum desconto |
| ValorDesconto2 | Numérico | Segundo valor de desconto concedido na transação, caso tenha sido concedido algum desconto |
| ValorDesconto3 | Numérico | Terceiro valor de desconto concedido na transação, caso tenha sido concedido algum desconto |
| ValorMulta | Numérico | Valor de multa aplicado na transação, caso tenha sido aplicada alguma multa |
| ValorJuros | Numérico | Valor de juros aplicado na transação, caso tenha sido aplicado algum juros |
| ConfirmadaURL | Booleano | Indica se a transação foi confirmada na URL do comércio |
| Splits | Array de Objetos | Lista de “splits” relacionados à transação, indicando o código do cliente e o respectivo valor relacionado |
| ClienteId | GUID | Identificador único do Cliente no PAY |
| Valor | Numérico | Valor da transação destinado ao Marketplace ou Seller |
| ValorRoyalties | Numérico | Valor da transação destinado ao Marketplace ou Seller, sobre o qual poderão incidir taxas, conforme a configuração prévia definida para o participante do split |
| Decisao | Texto | Informa se o split já está aprovado ou não para efetivação da transferência para o recebedor - Pendente, Aprovado, Cancelado, Reprovado |
| Parcelas | Array de Objetos | Detalhamento sobre as parcelas da transação, caso houver |
| Numero | Número | Número de parcelas |
| Estado | Texto | Estado da parcela - Pendente, Aprovada, Rejeitada, Cancelar, ACancelar, pendenteCobranca, acancelarCNAB, PendenteAntifraude, AnaliseAntifraude, ProcessarInstrucao, EmProcessamento, PagoeAberto, EstornarPIX, Estornado, ErroEstorno, Liquidado, FalhaCancelamento, CartaoPreAutorizado, CartaoCancelametoFuturo, ErroGerarPixBH |
| MotivoCancelamento | Texto | Motivo de cancelamento da parcela, caso tenha sido cancelada |
| DataPagamento | Data | Data de pagamento da parcela |
| Valor | Número | Valor da parcela |
| ConfirmadaURL | Booleano | Indica se a parcela 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 | GUID | Código identificador do token do cartão |
| Recorrente | Booleano | Indica se o pagamento é recorrente |
| ContaBolsao | Booleano | Indica se os valores estão alocados em conta bolsao k8 |
| Referencia | Texto | Referência para localização futura do boleto |
| DataLiquidacao | Data | Data em que os valores da transação foram disponibilizados ao recebedor |
| DataDisponibilizacao | Data | Data da disponibilização do valor ao recebedor |
| Liquidado | Booleano | Indica se foi realizada a liquidação da transação |
| EndToEnd | Texto | Exclusivo para transação do tipo pix, retornando o end to end da transação |
| LinhaDigitavel | Texto | Linha digitável para pagamento via boleto |
| CodigoBarras | Texto | Código de barras para pagamento via boleto |
| NossoNumero | Texto | Nosso número de identificação do boleto |
| NumeroMovimentoFinanceiro | Texto | Número de identificação do movimento financeiro referente ao pagamento da transação, exclusivo para pix e boleto |
| QRCodeTexto | Texto | Texto do código Pix copia e cola / QR Code |
| CanalPagamento | Número | Canal por onde o pagamento foi realizado - "NaoDefinido = 0", "AgenciasPostosTradicionais = 1", "TerminalAutoAtendimento = 2", "Internet = 3", "Pix = 4", "CorrespondenteBancario = 5", "CentralAtendimento = 6", "ArquivoEletronico = 7", "DDA = 8", "CorrespondenteBancarioDigital = 9" |
| MeioPagamento | Número | Meio de pagamento utilizado na transação - "NaoDefinido = 0", "Especie = 1", "DebitoEmConta = 2","CartaoCredito = 3", "Cheque = 4" |
| ContaEmissao | Texto | Conta de emissão da transação |
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…