Documentação das APIs

Cria uma transação via cartão

Este método permite criar uma transação de cartão de crédito, suportando pagamento a vista, parcelado sem juros (lojista) ou parcelado com juros (emissor). Notar que os pagamentos realizados com cartão de crédito são “síncronos”, ou seja, o estado final (Aprovado/Rejeitado) é obtido durante a própria chamada do método, não havendo necessidade de confirmação posterior.

A versão “split” permite distribuir automaticamente os créditos do pagamento via cartão em diversas contas K8Bank, para o caso de receitas rateadas, evitando a necessidades de repasses posteriores, sendo útil para casos de múltiplas empresas prestadoras de serviço de um grupo ou de múltiplos profissionais liberais.
Importante: é preciso ter em mãos os IDs dos clientes participantes do split.No exemplo do payload, os IDs são apenas de exemplo.

Requisição

CampoTipoDescrição
SplitValoresArrayArray 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
NomeImpressoTextoNome do cliente impresso no cartão
DataValidadeAno/Mês no formato AAAAMMData de validade do cartão
NumeroCartaoNumérico de 16 posiçõesNúmero do cartão (opcional)
CodigoSegurancaNumérico de 3 posiçõesCódigo de segurança no verso do cartão (opcional)
CardTokenGuidO token do cartão para transações de recorrência (opcional)
ValorNumérico com 2 decimaisValor da compra a ser pago (opcional)
CartaoFormaPagamentoNumérico Inteiro 1 posiçãoForma de pagamento do cartão, sendo possível os valores: 0 = A Vista, 1 = Parcelado sem juros, 2 = Parcelado com juros (opcional)
QuantidadeParcelasNumérico InteiroQuantidade de parcelas, caso a forma de pagamento seja parcelada.Válidos valores de 2 até 12. Caso seja a vista, pode-se não enviar o valor ou enviar 0 ou 1 (opcional)
ClienteDescricaoTextoDescrição da compra
ClienteIPTextoIP do cliente final da transação. (opcional)
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteNomeTextoNome do cliente final da transação
ClienteEmailTextoE-mail do cliente final da transação (opcional)
ClienteSexoTextoSexo do cliente final da compra, podendo ser M (masculino) ou F (feminino) (opcional)
ClienteDDDTextoDDD do telefone do cliente final da compra (opcional)
ClienteNumeroCelularTextoNúmero do telefone do cliente final da compra (opcional)
ClienteEnderecoTextoEndereço do cliente final da compra (opcional)
ClienteComplementoTextoComplemento do endereço do cliente final da compra (opcional)
ClienteNumeroTextoNúmero do endereço do cliente final da compra (opcional)
ClienteBairroTextoBairro do cliente final da compra (opcional)
ClienteCidadeTextoCidade do cliente final da compra (opcional)
ClienteCEPTextoCEP do cliente final da compra (opcional)
ClienteUFTextoUF do cliente final da compra (opcional)
NumeroPedidoTextoNúmero interno do pedido para controle do marketplace
RecorrenciaBoleanoAceita os valores true ou false, informando se esse pagamento é recorrente.
ReferenciaTextoReferência para localização futura do boleto (opcional)
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.
ClienteIdTextoO Id do seller (ou do marketplace) que terá a decisão aprovada(Opcional)
ValorNumérico com 2 decimaisValor da parte da transação referente ao seller ou marketplace
ValorRoyaltiesNúmeroValor da parte da transação referente ao seller ou marketplace(opcional)
DecisaoTextoInforma se o slipt será criado como auto aprovado(opcional)

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 gerada, caso chamada seja exitosa
CodigoAutorizacaoTextoCódigo de autorização da transação(NIT) (caso seja bem-sucedida)
NsuOperacaoTextoNúmero de operação da transação(caso seja bem-sucedida)
AdquirenteTextoAdquirente responsável pelo processamento da transação
NumeroAutorizacaoTextoNúmero de autorização da transação
BandeiraTextoBandeira do cartão, podendo ser: Diners, MasterCard, Visa, Outros, AmericanExpress, HiperCard, Aura, Elo.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!