--- title: "Consulta transações por seller" method: POST path: "/api/marketplace/transacoes" tags: ["Marketplace"] --- # Consulta transações por seller `POST /api/marketplace/transacoes` Esta rota permite consultar as transações relacionadas a um seller, desde que possuam **split configurado** na transação.
Transações sem split não serão retornadas. ### Requisição | **Campo** | **Tipo** | **Descrição** | **Obrigatório** | |-------------------|----------|----------------------------------------------------------------|------------------| | DataHoraInicial | Data | Data e hora inicial do filtro (formato: YYYY-MM-DDTHH:mm:ss) | Sim | | DataHoraFinal | Data | Data e hora final do filtro (formato: YYYY-MM-DDTHH:mm:ss) | Sim | | Identificador | Texto | Identificador da transação (filtro opcional) | 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[ConsultaTransacaoResponse] | Lista com os dados das transações encontradas | #### ConsultaTransacaoResponse | **Campo** | **Tipo** | **Descrição** | |------------------------|------------------------|-------------------------------------------------------------------------------| | Identificador | Texto | Identificador da transação | | Tipo | Texto | Forma de pagamento | | Estado | Texto | Estado da transação | | MotivoCancelamento | Texto | Motivo do cancelamento, se houver | | DataPagamento | Texto | Data de pagamento da transação | | Valor | Número | Valor total da transação | | ValorPago | Número | Valor efetivamente pago | | ConfirmadaURL | Booleano | Indica se a transação foi confirmada na URL do comércio | | Splits | Array[TransacaoSplit] | Lista de valores divididos por seller ou marketplace | | Parcelas | Array[TransacaoParcela]| Informações das parcelas | | ClienteDescricao | Texto | Descrição da compra | | ClienteIP | Texto | IP do usuário que realizou a transação | | ClienteCPFCNPJ | Texto | CPF ou CNPJ do cliente final | | ClienteNome | Texto | Nome do cliente final, tamanho máximo de 100 caracteres | | NumeroPedido | Texto | Número do pedido ou carrinho, tamanho máximo de 20 caracteres | | CardToken | Texto | Token do cartão para transações recorrentes | | Recorrente | Booleano | Indica se a transação é recorrente | | ContaBolsao | Booleano | Indica se os valores estão alocados em conta bolsão | | Referencia | Texto | Referência de localização futura | | DataLiquidacao | Texto | Data de liquidação da transação | | Liquidado | Booleano | Indica se a transação foi liquidada | | EndToEnd | Texto | Código end-to-end da transação | #### TransacaoSplit | **Campo** | **Tipo** | **Descrição** | |---------------------|----------|----------------------------------------------------------------| | ClienteId | Texto | Id do seller ou marketplace | | Valor | Número | Valor da transação destinado ao Marketplace ou Seller | | ValorRoyalties | Número | 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 | Indica se o split foi criado como auto aprovado | #### TransacaoParcela | **Campo** | **Tipo** | **Descrição** | |-----------------------|-----------|----------------------------------------------------------------| | Numero | Número | Número identificador da parcela | | Estado | Texto | Estado da parcela | | MotivoCancelamento | Texto | Motivo do cancelamento da parcela | | DataPagamento | Texto | Data/hora de pagamento da parcela | | Valor | Número | Valor da parcela | | ConfirmadaURL | Texto | Indica se foi confirmada na URL do comércio | ## Headers - `Aeskey` string, required ## Request body - BknBankPagamentosBusinessConsultaTransacoesMarketplaceRequest - `DataHoraInicial` string, date-time, required - `DataHoraFinal` string, date-time, required - `Identificador` string, uuid ## Response `200` Criacao da transacao - BknBankPagamentosBusinessConsultaTransacoesResponse - `Retorno` 'OK' | 'ERRO' - `DetalhesErro` string - `Transacoes` BknBankPagamentosBusinessConsultaTransacaoResponse[] - `Retorno` 'OK' | 'ERRO' - `DetalhesErro` string - `Identificador` string - `Tipo` 'Todos' | 'NaoDefinido' | 'Boleto' | 'Cartao' | 'Pix' | 'Ted' | 'SaldoWebConta' | 'BoletoHibrido' | 'OpenFinance' | 'Manual' - `Estado` 'Todos' | 'Pendente' | 'Aprovada' | 'Rejeitada' | 'Cancelada' | 'ACancelar' | 'pendenteCobranca' | 'acancelarCNAB' | 'PendenteAntifraude' | 'AnaliseAntifraude' | 'ProcessarInstrucao' | 'EmProcessamento' | 'PagoeAberto' | 'EstornarPIX' | 'Estornado' | 'ErroEstorno' | 'Liquidado' | 'FalhaCancelamento' | 'CartaoPreAutorizado' | 'CartaoCancelametoFuturo' | 'ErroGerarPixBH' - `TipoPagamento` 'todos' | 'naodefinido' | 'boleto' | 'cartao' | 'pix' | 'ted' | 'SaldoWebConta' | 'OpenFinance' | 'Manual' - `MotivoCancelamento` string - `DataPagamento` string, date-time - `Valor` number, double - `ValorPago` number, double - `ValorTaxas` number, double - `DetalhesValores` BknBankPagamentosBusinessDetalhesValores - `ValorDesconto` number, double - `ValorDesconto2` number, double - `ValorDesconto3` number, double - `ValorMulta` number, double - `ValorJuros` number, double - `ConfirmadaURL` boolean - `Splits` BknBankPagamentosBusinessTransacaoSplit[] - `ClienteId` string, uuid - `Valor` number, double - `ValorRoyalties` number, double - `Decisao` string - `Parcelas` BknBankPagamentosBusinessTransacaoParcela[] - `Numero` integer - `Estado` 'Todos' | 'Pendente' | 'Aprovada' | 'Rejeitada' | 'Cancelada' | 'ACancelar' | 'pendenteCobranca' | 'acancelarCNAB' | 'PendenteAntifraude' | 'AnaliseAntifraude' | 'ProcessarInstrucao' | 'EmProcessamento' | 'PagoeAberto' | 'EstornarPIX' | 'Estornado' | 'ErroEstorno' | 'Liquidado' | 'FalhaCancelamento' | 'CartaoPreAutorizado' | 'CartaoCancelametoFuturo' | 'ErroGerarPixBH' - `MotivoCancelamento` string - `DataPagamento` string, date-time - `Valor` number, double - `ConfirmadaURL` boolean - `ClienteDescricao` string - `ClienteIP` string - `ClienteCPFCNPJ` string - `ClienteNome` string - `NumeroPedido` string - `CardToken` string, uuid - `Recorrente` boolean - `ContaBolsao` boolean - `Referencia` string - `DataLiquidacao` string, date-time - `DataDisponibilizacao` string, date-time - `Liquidado` boolean - `EndToEnd` string - `LinhaDigitavel` string - `CodigoBarras` string - `NossoNumero` string - `QRCodeTexto` string - `CanalPagamento` 'NaoDefinido' | 'AgenciasPostosTradicionais' | 'TerminalAutoAtendimento' | 'Internet' | 'Pix' | 'CorrespondenteBancario' | 'CentralAtendimento' | 'ArquivoEletronico' | 'DDA' | 'CorrespondenteBancarioDigital' - `MeioPagamento` 'NaoDefinido' | 'Especie' | 'DebitoEmConta' | 'CartaoCredito' | 'Cheque' - `ContaEmissao` string ## Other responses - `400` — Requisição mal formatada - `500` — Erro interno no servidor --- [API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)