---
title: "Cria uma transação de boleto híbrido (pix + boleto)"
method: POST
path: "/api/CriaTransacaoBoletoHibrido"
tags: ["CriaTransacaoBoletoHibrido"]
---

# Cria uma transação de boleto híbrido (pix + boleto)

`POST /api/CriaTransacaoBoletoHibrido`

Este método permite criar uma transação híbrida (boleto + pix), para a função de checkout transparente (implementado dentro do sistema web do comércio) de forma a permitir gerar um PDF contendo um boleto e o pix relacionado, além de receber a linha digitável, nosso número, o contéudo e URL do QRCode associado a transação. Notar que no momento da criação do boleto híbrido, a transação apresentará o estado “Pendente”. O sistema então verificará automaticamente pelo pagamento do referido boleto ou do crédito do pix relacionado, e quanto este ocorrer, invoca a URL de confirmação indicada pelo comércio, para notificar do pagamento, o qual deverá consultar o estado da transação neste momento e realizar a respectiva baixa no seu sistema. Notar que o boleto híbrido é suportado somente pelo provedor Arbi.
<br /> 

O pix gerado nesta modalidade herdará as mesmas características do boleto, ou seja, informações como desconto, multa e juros também estarão presentes no pix no momento do pagamento pelo cliente final do comércio.
<br /> 

### Requisição
| **Campo** | **Tipo** | **Descrição** | **Obrigatório** |
|--|--|--|--| 
| Valor |Numérico com 2 decimais  | Valor da compra | Sim |
| DataVencimento | Data | Data de vencimento do boleto | Sim | 
| URLConfirmacao | 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 | Sim | 
| ClienteBairro | Texto | Bairro do cliente final da transação | Sim |  
| ClienteCidade | Texto | Cidade do cliente final da transação | Sim |  
| ClienteCEP | Texto | CEP do cliente final da transação | Sim |  
| ClienteUF | Texto | UF do cliente final da transação | Sim |  
| 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 |
| NumeroPedido | Texto | Número do pedido para controles internos | Não | 
| NumeroDocumento         | Texto    | Descritivo para localização futura do boleto | Não |
| Referencia              | Texto    | Referência para localização futura da transação | Não |
| DataLimitePagamento | Data | Data limite para pagamento do título.Após esta data, o mesmo é baixado junto a CIP | Não | 
| TipoMulta | Texto | Tipo da multa a ser aplicada | Não | 
| ValorMulta | Numérico | Valor da multa a ser aplicada | Não | 
| TipoJuros | Texto | Tipo dos juros a serem aplicadas | Não | 
| ValorJuros | Numérico | Valor do juros a ser aplicado | Não | 
| TipoDesconto | Texto | Tipo do desconto a ser aplicado | Não | 
| ValorDesconto | Numérico com 2 decimais | Valor do desconto a ser aplicado | Não | 
| DataDesconto            | Texto    | Data do desconto | Não |
| ValorDesconto2          | Numérico com 2 decimais | Valor do desconto a ser aplicado | Não |
| DataDesconto2           | Texto    | Data do desconto | Não |
| ValorDesconto3          | Numérico com 2 decimais | Valor do desconto a ser aplicado | Não |
| DataDesconto3           | Texto    | Data do desconto | 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 |
| RetornarBase64          | Booleano  | Aceita os valores true ou false, informando para retornar PDF do boleto codificado em texto formato Base64 | Não |
| NotaFiscal              | Texto    | Número da nota fiscal |  Não |

### 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 | 
| Identificador | Texto |Identificador da transação | 
| NossoNumero | Texto | Nosso número do boleto gerado | 
| LinhaDigitavel | Texto | Linha digitável do boleto gerado | 
| CodigoBarras | Texto | Código equivalente ao binário do código de barras do boleto gerado | 
| BoletoPDF | Texto | PDF do boleto codificado em texto formato Base64 | 
| QRCodeTexto | Texto | Texto do QRCode para realizar o pagamento via Pix | 
| QRCodeImagem | Texto | URL que gera a imagem do QRCode relacionado a transação |

## Headers

- `Aeskey` string, required

## Request body

- BknBankPagamentosBusinessCriaTransacaoBoletoHibridoRequest
  - `Valor` number, double
  - `DataVencimento` string, date-time
  - `URLConfirmacao` string
  - `ClienteDescricao` string, required
  - `ClienteIP` string
  - `ClienteCPFCNPJ` string, required
  - `ClienteNome` string, required
  - `ClienteEmail` string
  - `ClienteEndereco` string
  - `ClienteBairro` string
  - `ClienteCidade` string
  - `ClienteCEP` string
  - `ClienteUF` string
  - `ClienteDDD` string
  - `ClienteNumeroCelular` string
  - `NumeroPedido` string
  - `NumeroDocumento` string
  - `Referencia` string
  - `DataLimitePagamento` string, date-time
  - `TipoMulta` 'NaoTemMulta' | 'ValorFixo' | 'ValorPercentual'
  - `ValorMulta` number, double
  - `TipoJuros` 'ValorAoDia' | 'TaxaMensal' | 'Isento'
  - `ValorJuros` number, double
  - `TipoDesconto` 'NaoTemDesconto' | 'ValorFixoAteDataInformada' | 'PercentualADataInformada'
  - `ValorDesconto` number, double
  - `DataDesconto` string, date-time
  - `ValorDesconto2` number, double
  - `DataDesconto2` string, date-time
  - `ValorDesconto3` number, double
  - `DataDesconto3` string, date-time
  - `Mensagem2` string
  - `Mensagem3` string
  - `Mensagem4` string
  - `Mensagem5` string
  - `RetornarBase64` boolean
  - `NotaFiscal` string

## Response `200`

Método executado com sucesso

- BknBankPagamentosBusinessCriaTransacaoBoletoHibridoResponse
  - `Retorno` 'OK' | 'ERRO'
  - `DetalhesErro` string
  - `Identificador` string
  - `NossoNumero` string
  - `LinhaDigitavel` string
  - `BoletoPDF` string
  - `QRCodeTexto` string
  - `QRCodeImagem` string
  - `CodigoBarras` string

## Other responses

- `500` — Erro executando método

---

[API](https://skmtc.net/meuk8/apis/k8-fintech.md) · [All operations](https://skmtc.net/meuk8/apis/k8-fintech/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/meuk8/k8-fintech/revisions/14db4977f490/schema)