| 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 |
||||||||||||||
| transaction_id | 16 | Texto | Toda transação possui o transaction_id, ele é utilizado para identificar a transação em questão. |
||||||||||||||
| order_id | Até 64 caracteres | Texto | Código de referência da venda Esse código foi atribuído pelo vendedor no momento da requisição. |
||||||||||||||
| created_date | Datetime | Data em que a transação foi criada Exemplo esperado: 2017-07-14 21:21:02 |
|||||||||||||||
| paid_date | Datetime | Data em que a transação foi Aprovada Exemplo esperado: 2017-07-14 21:21:02 |
status_date | Datetime | Data em que o status foi atualizado Exemplo esperado: 2017-07-14 21:21:02 |
||||||||||||
| status | Até 16 caracteres | Texto |
Retorna o status da transação no momento em que a notificação foi gerada.
|
||||||||||||||
| payer_email | Até 255 caracteres | Texto | e-mail do cliente pagador | ||||||||||||||
| payer_name | Até 255 caracteres | Texto | Nome ou Razão social do cliente pagador | ||||||||||||||
| payer_cpf_cnpj | Até 14 caracteres | Texto | CPF ou CNPJ do pagador apenas os números do cpf ou cnpj |
||||||||||||||
| payer_phone | Até 15 caracteres | Numérico | Número de telefone ou celular do cliente Exemplo: 1140638785 |
||||||||||||||
| payer_street | Até 255 caracteres | Texto | Endereço do cliente pagador. Exemplo: Av Brigadeiro Faria Lima |
||||||||||||||
| payer_number | Até 15 caracteres | Texto | Número do endereço do cliente pagador Exemplo: 1461 Caso não seja enviado um numero valido, sera retornado a string "S/N" |
||||||||||||||
| payer_complement | Até 200 caracteres | Texto | Complemento do endereço do cliente pagador Exemplo: Torre Sul 4º Andar |
||||||||||||||
| payer_district | Até 255 caracteres | Texto | Bairro do cliente pagador Exemplo: Jardim Paulistano |
||||||||||||||
| payer_city | Até 100 caracteres | Texto | Cidade do cliente pagador Exemplo: São Paulo |
||||||||||||||
| payer_state | Até 2 caracteres | Texto | Estado do cliente pagador Exemplo: SP Deve ser representado pela sigla de cada estado |
||||||||||||||
| payer_zip_code | Até 8 caracteres | Numérico | CEP do cliente pagador Exemplo: 01452002 |
||||||||||||||
| 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_fee_cents | Até 15 caracteres | Numérico | Tarifa da transação em centavos R$ 2,79 será representado por: 279 |
||||||||||||||
| 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. |
||||||||||||||
| discount_cents | Até 15 caracteres | Numérico | Desconto total aplicado ao título em centavos R$ 9,99 será representado por: 999 |
||||||||||||||
| shipping_price_cents | Até 15 caracteres | Numérico | Valor do frete em centavos R$ 19,50 será representado por: 1950 |
||||||||||||||
| num_cart_items | Numérico | Quantidade de itens enviados no momento da requisição de emissão do título. |
|||||||||||||||
| Detalhes de items | |||||||||||||||||
| item_id | Até 64 caracteres | Texto | Código do item Útil para identificar, por exemplo, o código do produto. |
||||||||||||||
| description | Até 255 caracteres | Texto | Descrição do item Útil para identificar o nome do produto ou serviço |
||||||||||||||
| quantity | Até 15 caracteres | Numérico | Quantidade do item Define a quantidade de cada item. |
||||||||||||||
| price_cents | Até 15 caracteres | Numérico | 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, será informado: 190195 (total em centavos) |
||||||||||||||
| 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 b01c84cd0f7499e31/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 b01c84cd0f7499e31/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 |
||||||||||||||
Referência API PagHiper