Especificações dos campos que devem ser enviados na requisição.

Campo Tamanho Tipo Presença Descrição
apiKey Até 50 caracteres Texto Obrigatória Campo composto de números, letras, traços e hífen.
Sempre começa por apk_

Exemplo: apk_48040241- OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz

Utilizado para identificar o vendedor
order_id Até 64 caracteres Texto Obrigatória Código de referencia da venda

Define um código para referenciar o pagamento.
Útil para vincular o pagamento a um pedido criado pelo sistema do lojista.
Recomendamos que seja um código único para cada transação.
payer_email Até 255 caracteres Texto Obrigatória e-mail valido do cliente pagador
payer_name Até 255 caracteres Texto Obrigatória Nome ou Razão social do cliente pagador
payer_cpf_cnpj Até 14 caracteres Texto Obrigatória CPF ou CNPJ do pagador

De preferência apenas os números do cpf ou cnpj
payer_phone Até 15 caracteres Numérico Opcional Número de telefone ou celular do cliente
Telefone: (11) 4063-8785
Exemplo: 1140638785
Sempre informar o DDD + Número
payer_street Até 255 caracteres Texto Opcional Endereço do cliente pagador.
Exemplo: Av Brigadeiro Faria Lima
payer_number Até 15 caracteres Numérico Opcional Número do endereço do cliente pagador

Exemplo: 1461
payer_complement Até 200 caracteres Texto Opcional Complemento do endereço do cliente pagador
Exemplo: Torre Sul 4º Andar
payer_district Até 255 caracteres Texto Opcional Bairro do cliente pagador
Exemplo: Jardim Paulistano
payer_city Até 100 caracteres Texto Opcional Cidade do cliente pagador
Exemplo: São Paulo
payer_state Até 2 caracteres Texto Opcional Estado do cliente pagador
Exemplo: SP
Deve ser representado pela sigla de cada estado
payer_zip_code Até 8 caracteres Numérico Opcional CEP do cliente pagador
Exemplo: 01452002
days_due_date Até 3 caracteres Numérico Obrigatória Dias corridos até o vencimento
Exemplo: 4 O número representa diferença de dias entre a data da requisição e a data de vencimento.
A diferença entre as datas:
Data requisição: 2017-07-01
Data do vencimento: 2017-07-05
days_due_date: 4
Esperado de 0 a 400 dias.

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 [email protected]

type_bank_slip Até 11 caracteres Texto Obrigatória Formato do boleto bancário

esperado significado
boletoA4 Boleto do tamanho
de uma folha A4
boletoCarne Boleto em tamanho
carne, onde é
possível imprimir até
três boletos por folha A4


Comentário: o formato mais popular é o boletoA4
notification_url Até 255 caracteres Texto Opcional URL de retorno automático de dados


Endereço da página onde o PagHiper enviará o POST com as informações da transação. Note que, este campo tem prioridade sobre a url que estiver configurada no painel PagHiper.

Qualquer alteração de status de uma transação, será está url que iremos notificar através de um post

discount_cents Até 15 caracteres Numérico Opcional Valor total do desconto da compra em centavos


Exemplo, em um desconto aplicado de R$ 11,58 reais, por exemplo, deve ser informado: 1158 (total de centavos).

Se o desconto for aplicado em porcentagem, a sua aplicação deverá realizar o cálculo e nos informar apenas o valor já calculado em centavos.

shipping_price_cents Até 15 caracteres Numérico Opcional Valor total do frete em centavos

Exemplo: o frete custa R$ 15,99, deve ser informado: 1599 (total em centavos)

shipping_methods Até 45 caracteres Texto Opcional Método de entrega

Exemplo: SEDEX, SEDEX10, PAC, TRANSPORTADORA, MOTOBOY, RETIRADA NO LOCAL, etc.

partners_id Até 15 caracteres Texto Opcional Id do parceiro

Útil apenas para integração de plataformas parceiras. Na maioria dos casos, esse campo deve ser ignorado.

number_ntfiscal Até 15 caracteres Numérico Opcional Número da nota fiscal

Se informado 123456, 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 Até 5 caracteres Booleano Opcional Frase fixa
Frase pré-configurada no painel do PagHiper, esta frase passa por uma pré análise antes de ser exibida nos boletos.
esperado significado
true Exibira a frase na caixa de descrição do boleto
false Nenhuma frase pré-configurada


seller_description Até 85 caracteres Texto Opcional Frase variável do vendedor

Texto que ira variar de acordo com cada boleto em específico, podendo colocar informações que remetam ao pedido/ serviço adquirido pelo cliente.

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.

A frase será exibida no seguinte formato: “Texto do vendedor: (conteúdo da frase variável aqui)”

Obs.: A informação “Texto do vendedor” é permanente, não sendo retirada ao acrescentar uma frase variável no boleto.

Tamanho máximo de 85 caracteres.

late_payment_fine Até 2 caracteres Numérico Opcional Percentual da multa

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

Exemplo:

multa de 2% deve ser enviado o valor: 2

Qualquer valor acima do máximo autorizado será levado em consideração 2% = 2

Observações: A utilização deste parâmetro implica na dilatação no tempo de cancelamento do boleto, passando a ser de 30 dias após o seu vencimento. Utilize o parâmetro " open_after_day_due " para personalizar esse tempo

Aceito apenas números inteiros: 1 e 2

per_day_interest Booleano Opcional Juros por atraso
Aplicar 1% de juros máximo ao mês, esse percentual será cobrado proporcionalmente aos dias de atraso.

Dividindo 1% por 30 dias = 0,033% por dia de atraso.

esperado significado
true Aplicará o juros de 1% ao mês por atraso.
false Nenhum juro será aplicado.


Observações: A utilização deste parâmetro implica na dilatação no tempo de cancelamento do boleto, passando a ser de 30 dias após o seu vencimento. Utilize o parâmetro " open_after_day_due " para personalizar esse tempo

early_payment_discounts_days Até 3 caracteres Numérico Opcional Número de dias em que o pagamento pode ser realizado com antecedência recebendo o desconto extra.

Exemplo: 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.

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 Até 15 caracteres Numérico Opcional Valor do desconto em centavos que será aplicado caso o pagamento ocorra de forma antecipada.

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.

Neste caso, o valor a ser enviado será o número 500, valor em centavos, que representará o desconto extra pelo pagamento antecipado.

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 Até 2 caracteres Numérico Opcional Número máximo de dias em que o boleto poderá ser pago após o vencimento. (Prática comum para quem opta por cobrar juros e multas).

Neste campo será aceito, qualquer número maior ou igual a 5, e menor ou igual a 30.

Exemplo:
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.”

Recomendamos o uso deste campo apenas se existir o interesse em permitir que o pagador realize o pagamento fora do prazo de vencimento. É útil para se trabalhar em conjunto com a aplicação de juros e multas.

Detalhes de items(array)
Item_id Até 64 caracteres Texto Obrigatória 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 Até 255 caracteres Texto Obrigatória Descrição do item

Útil para identificar o nome do produto ou serviço.

quantity Até 15 caracteres Numérico Obrigatória 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 Até 15 caracteres Numérico Obrigatória 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)