---
title: "Emissão de boleto bancário PAGHIPER"
method: POST
path: "/transaction/create/"
---

# Emissão de boleto bancário PAGHIPER

`POST /transaction/create/`

## Request body

- object
  - `apiKey` string, required — Campo composto de números, letras, traços e hífen.<br>Sempre começa por <strong>apk_</strong><br><br> Exemplo: apk_48040241-OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz<br> <br> Utilizado para identificar o vendedor
  - `order_id` string, required — <strong>Código de referencia da venda</strong><br><br>Define um código para referenciar o pagamento.<br>Útil para vincular o pagamento a um pedido criado pelo sistema do lojista.<br><br>Recomendamos que seja um código único para cada transação.
  - `payer_email` string, required — e-mail valido do cliente pagador
  - `payer_name` string, required — Nome ou Razão social do cliente pagador
  - `payer_cpf_cnpj` string, required — CPF ou CNPJ do pagador de preferencia apenas os números do cpf ou cnpj
  - `payer_phone` integer — Número de telefone ou celular do cliente Exemplo: 1140638785 Sempre informar o DDD + Número
  - `payer_street` string — <strong>Endereço</strong> do cliente pagador.<br><br>Exemplo: Av Brigadeiro Faria Lima
  - `payer_number` integer — <strong>Número do endereço</strong> do cliente pagador<br><br>Exemplo: 1461
  - `payer_complement` string — <strong>Complemento do endereço</strong> do cliente pagador<br><br>Exemplo: Torre Sul 4º Andar
  - `payer_district` string — <strong>Bairro do cliente</strong> pagador<br><br>Exemplo: Jardim Paulistano
  - `payer_city` string — <strong>Cidade</strong> do cliente pagador<br><br>Exemplo: São Paulo
  - `payer_state` string — <strong>Estado</strong> do cliente pagador<br><br>Exemplo: SP Deve ser representado pela sigla de cada estado
  - `payer_zip_code` integer — <strong>CEP</strong> do cliente pagador<br><br>Exemplo: 01452002
  - `days_due_date` integer, required — <strong>Dias corridos até o vencimento<br><br>Exemplo: 4</strong><br>O número representa diferença de dias entre a data da requisição e a data de vencimento.<br><br>A diferença entre as datas:<br>Data requisição: 2017-07-01<br>Data do vencimento: 2017-07-05<br><br>days_due_date: 4<br><br> Por padrão o valor maximo é de 400 dias, caso necessite emitir boleto com prazo superior a 400 dias entre em contato através do e-mail suporte@paghiper.com
  - `type_bank_slip` string, required — <strong>Formato do boleto bancário</strong><br><br> <table class="especificacoesmini"> <thead> <tr> <th>esperado</th> <th>significado</th> </tr> </thead> <tbody> <tr> <td>boletoA4</td> <td>Boleto do tamanho<br>de uma folha A4 </td> </tr> <tr> <td>boletoCarne</td> <td>Boleto em tamanho<br>carne, onde é<br>possível imprimir até<br>três boletos por folha A4</td> </tr> </tbody> </table> <br><br>Comentário: o formato mais popular é o boletoA4
  - `notification_url` string — <strong>URL de retorno automático de dados</strong><br>Endereço da página onde o PagHiper enviará o POST com as informações da transação. <br>Note que, este campo tem prioridade sobre a url que estiver configurada no painel PagHiper.<br><br>Qualquer alteração de status de uma transação, será está url que iremos notificar através de um post
  - `discount_cents` integer — <strong>Valor total do desconto da compra em centavos</strong><br><br>Exemplo, em um desconto aplicado de R$ 11,58 reais, deve ser informado: 1158 (total de centavos).<br><br>Se o desconto for aplicado em porcentagem, a sua aplicação deverá realizar o calculo e nos informar apenas o valor já calculado em centavos.
  - `shipping_price_cents` integer — <strong>Valor total do frete em centavos</strong><br><br>Exemplo: o frete custa R$ 15,99, deve ser informado: 1599 (total em centavos)
  - `shipping_methods` string — <strong>Método de entrega</strong><br><br>Exemplo: SEDEX, SEDEX10, PAC, TRANSPORTADORA, MOTOBOY, RETIRADA NO LOCAL, etc.
  - `partners_id` string — <strong>Id do parceiro</strong><br><br>Útil apenas para integração de plataformas parceiras. Na maioria dos casos, esse campo deve ser ignorado.
  - `number_ntfiscal` integer — <strong>Número da nota fiscal</strong> Se informado <strong>123456</strong>, exibira o número da nota fiscal no boleto bancário na caixa de descrição da seguinte forma: “Referente a nota fiscal número: 123456”
  - `fixed_description` boolean — <strong>Frase fixa</strong><br><br>Frase pré-configurada no painel do PagHiper,<br> esta frase passa por uma pré analise antes de ser exibida nos boletos.<br><br><table class="especificacoesmini"> <thead> <tr> <th>esperado</th> <th>significado</th> </tr> </thead> <tbody> <tr> <td>true</td> <td>Exibira a frase na caixa de descrição do boleto</td> </tr> <tr> <td>false</td> <td>Nenhuma frase pré-configurada</td> </tr> </tbody> </table>
  - `seller_description` string — <strong>Frase variável do vendedor</strong><br><br> Texto que irá variar de acordo com cada boleto em específico, podendo colocar informações que remetam ao pedido/ serviço adquirido pelo cliente.<br><br> A frase variável será exibida no corpo do boleto bancário, no campo onde traz informações sobre os prazos de pagamento do boleto.<br><br> A frase será exibida no seguinte formato: “<strong>Texto do vendedor</strong>: (conteúdo da frase variável aqui)”<br><br> Obs.: A informação “<strong>Texto do vendedor</strong>” é permanente, não sendo retirada ao acrescentar uma frase variável no boleto.<br><br> Tamanho máximo de 85 caracteres.<br> <br>
  - `late_payment_fine` integer — <strong>Percentual da multa</strong><br><br> O percentual máximo autorizado é de 2%, de acordo artigo 52, parágrafo primeiro do Código de Defesa do Consumidor, Lei 8.078/90<br><br> Exemplo:<br><br> multa de 2% deve ser enviado o valor: 2<br><br> Qualquer valor acima do máximo autorizado será levado em consideração 2% = 2<br><br> Aceito apenas números inteiros: 1 e 2
  - `per_day_interest` boolean — <strong>Juros por atraso</strong> <br />Aplicar 1% de juros máximo ao mês, esse percentual será cobrado proporcionalmente aos dias de atraso.<br><br> Dividindo 1% por 30 dias = 0,033% por dia de atraso.<br><br> <table class="especificacoesmini"> <thead> <tr> <th>esperado</th> <th>significado</th> </tr> </thead> <tbody> <tr> <td>true</td> <td>Aplicará o juros de 1% ao mês por atraso.</td> </tr> <tr> <td>false</td> <td>Nenhum juro será aplicado.</td> </tr> </tbody> </table>
  - `early_payment_discounts_days` integer — Número de dias em que o pagamento pode ser realizado com antecedência recebendo o desconto extra.<br><br> <strong>Exemplo:</strong> O valor do boleto é R$ 100,00 e será concedido um desconto extra caso o pagador realize o pagamento com até 5 dias antes da data do vencimento. Neste caso deve ser enviado o número 5 simbolizando o número máximo de dias de antecedência.<br><br>Nota: Este campo não pode ser utilizado, se o valor informado ser maior que o valor do campo days_due_date (vencimento).
  - `early_payment_discounts_cents` integer — Valor do desconto em centavos que será aplicado caso o pagamento ocorra de forma antecipada.<br><br> Exemplo: O valor do boleto é R$100,00, porem, caso seja pago com antecedência mínima de 5 dias antes da data do vencimento, será concedido um desconto extra de R$5,00.<br><br> Neste caso, o valor a ser enviado será o número 500, valor em centavos, que representará o desconto extra pelo pagamento antecipado.<br><br> Se o desconto extra pelo pagamento antecipado for aplicado em porcentagem, a sua aplicação deverá realizar o cálculo e nos informar apenas o valor já calculado em centavos.
  - `open_after_day_due` integer — Número máximo de dias em que o boleto poderá ser pago <strong>após o vencimento</strong>. (Prática comum para quem opta por cobrar juros e multas).<br><br> Neste campo será aceito, qualquer número maior ou igual a 5, e menor ou igual a 30.<br><br> Exemplo:<br> Se optar em receber após o vencimento por até 15 dias, deverá ser enviado o número 15, e a frase será exibida no boleto da seguinte forma: “Não receber após 15 dias do vencimento.”<br><br> Recomendamos o uso deste campo apenas se existir o interesse em permitir que o pagador realize o pagamento fora do prazo de vencimento. Ele é útil para se trabalhar em conjunto com a aplicação de juros e multas.<br><br>
  - `items` object[], required
    - `item_id` string, required — Código do item Útil para identificar, por exemplo, o código do produto. Caso não deseje utilizar esse campo, enviar o número: 1
    - `description` string, required — Descrição do item Útil para identificar o nome do produto ou serviço.
    - `quantity` integer, required — Quantidade do item Define a quantidade de cada item. Utilizado para calcular o valor total da transação. deve ser enviado numero inteiro igual ou maior que 1
    - `price_cents` integer, required — Valor unitário do item em centavos Define o valor unitário de cada item. Exemplo: Determinado item tem o preço definido em R$ 1.901,95, deverá ser informado: 190195 (total em centavos)

## Response `201`

201

- object
  - `create_request` object
    - `result` string
    - `response_message` string
    - `transaction_id` string
    - `created_date` string
    - `value_cents` string
    - `status` string
    - `order_id` string
    - `due_date` string
    - `bank_slip` object
      - `digitable_line` string
      - `url_slip` string
      - `url_slip_pdf` string
      - `bar_code_number_to_image` string
    - `http_code` string

## Other responses

- `400` — 400

---

[API](https://skmtc.dev/paghiper/apis/boleto.md) · [All operations](https://skmtc.dev/paghiper/apis/boleto/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/paghiper/boleto/revisions/60dae71171d5/schema)