Documentação das APIs

Cria uma transação com suporte a pagamento via cartao, boleto ou pix.

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

CampoTipoDescrição
BoletoValorNumérico com 2 decimaisValor da compra à ser pago via boleto
BoletoDataVencimentoDataData de vencimento do boleto
BoletoURLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado final.
BoletoJurosNumérico com 2 decimaisPercentual de juros
BoletoMultaNumérico com 2 decimaisValor de multa
CartaoNomeImpressoTextoNome do cliente impresso no cartão.
CartaoDataValidadeAno/Mês no formato AAAAMMData de validade do cartão.
CartaoNumeroCartaoNumérico de 16 posiçõesNúmero do cartão.
CartaoCodigoSegurancaNumérico de 3 posiçõesCódigo de segurança no verso do cartão.
CartaoCardTokenGuidO token do cartão para transações de recorrência
CartaoValorNumérico com 2 decimaisValor da compra à ser pago via boleto
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
CartaoQuantidadeParcelasNumé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.
PixTipoTextoInformar E = Estático
PixValorNumérico com 2 decimaisValor da compra à ser pago via boleto
PixSegundosExpiracaoNuméricoTempo de validade do pagamento via Pix, em segundos, sendo aceitos valores de 300 (5 minutos) até 2592000 (30 dias).
PixDataVencimentoDataSomente para PIX estático, uma data de vencimento deve ser informada
PixURLConfirmacaoTextoURL de confirmação do comércio para indicar que o pagamento está em estado final.
ClienteDescricaoTextoDescrição da compra.
ClienteIPTextoIP do cliente final da transação.
ClienteCPFCNPJTextoCPF/CNPJ do cliente final da transação.
ClienteNomeTextoNome do cliente final da transação.
ClienteEMailTextoE-Mail do cliente final da transação (opcional).
ClienteEnderecoTextoEndereço do cliente final da transação (opcional).
ClienteBairroTextoBairro do cliente final da transação (opcional).
ClienteCidadeTextoCidade do cliente final da transação (opcional).
ClienteCEPTextoCEP do cliente final da transação (opcional).
ClienteUFTextoUF do cliente final da transação (opcional).
ClienteDDDTextoDDD do telefone do cliente final da transação (opcional).
ClienteNumeroCelularTextoNúmero do telefone do cliente final da transação (opcional).
NumeroPedidoTextoNúmero do pedido para controles internos

Resposta

CampoTipoDescrição
RetornoTextoRetorno da chamada, podendo possuir os valores OK ou ERRO.
DetalhesErroTextoDetalhes do erro gerado, caso o retorno seja ERRO.
OrigemErroTextoIdentifica qual das formas de pagamento gerou erros (Boleto, Cartão ou PIX).
BoletoNossoNumeroTextoNosso Número do Boleto Gerado
BoletoLinhaDigitavelTextoLinha digitável do boleto gerado.
BoletoPDFTextoPDF do boleto codificado em texto formato Base64.
BoletoIdentificadorTextoId do boleto gerado.
CartaoCodigoAutorizacaoTextoCódigo de autorização da transação.
CartaoNsuOperacaoTextoCódigo de NSU da transação.
CartaoIdentificadorTextoId do cartão gerado.
PixQRCodeTextoTextoTexto do QRCode para realizar o pagamento via Pix.
PixQRCodeImagemTextoURL que gera a imagem do QRCode relacionado a transação.
PixIdentificadorTextoId do pix gerado.
Language
Authorization
OAuth2
Click Try It! to start a request and see the response here!