Emissão de boleto bancário PAGHIPER

post

https://api.paghiper.com/transaction/create/

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

apiKey

string

required

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

string

required

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

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

int32

Número de telefone ou celular do cliente Exemplo: 1140638785 Sempre informar o DDD + Número

payer_street

string

Endereço do cliente pagador.

Exemplo: Av Brigadeiro Faria Lima

payer_number

int32

Número do endereço do cliente pagador

Exemplo: 1461

payer_complement

string

Complemento do endereço do cliente pagador

Exemplo: Torre Sul 4º Andar

payer_district

string

Bairro do cliente pagador

Exemplo: Jardim Paulistano

payer_city

string

Cidade do cliente pagador

Exemplo: São Paulo

payer_state

string

Estado do cliente pagador

Exemplo: SP Deve ser representado pela sigla de cada estado

payer_zip_code

int32

CEP do cliente pagador

Exemplo: 01452002

days_due_date

int32

required

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

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

string

required

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

string

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

int32

Valor total do desconto da compra em centavos

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

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

int32

Valor total do frete em centavos

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

shipping_methods

string

Método de entrega

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

partners_id

string

Id do parceiro

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

number_ntfiscal

int32

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

boolean

Frase fixa

Frase pré-configurada no painel do PagHiper,
esta frase passa por uma pré analise 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

string

Frase variável do vendedor

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.

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

int32

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

Aceito apenas números inteiros: 1 e 2

per_day_interest

boolean

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.

early_payment_discounts_days

int32

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

int32

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

int32

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. Ele é útil para se trabalhar em conjunto com a aplicação de juros e multas.

items

array of objects

required

items*

Responses

201201

400400