Este método permite criar uma transação com várias formas de pagamento definidas.
Apenas para esclarecer, esta rota não sobrepõe a rota de criação de transação de boleto híbrida, pois na rota híbrida as formas de pagamento são conectadas (boleto + pix), já nesta rota existe a presença da forma de pagamento cartão de crédito.
Equivale as função de checkout transparente (implementado dentro do sistema web do comércio) de forma a permitir a transação ser paga através de boleto, cartão ou pix. Na prática, uma chamada para esta rota equivale a realizar 3 chamadas separadas (cada qual para sua forma de pagamento) porém com a vantagem de em único endpoint executar o processo.
Importante: como são várias formas de pagamento isoladas sendo criada, cabe ao criador da requisição designar os valores independentes (note que a requisição não possui um valor total), ou seja, se por exemplo desejo criar uma requisição de um total de R$ 500 nas formas de pagamento divido em R$ 100 no cartão, R$ 200 no boleto e R$ 200 no PIX .
Requisição
Campo | Tipo | Descrição |
---|---|---|
BoletoValor | Numérico com 2 decimais | Valor da compra à ser pago via boleto |
BoletoDataVencimento | Data | Data de vencimento do boleto |
BoletoURLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final. |
TipoMulta | Texto | Tipo da multa a ser aplicada, sendo os valores possíveis: NaoTemMulta, ValorFixo ou ValorPercentual. |
ValorMulta | Número | Valor da multa a ser aplicada. |
TipoJuros | Texto | Tipo do juro a ser aplicado, sendo os valores possíveis: Isento, ValorAoDia ou TaxaMensal. |
ValorJuros | Número | Valor do Juros a ser aplicado. |
CartaoNomeImpresso | Texto | Nome do cliente impresso no cartão. |
CartaoDataValidade | Ano/Mês no formato AAAAMM | Data de validade do cartão. |
CartaoNumeroCartao | Numérico de 16 posições | Número do cartão. |
CartaoCodigoSeguranca | Numérico de 3 posições | Código de segurança no verso do cartão. |
CartaoCardToken | Guid | O token do cartão para transações de recorrência |
CartaoValor | Numérico com 2 decimais | Valor da compra à ser pago via boleto |
CartaoFormaPagamento | Numérico Inteiro 1 posição | Forma de pagamento do cartão, sendo possível os valores: 0 = A Vista, 1 = Parcelado sem juros, 2 = Parcelado com juros |
CartaoQuantidadeParcelas | Numérico Inteiro | 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. |
PixTipo | Texto | Informar E = Estático |
PixValor | Numérico com 2 decimais | Valor da compra à ser pago via boleto |
PixSegundosExpiracao | Numérico | Tempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 (5 minutos) até 2592000 (30 dias). |
PixDataVencimento | Data | Somente para PIX estático, uma data de vencimento deve ser informada |
PixURLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final. |
ClienteDescricao | Texto | Descrição da compra. |
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. |
ClienteEMail | Texto | E-Mail do cliente final da transação (opcional). |
ClienteEndereco | Texto | Endereço do cliente final da transação (opcional). |
ClienteNumero | Texto | Número do endereço do cliente final da compra |
ClienteBairro | Texto | Bairro do cliente final da transação (opcional). |
ClienteCidade | Texto | Cidade do cliente final da transação (opcional). |
ClienteComplemento | Texto | Complemento do endereço do cliente final da compra |
ClienteCEP | Texto | CEP do cliente final da transação (opcional). |
ClienteUF | Texto | UF do cliente final da transação (opcional). |
ClienteDDD | Texto | DDD do telefone do cliente final da transação (opcional). |
ClienteNumeroCelular | Texto | Número do telefone do cliente final da transação (opcional). |
ClienteSexo | Texto | Sexo do cliente final da compra, podendo ser M (masculino) ou F (feminino) |
NumeroPedido | Texto | Número do pedido para controles internos |
Mensagem2 | Texto | Mensagem orientativa inserida no boleto (opcional). |
Mensagem3 | Texto | Mensagem orientativa inserida no boleto(opcional). |
Mensagem4 | Texto | Mensagem orientativa inserida no boleto(opcional). |
Mensagem5 | Texto | Mensagem orientativa inserida no boleto(opcional). |
NumeroDocumento | Texto | Descritivo para localização futura do boleto. |
BoletoDataLimitePagamento | Data | Data limite para o pagamento. |
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. |
OrigemErro | Texto | Identifica qual das formas de pagamento gerou erros (Boleto, Cartão ou PIX). |
BoletoNossoNumero | Texto | Nosso Número do Boleto Gerado |
BoletoLinhaDigitavel | Texto | Linha digitável do boleto gerado. |
BoletoPDF | Texto | PDF do boleto codificado em texto formato Base64. |
BoletoIdentificador | Texto | Id do boleto gerado. |
BoletoCodigoBarras | Texto | Código equivalente ao binário do código de barras do boleto gerado |
CartaoNumeroAutorizacao | Texto | Número de autorização da transação. |
CartaoAdquirente | Texto | Adquirente responsável pelo processamento da transação. |
Bandeira | Texto | Bandeira do cartão, podendo ser: Diners, MasterCard, Visa, Outros, AmericanExpress, HiperCard, Aura, Elo. |
CartaoCodigoAutorizacao | Texto | Código de autorização da transação. |
CartaoNsuOperacao | Texto | Código de NSU da transação. |
CartaoIdentificador | Texto | Id do cartão gerado. |
PixQRCodeTexto | Texto | Texto do QRCode para realizar o pagamento via Pix. |
PixQRCodeImagem | Texto | URL que gera a imagem do QRCode relacionado a transação. |
PixIdentificador | Texto | Id do pix gerado. |