Cria uma transação via cartão de crédito com split dos valores
Changed onEste endpoint permite criar uma transação de cartão de crédito, suportando pagamento à 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. <br />
A versão “split” permite distribuir automaticamente os créditos do pagamento via cartão em diversas contas MeuK8, 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. <br />
Importante: é preciso ter em mãos os IDs dos clientes participantes do split. No exemplo do payload, os IDs são apenas de exemplo. <br />
Requisição
| Campo | Tipo | Descrição | Obrigatório |
|---|---|---|---|
| SplitValores | Array de Objeto | - | Sim |
| ClienteId | GUID | Identificador do Cliente | Sim |
| Valor | Número | Valor da Transação | Sim |
| ValorRoyaties | Número | Valor da parte da transação referente ao seller ou marketplace | Não |
| Decisao | Texto | Informa se o split já está aprovado ou não para efetivação da transferência para o recebedor | Não |
| - | - | - | - |
| NomeImpresso | Texto | Nome do cliente impresso no cartão | Sim(1)(3) |
| DataValidade | Data | Data de validade do cartão | Sim(1) |
| NumeroCartao | Texto | Número do cartão | Sim(1) |
| CodigoSeguranca | Texto | Código de segurança no verso do cartão | Sim(1)(3) |
| CardToken | GUID | Identificador único do token do cartão para transações de recorrência | Não(2) |
| Valor | Numérico | Valor da compra | Sim |
| CartaoFormaPagamento | Número | Forma de pagamento do cartão, sendo possível os valores: 0 = À vista; 1 = Parcelado sem juros; 2 = Parcelado com juros | Não(4) |
| QuantidadeParcelas | Número | Quantidade 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 | Não |
| ClienteDescricao | Texto | Descrição da compra | Sim |
| ClienteIP | Texto | IP do cliente final da transação | Não |
| ClienteCPFCNPJ | Texto | CPF/CNPJ do cliente final da transação | Sim |
| ClienteNome | Texto | Nome do cliente final da transação | Sim |
| ClienteEmail | Texto | E-mail do cliente final da transação | Não |
| ClienteSexo | Texto | Sexo do cliente final da compra - M (masculino) ou F (feminino) | Não |
| ClienteDDD | Texto | DDD do telefone do cliente final da compra | Não |
| ClienteNumeroCelular | Texto | Número do telefone do cliente final da compra | Não |
| ClienteEndereco | Texto | Endereço do cliente final da compra | Não |
| ClienteComplemento | Texto | Complemento do endereço do cliente final da compra | Não |
| ClienteNumero | Texto | Número do endereço do cliente final da compra | Não |
| ClienteBairro | Texto | Bairro do cliente final da compra | Não |
| ClienteCidade | Texto | Cidade do cliente final da compra | Não |
| ClienteCEP | Texto | CEP do cliente final da compra | Não |
| ClienteUF | Texto | UF do cliente final da compra | Não |
| NumeroPedido | Texto | Número do pedido e/ou carrinho de compras | Não |
| Referencia | Texto | Referência para localização futura da transação | Não |
| PreAutorizar | Booleano | Indica se a transação deve ser pré-autorizada. Enviando como true a transacao fica com o Status de CartaoPreAutorizado | Não |
| AntiFraude | Booleano | Indica se a transação deve passar por verificação antifraude. Enviando como true a transacao fica com o Status de PendenteAntifraude | Não |
(1) Não se torna obrigatório caso o cardToken for informado (2) Obrigatório se número e código de segurança não forem informados (3) É obrigatório se o provedor de pagamento for a Valorem, mesmo se tiver informando o cardToken (4) - Obrigatório informar 1(Parcelado sem juros) ou 2(Parcelado com juros) caso QuantidadeParcelas seja maior ou igual a 2.
Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| Retorno | Texto | Retorno da chamada, podendo possuir os valores OK, PENDENTEANTIFRAUDE ou CARTAOPREAUTORIZADO, ERRO |
| DetalhesErro | Texto | Detalhes do erro gerado, caso o retorno seja ERRO |
| Identificador | Texto | Identificador da transação |
| CodigoAutorizacao | Texto | Código de autorização da transação (NIT) (caso seja bem sucedida) |
| NsuOperacao | Texto | Número de operação da transação(caso seja bem sucedida) |
| Adquirente | Texto | Adquirente responsável pelo processamento da transação |
| NumeroAutorizacao | Texto | Número de autorização da transação |
| Bandeira | Texto | Bandeira do cartão utilizado na transação |
Request
- Base URLhttps://pagamentos.meuk8.com.br/PagamentosAPI
- URLhttps://pagamentos.meuk8.com.br/PagamentosAPI/api/CriaTransacaoCartaoSplit
- AuthOAuth 2PasswordToken URL: /BknBankPagamentosAPI/token scopes: BknBankPagamentosAPI
Headers
Request body
Example request
{
"SplitValores": [
{
"ClienteId": "ee1afd53-19fa-44c5-a856-8190ef59b3a8",
"Valor": 150,
"ValorRoyalties": 0
},
{
"ClienteId": "eeeacd76-4192-4ab1-af70-1300bb3e29f8",
"Valor": 80,
"ValorRoyalties": 0
}
],
"NomeImpresso": "Renato Samuel Augusto Baptista",
"DataValidade": "203008",
"NumeroCartao": "4024007105862618",
"CodigoSeguranca": "1234",
"CardToken": "34c413d1-04bd-4f6a-a966-4d53d9a587d8",
"Valor": 230,
"CartaoFormaPagamento": 0,
"QuantidadeParcelas": 1,
"ClienteDescricao": "Cliente Gold Nivel 25",
"ClienteIP": "127.0.0.1",
"ClienteCPFCNPJ": "48455151480",
"ClienteNome": "Renato Samuel Augusto Baptista",
"ClienteEmail": "renatosamuel@umdominio.com.br",
"ClienteSexo": "M",
"ClienteDDD": "41",
"ClienteNumeroCelular": "999293802",
"ClienteEndereco": "Rua Canadá, 257",
"ClienteComplemento": "",
"ClienteNumero": "22",
"ClienteBairro": "Bacacheri",
"ClienteCidade": "Curitiba",
"ClienteCEP": "82510290",
"ClienteUF": "PR",
"NumeroPedido": "pedido.2026081910",
"Referencia": "2112513",
"PreAutorizar": false,
"AntiFraude": false
}Response
Método executado
Changes
- info
removed the pattern
^(\d)+$from the request property(media type: application/json) - info
removed the pattern
^(\d)+$from the request property(media type: text/json) - info
removed the pattern
^(\d)+$from the request property(media type: application/xml) - info
removed the pattern
^(\d)+$from the request property(media type: text/xml) - info
removed the pattern
^(\d)+$from the request property(media type: application/x-www-form-urlencoded) - info
removed the non-success response with the status
- info