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 | Obrigatório |
|---|---|---|---|
| BoletoValor | Numérico com 2 decimais | Valor da compra à ser pago via boleto | Sim |
| BoletoDataVencimento | Data | Data de vencimento do boleto | Não(1) |
| BoletoURLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final | Não |
| TipoMulta | Texto | Tipo da multa a ser aplicada | Não |
| ValorMulta | Número | Valor da multa a ser aplicada | Não |
| TipoJuros | Texto | Tipo do juro a ser aplicado, sendo os valores possíveis: Isento, ValorAoDia ou TaxaMensal | Não |
| ValorJuros | Número | Valor do Juros a ser aplicado | Não |
| CartaoNomeImpresso | Texto | Nome do cliente impresso no cartão | Sim |
| CartaoDataValidade | Ano/Mês no formato AAAAMM | Data de validade do cartão | Sim |
| CartaoNumeroCartao | Numérico de 16 posições | Número do cartão | Sim |
| CartaoCodigoSeguranca | Numérico de 3 posições | Código de segurança no verso do cartão | Sim |
| CartaoCardToken | Guid | O token do cartão para transações de recorrência | Sim |
| CartaoValor | Numérico com 2 decimais | Valor da compra à ser pago via boleto | Sim |
| CartaoFormaPagamento | Numérico Inteiro 1 posição | Forma de pagamento do cartão | Sim |
| 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 | Sim |
| PixTipo | Texto | Informar E = Estático | Sim |
| PixValor | Numérico com 2 decimais | Valor da compra à ser pago via boleto | Sim |
| PixSegundosExpiracao | Numérico | Tempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 (5 minutos) até 2592000 (30 dias) | Sim |
| PixDataVencimento | Data | Somente para PIX estático, uma data de vencimento deve ser informada | Não |
| PixURLConfirmacao | Texto | URL de confirmação do comércio para indicar que o pagamento está em estado final | 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 |
| ClienteEndereco | Texto | Endereço do cliente final da transação | Não(1) |
| ClienteNumero | Texto | Número do endereço do cliente final da compra | Não(1) |
| ClienteBairro | Texto | Bairro do cliente final da transação | Não(1) |
| ClienteCidade | Texto | Cidade do cliente final da transação | Não(1) |
| ClienteComplemento | Texto | Complemento do endereço do cliente final da compra | Não |
| ClienteCEP | Texto | CEP do cliente final da transação | Não(1) |
| ClienteUF | Texto | UF do cliente final da transação | Não(1) |
| ClienteDDD | Texto | DDD do telefone do cliente final da transação | Não |
| ClienteNumeroCelular | Texto | Número do telefone do cliente final da transação | Não |
| ClienteSexo | Texto | Sexo do cliente final da compra, podendo ser M (masculino) ou F (feminino) | Não |
| NumeroPedido | Texto | Número do pedido para controles internos | Não |
| Mensagem2 | Texto | Mensagem orientativa inserida no boleto | Não |
| Mensagem3 | Texto | Mensagem orientativa inserida no boleto | Não |
| Mensagem4 | Texto | Mensagem orientativa inserida no boleto | Não |
| Mensagem5 | Texto | Mensagem orientativa inserida no boleto | Não |
| NumeroDocumento | Texto | Descritivo para localização futura do boleto | Não |
| BoletoDataLimitePagamento | Data | Data limite para o pagamento | Não |
(1) Obrigatório caso a transação para boleto seja executada.
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 |
| 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 |