post https://pagamentos.k8bank.com.br/PagamentosAPI/api/marketplace/pix
Cria uma transação via pix para marketplace com split dos valores, tendo como participantes do split o Marketplace e os Sellers.
Cada participante é identificado pelo seu ClienteId, porém o Marketplace deve realizar o cadastro da seller primeiro para depois utilizar seu ClienteId como participante do split(utilize a rota seller para cadastro).
Uma transação de split precisa ser decidida depois de cadastrada, caso contrário os valores são considerados como suspensos e não são liberados para os participantes.
Um split requer no mínimo 2 e no máximo 10 participantes, todos devidamente informados por seu ClienteId e qual seu valor de participação sobre o valor total da transação. O tipo de PIX pode ser:
E (estático)
D (dinâmico)
Requisição
| Campo | Tipo | Descrição |
|---|---|---|
| SplitValores | Array | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do K8Bank, a partir do código de cliente e do valor respectivo. |
| Tipo | Texto | E (tipo de PIX estático) ou D(tipo de pix dinâmico) |
| Valor | Numérico com 2 decimais | Valor da compra a ser pago(opcional) |
| SegundosExpiracao | Numérico | Tempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 (5 minutos) até 2592000 (30 dias) |
| DataVencimento | Data | Data de vencimento no formato YYYY-MM-DD(opcional) |
| DataLimitePagamento | Data | Data limite para pagamento do título.Após esta data, o mesmo é baixado junto a CIP(opcional) |
| URLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final(opcional) |
| ClienteDescricao | Texto | Descrição da compra(opcional) |
| ClienteIP | Texto | IP do cliente final da transação(opcional) |
| ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação |
| ClienteNome | Texto | Nome do cliente final da transação |
| ClienteEmail | Texto | E-mail do cliente final da transação(opcional) |
| NumeroPedido | Texto | Número interno do pedido para controle do marketplace(opcional) |
| Referencia | Texto | Referência para localização futura do boleto(opcional) |
| TipoMulta | Texto | Tipo da multa a ser aplicada, sendo os valores possíveis: NaoTemMulta, ValorFixo ou ValorPercentual(opcional) |
| ValorMulta | Numérico com 2 decimais | Valor da multa a ser aplicada |
| TipoJuros | Texto | Tipo do juro a ser aplicado, sendo os valores possíveis: Isento, ValorAoDia ou TaxaMensal(opcional) |
| ValorJuros | Numérico com 2 decimais | Valor do Juros a ser aplicado |
| TipoDesconto | Texto | Tipo do desconto a ser aplicado, sendo os valores possíveis: NaoTemDesconto, ValorFixoAteDataInformada ou PercentualADataInformada. (opcional) |
| ValorDesconto | Numérico com 2 decimais | Valor do desconto a ser aplicado |
| DescontosDataFixa | Array | Desconto concedido por data fixa, sendo composto por: Data(no formato YYYY-MM-DD) e ValorDesconto(numérico com 2 casas decimais) |
| TransacaoSplit | - | Array especificando o “split” financeiro dos valores arrecadados pelo pagamento para diversas contas do K8Bank, a partir do código de cliente e do valor respectivo |
| ClienteId | Texto | O Id do seller(ou do marketplace) que terá a decisão aprovada(opcional) |
| Valor | Numérico com 2 decimais | Valor da parte da transação referente ao seller ou marketplace |
| ValorRoyalties | Número | Valor da parte da transação referente ao seller ou marketplace(opcional) |
| Decisao | Texto | Informa se o slipt será criado como auto aprovado(opcional) |
| DescontoDataFixa | - | - |
| Data | Texto | Data limite para o desconto(opcional) |
| ValorDesconto | Número | Valor de desconto aplicado para pagamento até a data limite cadastrada(opcional) |
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 gerada, caso chamada seja exitosa |
| QRCodeTexto | Texto | Texto do QRCode para realizar o pagamento via Pix. |
| QRCodeImagem | Texto | URL que gera a imagem do QRCode relacionado a transação. |