| Campo | Tamanho | Tipo | Descrição | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| result | Até 8 caracteres | Texto | Campo que identifica se houve êxito na busca e se os parâmetros estão corretos. Esperado: success reject |
||||||||||||||||
| response_message | Até 128 caracteres | Texto | Descreve em detalhes se houver algum erro ou se a transação foi encontrada. verificar item mensagens de retorno |
||||||||||||||||
| order_id | Até 64 caracteres | Texto | Código de referência da venda Código para referenciar o pagamento ou o número do pedido Útil para buscar o pagamento de um pedido criado pelo sistema do lojista, caso o número do pedido tenha vínculo com este parâmetro. |
||||||||||||||||
| status | Até 16 caracteres | Texto |
Retorna o status da transação no momento em que a notificação foi gerada.
|
||||||||||||||||
| status_date | Datetime | Data da ultima alteração de status Exemplo esperado: 2017-07-14 21:21:02 |
|||||||||||||||||
| due_date | DATE | Data do vencimento do boleto Exemplo esperado 2017-07-12 |
|||||||||||||||||
| value_cents | Até 15 caracteres | Numérico | Valor final da transação em centavos, exemplo: R$ 100,00 será representado por: 10000 |
||||||||||||||||
| value_cents_paid | Até 15 caracteres | Numérico | Valor final da transação em centavos, contendo juros e multas, ou desconto de pagamento antecipado exemplo: R$ 100,00 será representado por: 10000 Esse campo só será retornado se a transação estiver com status de paid, ou completed |
||||||||||||||||
| late_payment_fine | Até 2 caracteres | Numérico | 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 Esse campo só será retornado se na requisição do Boleto foi configurado a opção Multa |
||||||||||||||||
| per_day_interest | Booleano | 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. Esse campo só será retornado se na requisição do Boleto foi configurado a opção Juros
|
|||||||||||||||||
| early_payment_discounts_days | Até 3 caracteres | Numérico | 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. Esse campo só será retornado se na requisição do Boleto foi configurado a opção desconto por antecipação |
||||||||||||||||
| early_payment_discounts_cents | Até 15 caracteres | Numérico | 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. Esse campo só será retornado se na requisição do Boleto foi configurado a opção desconto por antecipação |
||||||||||||||||
| open_after_day_due | Até 2 caracteres | Numérico | 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. Esse campo só será retornado se o Boleto foi configurado, para ficar em aberto após o vencimento. |
||||||||||||||||
| Detalhes do bank_slip | |||||||||||||||||||
| digitable_line | Até 60 caracteres | Texto | Linha digitável do boleto bancário Exemplo: 34191.76106 04487.160246 61514.190000 3 72180000002000 |
||||||||||||||||
| url_slip | Até 255 caracteres | Texto | Url onde é possível visualizar o boleto Exemplo: https://www.paghiper.com/checkout/boleto/113 d8222fb24998baa2d48b015fd9de227403a977943ffe5f30f beb5d01c9869aa6451a2b1ec622622cc8c4461b88e16c1d548 b01e3dcf3367/D7VE7WM4T1WZFWEJ/10044871 |
||||||||||||||||
| url_slip_pdf | Até 255 caracteres | Texto | Url onde é possível visualizar o boleto Exemplo: https://www.paghiper.com/checkout/boleto/113 d8222fb24998baa2d48b015fd9de227403a977943ffe5f30f beb5d01c9869aa6451a2b1ec622622cc8c4461b88e16c1d548 b01e3dcf3367/D7VE7WM4T1WZFWEJ/10044871/pdf |
||||||||||||||||
| Detalhes do http cod |
|||||||||||||||||||
| http_code | 3 | Numérico | Consultar item Códigos de Retorno (Status Protocolo HTTP) e Mensagens de Retorno |
||||||||||||||||