Documentação PAGHIPER

Documentação Paghiper

Bem-vindo ao centro de desenvolvimento PAGHIPER.
Você encontrará guias e documentação abrangentes para ajudá-lo a começar a trabalhar com a PAGHIPER o mais rápido possível, além de oferecer apoio se você tiver duvidas. Vamos la !

Get Started
 

Permitir ao lojista ou integradores de meios de pagamento configurar sua loja virtual para utilizar o Boleto Bancário PAGHIPER.

Recursos
Os recursos disponibilizados por esta plataforma são:
  • Emissão de boleto bancário PAGHIPER
  • Cancelamento de boleto bancário
  • Consulta de status do boleto
  • Notificações automáticas de status (Retorno automático)
  • Solicitação de saque via API
  • Lista contas bancárias para saque via API
  • Listagem de todas as transações através de filtros aplicáveis via API
  • Lista de notas fiscais emitidas pela PAGHIPER

Suggest Edits

Pré-Requisitos e negócio

 

Somente lojas ou integradores de meios de pagamento cadastrados, ativos, conta pré-verificada ou verificada, com o Boleto Bancário habilitado e devidamente configurado poderão realizar transações.

Para verificar as credencias: https://www.paghiper.com/painel/credenciais/

Suggest Edits

Pré-Requisitos técnicos

 

A PAGHIPER fornece uma API responsável por disponibilizar um conjunto de operações para utilização dos meios de pagamento. Para utilizar tais recursos, são necessários conhecimentos específicos, sendo estes:

    a) Conhecimentos básicos em uma linguagem de programação web.
        Por exemplo: ASP.NET, PHP, JAVA entre outras.
    b) Conhecimentos básicos de serviços do tipo REST e troca de mensagens no padrão JSON.

Suggest Edits

Participantes

 
Autor Descrição
Loja/Integrador Responsável por gerar o boleto
Comprador Quem irá visualizar o boleto
Suggest Edits

Como o boleto é gerado

 

O processo é composto por duas etapas:


A primeira etapa a loja se comunica com a plataforma PAGHIPER. A loja envia uma requisição contendo os dados do boleto, logo em seguida se todos os dados estiverem válidos, a plataforma PAGHIPER retorna os dados do boleto gerado, incluindo a url de acesso ao boleto.


Na segunda etapa, depois de obtida a url de acesso ao título, a loja direciona o comprador para a url informada, de modo que ele possa ver o boleto em seu navegador.

Suggest Edits

Emissão de boleto bancário PAGHIPER

 
posthttps://api.paghiper.com/transaction/create/
curl --request POST \
  --url https://api.paghiper.com/transaction/create/
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.paghiper.com/transaction/create/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.paghiper.com/transaction/create/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.paghiper.com/transaction/create/");

xhr.send(data);
import requests

url = "https://api.paghiper.com/transaction/create/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

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 preferente apenas os números do cpf ou cnpj

payer_phone
int32

Número de telefone ou celular do cliente Telefone: (11) 4063-8785 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

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, por exemplo, 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

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á levedo 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.

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
item_id
description
quantity
price_cents
 
<?php
$data = array(
  'apiKey' => 'apk_12345678-OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz',
  'order_id' => '96874', // código interno do lojista para identificar a transacao.
  'payer_email' => 'poulsilva@myexemple.com',
  'payer_name' => 'poul silva', // nome completo ou razao social
  'payer_cpf_cnpj' => '00000000191', // cpf ou cnpj
  'payer_phone' => '1140638785', // fixou ou móvel
  'payer_street' => 'Av Brigadeiro Faria Lima',
  'payer_number' => '1461',
  'payer_complement' => 'Torre Sul 4º Andar',
  'payer_district' => 'Jardim Paulistano',
  'payer_city' => 'São Paulo',
  'payer_state' => 'SP', // apenas sigla do estado
  'payer_zip_code' => '01452002',
  'notification_url' => 'https://mysite.com/notification/paghiper/',
  'discount_cents' => '1100', // em centavos
  'shipping_price_cents' => '2595', // em centavos
  'shipping_methods' => 'PAC',
  'fixed_description' => true,
  'type_bank_slip' => 'boletoA4', // formato do boleto
  'days_due_date' => '5', // dias para vencimento do boleto
  'late_payment_fine' => '2',// Percentual de multa após vencimento.
  'per_day_interest' => true, // Juros após vencimento.
  'items' => array(
      array ('description' => 'piscina de bolinha',
      'quantity' => '1',
'item_id' => '1',
'price_cents' => '1012'), // em centavos
array ('description' => 'pula pula',
'quantity' => '2',
'item_id' => '1',
'price_cents' => '2000'), // em centavos
array ('description' => 'mala de viagem',
'quantity' => '3',
'item_id' => '1',
'price_cents' => '4000'), // em centavos
),
);
$data_post = json_encode( $data );
$url = "http://api.paghiper.com/transaction/create/";
$mediaType = "application/json"; // formato da requisição
$charSet = "UTF-8";
$headers = array();
$headers[] = "Accept: ".$mediaType;
$headers[] = "Accept-Charset: ".$charSet;
$headers[] = "Accept-Encoding: ".$mediaType;
$headers[] = "Content-Type: ".$mediaType.";charset=".$charSet;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_post);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$result = curl_exec($ch);
$json = json_decode($result, true);
// captura o http code
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if($httpCode == 201):
// CÓDIGO 201 SIGNIFICA QUE O BOLETO FOI GERADO COM SUCESSO
echo $result;
// Exemplo de como capturar a resposta json
$transaction_id = $json['create_request']['transaction_id'];
$url_slip = $json['create_request']['bank_slip']['url_slip'];
$digitable_line = $json['create_request']['bank_slip']['digitable_line'];
else:
echo $result;
endif;
?>
Suggest Edits

Requisição para criação de boleto bancário

 

Para emissão de boleto, é necessário estar com a conta pré-verificada ou verificada. Para consultar sua conta acesse

https://www.paghiper.com/painel/detalhes-da-conta/

Modelo de comunicação entre a loja e PAGHIPER

Endpoint
https://api.paghiper.com/transaction/create/
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para utilizar o endpoint será necessário possuir credencias apiKey e token.
Esses dados estão disponíveis no painel de credenciais no PagHiper.

Pagina de credenciais: https://www.paghiper.com/painel/credenciais/
Tipo de Conteúdo (JSON)
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Importante: Este procedimento é explicado em detalhes no item: 11.
Configurando o Formato das Mensagens.
 
{
 "apiKey":"apk_48040241-OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz",
 "order_id":"32330335", "payer_email":"poulsilva@exemple.com",
 "payer_name":"Poul Silva",
 "payer_cpf_cnpj":"00000000191",
 "payer_phone":"1140638785",
 "payer_street":"Av Brigadeiro Faria Lima",
 "payer_number":"1461",
 "payer_complement":"Torre Sul 4º Andar",
 "payer_district":"Jardim Paulistano",
 "payer_city":"São Paulo", "payer_state":"SP",
 "payer_zip_code":"01452002",
 "notification_url":"https://mysite.com/notify/paghiper/",
 "discount_cents":"1100",
 "shipping_price_cents":"2595",
 "shipping_methods":"PAC",
 "fixed_description":true,
 "days_due_date":"5",
 "type_bank_slip":"boletoA4",
   "items":[{
             "description":"piscina de bolinha",
             "quantity":"1", "item_id":"1",
             "price_cents":"1012"
            },
            {
             "description":"pula pula",
             "quantity":"2", "item_id":"1",
             "price_cents":"2000"
            },
            {
             "description":"mala de viagem",
             "quantity":"3",
             "item_id":"1",
             "price_cents":"4000"
            }]
 }
{
"create_request":
 {
  "result":"success",
  "response_message":"transacao criada",
  "transaction_id":"HF97T5SH2ZQNLF6Z",
  "created_date":"2017-07-20 20:46:57",
  "value_cents":"18507",
  "status":"pending",
  "order_id":"32330335",
  "due_date":"2017-07-27",
  "bank_slip":{
      "digitable_line":"34191.76304 03906.270248 61514.190000 9 72330000017012",
      "url_slip":"https://www.paghiper.com/checkout/boleto/180068c7/HF97T5SH2ZQNLF6Z/30039",
      "url_slip_pdf":"https://www.paghiper.com/checkout/boleto/180068c7/HF97T5SH2ZQNLF6Z/30039/pdf"
              },
  "http_code":"201"
 }
}
Suggest Edits

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


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á levedo em consideração 2% = 2

Aceito apenas números inteiros: 1 e 2

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.

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


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.

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

Detalhes de items
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.

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)

Suggest Edits

Especificações dos campos da mensagem de resposta

 
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 Código único atribuído pela PAGHIPER.
Toda transação possui o transaction_id, ele é utilizado para identificar a transação em questão.

created_date   Datetime Data em que a transação foi criada

Exemplo esperado:
2017-07-14 21:21:02

value_cents  Até 15 caracteres Numérico Valor final da transação em centavos, exemplo:

R$ 100,00 será representado por: 10000

status Até 16 caracteres Texto

Retorna o status da transação no momento em que a notificação foi gerada.

Esperado:

status significado
pending aguardando
canceled cancelado
completed completo
paid aprovado
processing analise
refunded estornado
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.


due_date   DATE Data do vencimento do boleto

Exemplo esperado
2017-07-12

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 b01e3dcf3367c84cd0f7499e31/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 b01e3dcf3367c84cd0f7499e31/D7VE7WM4T1WZFWEJ/10044871/pdf

Detalhes do http cod
http_cod 3 Numérico Consultar item Códigos de Retorno (Status Protocolo HTTP) e Mensagens de Retorno

Suggest Edits

Modelo de comunicação entre o comprador e PAGHIPER

 

A partir do momento em que o Boleto foi gerado, dentre as informações retornadas para loja, encontra-se a URL de acesso ao boleto (url_slip). A loja então precisa direcionar o navegador do comprador para esta URL ou disponibilizá-la por meio de um link em seu ambiente.

Ao acessar a URL o comprador poderá visualizar o Boleto.

Suggest Edits

Códigos de Retorno (Status protocolo HTTP)

 
Protocolo HTTP



Descrição Código Mensagem
Requisição recebida, porém, não pode ser consultada devido as regras de negócio aplicada.
Verificar o item: Mensagens de Retorno
200 Ok
Transação Criada 201 Success
Conteúdo da mensagem vazio ou mal formatado 400 BAD_REQUEST
Credenciais para acessar o endpoint estão incorretas 401 UNAUTHORIZED
Credenciais para acessar o endpoint estão incorretas 405 UNAUTHORIZED
Tipo de conteúdo da mensagem não suportado
Valores válidos: application/json
415 Unsupported Media Type
Suggest Edits

Mensagens de Retorno

 
Response_message Result HTTP
Code
apiKey não informada ou invalida reject 200
payer_email invalido reject 200
payer_cpf_cnpj invalido reject 200
payer_name invalido reject 200
days_due_date invalido reject 200
type_bank_slip invalido reject 200
notification_url invalido reject 200
order_id invalido reject 200
items invalidos reject 200
Existem dados relacionados a Loja ou aos Items que nao foram preenchidos reject 200
Existem dados relacionados aos Items que nao foram preenchidos reject 200
O valor do boleto excede o limite máximo por boleto do comércio. Para aumentar o limite, entre em contato com o PAGHIPER. reject 200
Loja não possui Taxas Definidas no Sistema  reject 200
Não foi possível gerar a transação! A sua parceria com a { Plataforma XYZ } não está ativada ou as taxas não estão de acordo. Entre em contato com o suporte Paghiper  reject 200
Você não ativou a parceria com a plataforma { Plataforma XYZ } no sistema. Entre em contato com o suporte Paghiper  reject 200
Parceria Inexistente ou o código de idPaterns esta incorreto. Entre em contato com o suporte Paghiper  reject 200
Nao foi Possivel criar a transacao, tente mais tarde reject 200
apiKey invalida ou comercio não localizado reject 401
apiKey invalida reject 401
Request method must be POST reject 405
Content type must be: application/json reject 405
Received content contained invalid JSON reject 405
transacao criada success 201
Suggest Edits

Cancelamento de boleto bancário

Essa função é apenas com os boletos que ainda não foram pagos. Após o vencimento do boleto, o mesmo será cancelado automaticamente pela PAGHIPER após 4 dias corridos.

 
posthttps://api.paghiper.com/transaction/cancel/
curl --request POST \
  --url https://api.paghiper.com/transaction/cancel/
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.paghiper.com/transaction/cancel/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.paghiper.com/transaction/cancel/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.paghiper.com/transaction/cancel/");

xhr.send(data);
import requests

url = "https://api.paghiper.com/transaction/cancel/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

token
string
required

Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/

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

status
string
required

Deve ser enviada a palavra: canceled Utilizado para confirmar o status solicitado.

transaction_id
string
required

Toda transação possui o transaction_id, ele é utilizado para identificar a transação em questão.

 
Endpoint
https://api.paghiper.com/transaction/cancel/
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para utilizar o endpoint será necessário possuir credencias apiKey e token.
Esses dados estão disponíveis no painel de credenciais no PagHiper.

Pagina de credenciais: https://www.paghiper.com/painel/credenciais/
Tipo de Conteúdo (JSON)
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Importante: Este procedimento é explicado em detalhes no item: 11.
Configurando o Formato das Mensagens.
{ 
 "token":"ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEX", 
 "apiKey":"apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz", 
 "status":"canceled", 
 "transaction_id":"BPV661O7AVLORCN5" 
}
{
  "cancellation_request":
    {
    "result":"success",
    "response_message":"O Boleto BPV661O7AVLORCN5 foi cancelado com Sucesso",
    "http_code":"200"
    }
}
<?php
$data = array(
   'apiKey' => 'apk_12345678-OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz',
'token' => 'ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEXl',
'status' => 'canceled',
'transaction_id' => 'ARC83YKF5TZ1XU50',
);
$data_post = json_encode( $data );
$url = "https://api.paghiper.com/transaction/cancel/";
//Configuracao do cabecalho da requisicao
$mediaType = "application/json";
$charSet = "UTF-8";
$headers = array();
$headers[] = "Accept: ".$mediaType;
$headers[] = "Accept-Charset: ".$charSet;
$headers[] = "Accept-Encoding: ".$mediaType;
$headers[] = "Content-Type: ".$mediaType.";charset=".$charSet;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data_post);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
$result = curl_exec($ch);
$json = json_decode($result, true);
### captura o http code
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
if($httpCode == 201): // CÓDIGO 201 SIGNIFICA QUE O BOLETO FOI GERADO COM SUCESSO
echo $result; // exibe todo json
else:
echo $json['cancellation_request']['response_message']; // Exemplo de como capturar a resposta json
endif;
?>
Suggest Edits

Especificações dos campos da requisição

 
Campo Tamanho Tipo Descrição
apiKey Até 50 caracteres Texto 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
token Até 128 caracteres Texto Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token: https://www.paghiper.com/painel/token/
transaction_id 16 Texto Toda transação possui o transaction_id, ele é utilizado para identificar a transação em questão.
status  Até 16 caracteres DATETIME

Deve ser enviada a palavra: canceled

Utilizado para confirmar o status solicitado.

Suggest Edits

Códigos de Retorno

 
Protocolo HTTP



Descrição Código Mensagem
Requisição recebida, porém, não pode ser consultada devido as regras de negócio aplicada.
Verificar o item: Mensagens de Retorno
200 Ok
Notification_id encontrada 201 Success
Conteúdo da mensagem vazio ou mal formatado 400 BAD_REQUEST
Credenciais para acessar o endpoint estão incorretas 401 UNAUTHORIZED
Credenciais para acessar o endpoint estão incorretas 405 UNAUTHORIZED
Tipo de conteúdo da mensagem não suportado Valores válidos: application/json 415 Unsupported Media Type
Suggest Edits

Mensagens de Retorno

 
Response_message Result HTTP
Code
apiKey não informada ou invalida reject 200
token não informado ou invalido reject 200
transaction_id não informada ou inválida reject 200
status não informado ou diferente do esperado reject 200
status atual do pedido diferente de pending reject 200
status atual do pedido é canceled reject 200
transaction_id inválida reject 200
token ou apiKey inválidos reject 401
Request method must be POST reject 405
Content type must be: application/json reject 405
Received content contained invalid JSON reject 405
O Boleto {idTransacao} foi Cancelado com Sucesso success 201
Suggest Edits

Consulta de status do boleto

A consulta irá retornar o status atual do pedido e a data da última alteração de status.

 
posthttps://api.paghiper.com/transaction/status/
curl --request POST \
  --url https://api.paghiper.com/transaction/status/
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.paghiper.com/transaction/status/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.paghiper.com/transaction/status/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.paghiper.com/transaction/status/");

xhr.send(data);
import requests

url = "https://api.paghiper.com/transaction/status/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

token
string
required

Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/

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

transaction_id
string
required

Toda transação possui o transaction_id, ele é utilizado para identificar a transação em questão.

 
Endpoint
https://api.paghiper.com/transaction/status/
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para utilizar o endpoint será necessário possuir credencias apiKey e token.
Esses dados estão disponíveis no painel de credenciais no PagHiper.

Pagina de credenciais: https://www.paghiper.com/painel/credenciais/
Tipo de Conteúdo (JSON)
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Importante: Este procedimento é explicado em detalhes no item: 11.
Configurando o Formato das Mensagens.
{ 
  "token":"ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEX", 
  "apiKey":"apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz",
  "transaction_id":"BPV661O7AVLORCN5"
}
{ 
	"status_request": 
	   { 
		"result":"success", 
		"response_message":"transacao encontrada", 
		"status":"canceled", 
		"status_date":"2017-07-14 21:21:02", 
		"due_date":"2017-07-12", 
		"value_cents":"2000", 
		"bank_slip":
		  {
		   "digitable_line":"34191.76106 04487.160246 61514.190000 3 72180000002000", 
		   "url_slip":"https://www.paghiper.com/checkout/boleto/ XXXXXXXXXXXXXXX",
		   "url_slip_pdf":"https://www.paghiper.com/checkout/boleto/XXXXXXXXXXXXXXX/pdf",
		  }, 
		"http_code":"201" 
		}
}
Suggest Edits

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

 
Campo Tamanho Tipo Descrição
apiKey Até 50 caracteres Texto 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
token Até 128 caracteres Texto Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token: https://www.paghiper.com/painel/token/
transaction_id 16 Texto Toda transação possui o transaction_id, ele é utilizado para identificar a transação em questão.
Suggest Edits

Especificações dos campos da mensagem de resposta

 
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

status Até 16 caracteres Texto

Retorna o status da transação no momento em que a notificação foi gerada.

Esperado:

status significado
pending aguardando
canceled cancelado
completed completo
paid aprovado
processing analise
refunded estornado
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

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 b01e3dcf3367c84cd0f7499e31/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 b01e3dcf3367c84cd0f7499e31/D7VE7WM4T1WZFWEJ/10044871/pdf

Detalhes do http cod
http_cod 3 Numérico Consultar item Códigos de Retorno (Status Protocolo HTTP) e Mensagens de Retorno

Suggest Edits

Códigos de Retorno (Status protocolo HTTP)

 
Protocolo HTTP



Descrição Código Mensagem
Requisição recebida, porém, não pode ser consultada devido as regras de negócio aplicada.
Verificar o item: Mensagens de Retorno
200 Ok
Transação encontrada 201 Success
Conteúdo da mensagem vazio ou mal formatado 400 BAD_REQUEST
Credenciais para acessar o endpoint estão incorretas 401 UNAUTHORIZED
Credenciais para acessar o endpoint estão incorretas 405 UNAUTHORIZED
Tipo de conteúdo da mensagem não suportado
Valores válidos: application/json
415 Unsupported Media Type
Suggest Edits

Mensagens de Retorno

 
Response_message Result HTTP
Code
apiKey não informada reject 200
token não informado reject 200
transaction_id não informada ou inválida reject 200
transaction_id inválida reject 200
token ou apiKey inválidos reject 401
Request method must be POST reject 405
Content type must be: application/json reject 405
Received content contained invalid JSON reject 405
transacao encontrada success 201
Suggest Edits

Notificações automática de status (Retorno automático)

 

A PagHiper irá notificar a notification_url quando declarada no momento da requisição de emissão do título. A notificação consiste no envio de um post simples para a notification_url com algumas informações iniciais (apiKey, notification_id, transaction_id, notification_date). Ao receber essa requisição o servidor do lojista deve retornar as mesmas informações acrescida do token do lojista para o endpoint https://api.paghiper.com/transaction/notification/ no formato JSON.

A PagHiper irá exibir os detalhes da notificação em formato json após receber o conteúdo do post inicial + token do lojista.

Caso a loja não responda a notificação, será feito outras tentativas a cada 2 horas durante 2 dias corridos.

Endpoint
https://api.paghiper.com/transaction/notification/
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para utilizar o endpoint será necessário possuir credencias apiKey e token.
Esses dados estão disponíveis no painel de credenciais no PagHiper.

Pagina de credenciais: https://www.paghiper.com/painel/credenciais/
Tipo de Conteúdo (JSON)
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Importante: Este procedimento é explicado em detalhes no item: 11.
Configurando o Formato das Mensagens.

Fluxo 1 - Post simples (não é json) enviado da PAGHIPER para a notification_url do lojista com informações iniciais sobre a notificação.

apiKey=apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz&
transaction_id=BPV661O7AVLORCN5&
notification_id= W6QM6MORZW4KUENC0NU6ERN0AULFUIUROKEU72L6ZQQT4E6521CGT0G3V2JQKDI9&
notification_date=2017-07-25 11:21:19

Fluxo 2 – Resposta da loja no formato JSON com os dados inicias das notificações + token do lojista

{
"token":"ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEX",
"apiKey":"apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz",
"transaction_id":"BPV661O7AVLORCN5",
"notification_id":"W6QM6MORZW4KUENC0NU6ERN0AULFUIUROKEU72L6ZQQT4E6521CGT0G3V2JQKDI9"
}

Fluxo 3 – Resposta da PAGHIPER no formato JSON, exibindo todo o conteúdo da notificação.

{
  "status_request":
	{
		"result":"success",
		"response_message":"notification_id encontrada",
		"transaction_id":"3IMZI5QXGMI7K40W"
		"order_id":"96874",
		"created_date":"2017-07-14 21:21:02",
		"status":"paid",
		"payer_email":"poulsilva@myexemple.com",
		"payer_name":"poul silva",
		"payer_cpf_cnpj":"00000000191",
		"payer_phone":"1140638785",
		"payer_street":"Av Brigadeiro Faria Lima",
		"payer_number":"1461",
		"payer_complement":"Torre Sul 4º Andar",
		"payer_district":"Jardim Paulistano",
		"payer_city":"São Paulo",
		"payer_state":"SP",
		"payer_zip_code":"01452002",
		"value_cents":"17012",
		"value_fee_cents":"279",
		"discount_cents":"1100",
		"shipping_price_cents":"2595",
		"bank_slip":{
		"digitable_line":"34191.76437 47416.610245 61514.190000 9 72540000017012",
		"url_slip":"https://www.paghiper.com/checkout/boleto/ab039901bd6f402e44424f30cd1d3ca9e1f5c90bdb78f7878e8dcdcf7701e1befdc7f1ff6521e8312f7cef408b10b500ee85da4b8903d28874a0436f00a0a3c6/3IMZI5QXGMI7K40W/43474166",
		"url_slip_pdf":"https://www.paghiper.com/checkout/boleto/ab039901bd6f402e44424f30cd1d3ca9e1f5c90bdb78f7878e8dcdcf7701e1befdc7f1ff6521e8312f7cef408b10b500ee85da4b8903d28874a0436f00a0a3c6/3IMZI5QXGMI7K40W/43474166/pdf"},
		"due_date":"2017-07-31",
		"num_cart_items":"3",
		"items":[
		{
				"item_id":"1",
				"description":"piscina de bolinha",
				"quantity":"1",
				"price_cents":"1012"
		},
		{
				"item_id":"1",
				"description":"pula pula",
				"quantity":"2",
				price_cents":"2000"
		},
		{
				"item_id":"1",
				"description":"mala de viagem",
				"quantity":"3",
				"price_cents":"4000"
		}],
		"http_code":"201"
 }
}

Especificações dos campos que a paghiper irá enviar na primeira etapa

Campo Tamanho Tipo Descrição
apiKey Até 50 caracteres Texto 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
transaction_id 16 Texto Toda transação possui o transaction_id, ele é utilizado para identificar a transação em questão.
notification_id Até 128 caracteres Texto Código único utilizado para identificar a notificação.
notification_date   DATETIME Data em que a notificação foi gerada.
Atenção: A notificação ficará disponível para consulta por até 30 dias a partir dessa data.

Especificações dos campos que devem ser enviados em resposta a notificação.

Campo Tamanho Tipo Descrição
apiKey Até 50 caracteres Texto 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
token Até 128 caracteres  Texto Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/
transaction_id 16 Texto Toda transação possui o transaction_id, ele é utilizado para identificar a transação em questão.  
notification_id  Até 128 caracteres Texto Código único utilizado para identificar a notificação.

Especificações dos campos da mensagem de resposta da PAGHIPER

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

status Até 16 caracteres Texto

Retorna o status da transação no momento em que a notificação foi gerada.

Esperado:

status significado
pending aguardando
canceled cancelado
completed completo
paid aprovado
processing analise
refunded estornado
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 Numérico Número do endereço do cliente pagador

Exemplo: 1461

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

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 b01e3dcf3367c84cd0f7499e31/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 b01e3dcf3367c84cd0f7499e31/D7VE7WM4T1WZFWEJ/10044871/pdf

Detalhes do http cod
http_cod 3 Numérico Consultar item Códigos de Retorno (Status Protocolo HTTP) e Mensagens de Retorno

Códigos de Retorno (Status Protocolo HTTP)

Protocolo HTTP



Descrição Código Mensagem
Requisição recebida, porém, não pode ser consultada devido as regras de negócio aplicada.
Verificar o item: Mensagens de Retorno
200 Ok
Notification_id encontrada 201 Success
Conteúdo da mensagem vazio ou mal formatado 400 BAD_REQUEST
Credenciais para acessar o endpoint estão incorretas 401 UNAUTHORIZED
Credenciais para acessar o endpoint estão incorretas 405 UNAUTHORIZED
Tipo de conteúdo da mensagem não suportado Valores válidos: application/json 415 Unsupported Media Type

Mensagens de Retorno

Response_message Result HTTP
Code
apiKey não informada reject 200
token não informado reject 200
transaction_id não informada ou inválida reject 200
transaction_id inválida reject 200
notification_id não informada ou inválida reject 200
notification_id inválida ou expirada reject 200
token ou apiKey inválidos reject 401
Request method must be POST reject 405
Content type must be: application/json reject 405
Received content contained invalid JSON reject 405
notification_id encontrada success 201
Suggest Edits

Notificações automática de status (Retorno automático)

 
posthttps://api.paghiper.com/transaction/notification/
curl --request POST \
  --url https://api.paghiper.com/transaction/notification/
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.paghiper.com/transaction/notification/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.paghiper.com/transaction/notification/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.paghiper.com/transaction/notification/");

xhr.send(data);
import requests

url = "https://api.paghiper.com/transaction/notification/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

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

token
string
required

Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/

transaction_id
string
required

Toda transação possui o transaction_id, ele é utilizado para identificar a transação em questão.

notification_id
string
required

Código único utilizado para identificar a notificação.

 
Suggest Edits

Solicitação de saque via API

 
posthttps://api.paghiper.com/bank_accounts/cash_out/
curl --request POST \
  --url https://api.paghiper.com/bank_accounts/cash_out/
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.paghiper.com/bank_accounts/cash_out/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.paghiper.com/bank_accounts/cash_out/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.paghiper.com/bank_accounts/cash_out/");

xhr.send(data);
import requests

url = "https://api.paghiper.com/bank_accounts/cash_out/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

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

token
string
required

Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/

bank_account_id
int32
required

id da conta bancaria cadastrada na PagHiper.

Para consultar o bank_account_id deve utilizar a requisição de listagem de contas bancarias.

 
Suggest Edits

Solicitação de saque via API

 

A requisição realizará um saque do valor total disponível na conta do lojista para o banco selecionado.

Endpoint
https://api.paghiper.com/bank_accounts/cash_out/
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para utilizar o endpoint será necessário possuir credencias apiKey e token.
Esses dados estão disponíveis no painel de credenciais no PagHiper.

Pagina de credenciais: https://www.paghiper.com/painel/credenciais/
Tipo de Conteúdo (JSON)
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Importante: Este procedimento é explicado em detalhes no item: 11.
Configurando o Formato das Mensagens.
{
 "token":"ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEX", 
 "apiKey":"apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz", 
 "bank_account_id":"4547699" 
}
{ 
   "cash_out_request": 
	{ 
	 "result":"success", 
	 "response_message":"Saque efetuado com sucesso. O valor será depositado em até 2 dias úteis.", 
	 "cash_out_value_cents":"130223", 
	 "cash_out_fee_cents":"200", 
	 "http_code":"201" 
	} 
}
Suggest Edits

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

 
Campo Tamanho Tipo Descrição
apiKey Até 50 caracteres Texto 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
token Até 128 caracteres Texto Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/
bank_account_id Até 15 caracteres Numérico id da conta bancária cadastrada na PagHiper.

Para consultar o bank_account_id deve utilizar a requisição de listagem de contas bancárias.
Suggest Edits

Especificações dos campos da mensagem de resposta

 
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

cash_out_value_cents Até 15 caracteres Numérico Valor do saque realizado em centavos, exemplo:

R$ 1302,23 será representado por: 130223

cash_out_fee_cents Até 15 caracteres Numérico Valor da tarifa do saque:

R$ 2,00 será representado por: 200

Essa tarifa normalmente não é aplicada, porem, pode existir para alguns bancos específicos.
Detalhes do http cod
http_cod 3 Numérico Consultar item Códigos de Retorno (Status Protocolo HTTP) e Mensagens de Retorno

Suggest Edits

Códigos de Retorno (Status protocolo HTTP)

 
Protocolo HTTP



Descrição Código Mensagem
Requisição recebida, porém, não pode ser consultada devido as regras de negócio aplicada.
Verificar o item: Mensagens de Retorno
200 Ok
Saque realizado com sucesso 201 Success
Conteúdo da mensagem vazio ou mal formatado 400 BAD_REQUEST
Credenciais para acessar o endpoint estão incorretas 401 UNAUTHORIZED
Credenciais para acessar o endpoint estão incorretas 405 UNAUTHORIZED
Tipo de conteúdo da mensagem não suportado
Valores válidos: application/json
415 Unsupported Media Type
Suggest Edits

Mensagens de Retorno

 
Response_message Result HTTP
Code
apiKey não informada ou inválida reject 200
token não informado ou inválido reject 200
bank_account_id não informado ou inválido reject 200
bank_account_id inválida reject 200
Um saque para essa apikey foi realizado nos últimos 5 minutos. Realize uma nova tentativa após 5 minutos. reject 200
Horário reservado para conciliação bancaria. reject 200
Saques estão indisponíveis para essa conta. Entre em contato com o suporte PAGHIPER reject 200
Valor disponível para saque menor que R$ 5,00 reject 200
Não há saldo disponível para saque reject 200
Um endereço de correspondência deve ser cadastrado na PAGHIPER reject 200
A data de nascimento deve ser atualizada na PAGHIPER reject 200
Saque não permitido. Documentação da conta não está completa reject 200
token ou apiKey inválidos reject 401
Request method must be POST reject 405
Content type must be: application/json reject 405
Received content contained invalid JSON reject 405
Saque efetuado com sucesso. O valor será depositado em até 2 dias úteis. success 201
Suggest Edits

Lista contas bancárias para saque via API

 
posthttps://api.paghiper.com/bank_accounts/list/
curl --request POST \
  --url https://api.paghiper.com/bank_accounts/list/
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.paghiper.com/bank_accounts/list/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.paghiper.com/bank_accounts/list/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.paghiper.com/bank_accounts/list/");

xhr.send(data);
import requests

url = "https://api.paghiper.com/bank_accounts/list/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

token
string
required

Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/

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

 
Suggest Edits

Lista contas bancárias para saque via API

 

A requisição retorna informações necessárias para realização de saques via API. Com ela é obtido o parâmetro: bank_account_id

Endpoint
https://api.paghiper.com/bank_accounts/list/
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para utilizar o endpoint será necessário possuir credencias apiKey e token.
Esses dados estão disponíveis no painel de credenciais no PagHiper.

Pagina de credenciais: https://www.paghiper.com/painel/credenciais/
Tipo de Conteúdo (JSON)
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Importante: Este procedimento é explicado em detalhes no item: 11.
Configurando o Formato das Mensagens.
{
 "token":"ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEX", 
 "apiKey":"apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz", 
}
{
 "bank_account_list_request":
 {
 "result":"success",
 "response_message":"lista encontrada",
 "bank_account_list": 
   [
	"bank_code":"341",
	"bank_name":"Itaú",
	"account_type":"Corrente",
	"bank_account_id":2177227},
	
	{"bank_code":"104",
	"bank_name":"Caixa Econômica",
	"account_type":"Corrente",
	"bank_account_id":3427869},
	
	{"bank_code":"104",
	"bank_name":"Caixa Econômica",
	"account_type":"Corrente",
	"bank_account_id":3445707},
	
	{"bank_code":"237",
	"bank_name":"Bradesco",
	"account_type":"Corrente",
	"bank_account_id":3856972},
	
	{"bank_code":"001",
	"bank_name":"Banco do Brasil",
	"account_type":"Corrente",
	"bank_account_id":4547699}
   ],
 "http_code":"201"}
}
Suggest Edits

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

 
Campo Tamanho Tipo Descrição
apiKey Até 50 caracteres Texto 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
token Até 128 caracteres Texto Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/
Suggest Edits

Especificações dos campos da mensagem de resposta

 
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

Detalhes do bank_account_list
bank_code Até 3 caracteres Numérico Código da instituição financeira

Exemplo:
Bradesco = 237
Itaú = 341
Caixa = 104

Lista com todos os códigos: https://goo.gl/HrtmpP

bank_name Até 128 caracteres Texto Nome da instituição financeira

Exemplo:
Bradesco
Banco do Brasil
Itaú

account_type Até 15 caracteres Texto Tipo da conta

Esperado:
Corrente
Poupanca

bank_account_id Até 45 caracteres Numérico Número atribuído a cada conta bancária cadastrada na PAGHIPER.

Utilizado apenas para saques via API

Detalhes do http cod
http_cod 3 Numérico Consultar item Códigos de Retorno (Status Protocolo HTTP) e Mensagens de Retorno

Suggest Edits

Códigos de Retorno (Status protocolo HTTP)

 
Protocolo HTTP



Descrição Código Mensagem
Requisição recebida, porém, não pode ser consultada devido as regras de negócio aplicada.
Verificar o item: Mensagens de Retorno
200 Ok
Lista encontrada 201 Success
Conteúdo da mensagem vazio ou mal formatado 400 BAD_REQUEST
Credenciais para acessar o endpoint estão incorretas 401 UNAUTHORIZED
Credenciais para acessar o endpoint estão incorretas 405 UNAUTHORIZED
Tipo de conteúdo da mensagem não suportado
Valores válidos: application/json
415 Unsupported Media Type
Suggest Edits

Mensagens de Retorno

 
Response_message Result HTTP
Code
apiKey não informada ou inválida reject 200
token não informado ou inválido reject 200
bank_account_id não informada ou inválida reject 200
bank_account_id inválida reject 200
não existe contas bancária habilitada para saque reject 200
token ou apiKey inválidos reject 401
Request method must be POST reject 405
Content type must be: application/json reject 405
Received content contained invalid JSON reject 405
transacao encontrada success 201
Suggest Edits

Listar transações via API

 
posthttps://api.paghiper.com/transaction/list/
curl --request POST \
  --url https://api.paghiper.com/transaction/list/
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.paghiper.com/transaction/list/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.paghiper.com/transaction/list/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.paghiper.com/transaction/list/");

xhr.send(data);
import requests

url = "https://api.paghiper.com/transaction/list/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

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

token
string
required

Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/

status
string

Listar as transações de acordo com o seu status atual

Esperado:

status significado
pending aguardando
canceled cancelado
paid aprovado e completo
processing analise
refunded estornado

initial_date
date

Data inicial do filtro

Exemplo esperado
2018-01-01

Caso não seja enviado esse parâmetro, será utilizado os últimos 90 dias.

Verifique as orientações do parâmetro:
filter_date

final_date
date

Data inicial do filtro

Exemplo esperado
2018-01-01

Caso não seja enviado esse parâmetro, será utilizado a data atual. 

Verifique as orientações do parâmetro:
filter_date

filter_date
string
  • Campo obrigatório caso utilize o initial_date e final_date
    Este parâmetro tem a função de filtrar a busca de datas por:

    • Data em que a transação foi criada
    ou
    • Data em que a transação foi paga

    Esperado:

    opções significado
    create_date Data da criação
    paid_date Data do pagamento
due_date
date

Data de vencimento do boleto

Exemplo esperado 2018-01-17

Utilizado apenas para listar boletos que irão vencer em uma determinada data.

order_id
string

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.

value_cents
int32

Possibilidade de buscar pelo valor da transação

Valor unitário em centavos
Exemplo:Filtrar transações com o valor de R$ 1.000,00 (mil reais), deverá ser informado: 100000 (total em centavos)

value_cents_filter
string

Deve ser utilizado apenas em conjunto com o parâmetro: value_cents

O uso desse parâmetro auxiliaria por exemplo a listar todas as transações de valores menores ou iguais ( <= ) á R$ 1000,00 (mil reais).

Esperado:

símbolo significado
= Igual
>= Maior igual
<= Menor igual
> Maior
< Menor

limit
int32

Limita o número máximo de transações retornadas a no máximo 100 registro.

Esperado:
1 a 100

Esse parâmetro é útil para paginação

page
int32

necessário quando se deseja realizar paginação dos resultados.

Esperado:
1 a 999

 
Suggest Edits

Listar transações via API

 

Esta requisição possibilita a listagem de todas as transações realizada em um determinado período.

Através dos filtros disponíveis, é possível buscar por exemplo por todas as transações por um determinado status, data de vencimento, data de emissão ou de pagamento.

Endpoint
https://api.paghiper.com/transaction/list/
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para utilizar o endpoint será necessário possuir credencias apiKey e token.
Esses dados estão disponíveis no painel de credenciais no PagHiper.

Pagina de credenciais: https://www.paghiper.com/painel/credenciais/
Tipo de Conteúdo (JSON)
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Importante: Este procedimento é explicado em detalhes no item: 11.
Configurando o Formato das Mensagens.

No exemplo abaixo foi requerido a listagem de todas as transações que foram pagas em todo o mês de janeiro/2018, além de limitar o resultado em 2 registro por pagina, iniciando da primeira página.

{ 
 "token":"ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEX", 
 "apiKey":"apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz",
 "initial_date":"2018-01-01",
 "final_date":"2018-01-31",
 "filter_date":"paid_date",
 "status":"paid",
 "limit":"2",
 "page":"1",
}
{
  "transaction_list_request": {
      "result": "success",
      "response_message": "lista encontrada",
      "current_page": 1,
      "total_page": 48,
      "transaction_list": [
          {
              "transaction_id": "FJWTCLK4M9LU3MSG",
              "order_id": "55977",
              "status": "paid",
              "status_date": "2018-01-05 05:32:31",
              "due_date": "2018-01-25",
              "value_cents": 7531,
              "discount_cents": 1200,
              "value_fee_cents": 199,
              "payer_email": "alex@paghiper.com",
              "payer_name": "Alexandro Mustaff",
              "payer_cpf_cnpj": "00000000000",
              "payer_phone": "11999999999",
              "create_date": "2018-01-02 18:56:48",
              "paid_date": "2018-01-05 05:32:31",
              "bank_slip": {
                  "digitable_line": "34191.00000 00000.780247 00000.190000 9 74460000007531",
                  "url_slip": "https://www.paghiper.com/checkout/boleto/xxxxx/yyyyyy/99999999",
                  "url_slip_pdf": "https://www.paghiper.com/checkout/boleto/xxxxx/yyyyyy/99999999/pdf"
              },
              "items": [
                  {
                      "item_id": "H5BBRMHHC",
                      "description": "Capsula da beleza (60 Comprimidos)",
                      "quantity": 1,
                      "price_cents": 8000
                  },
                  {
                      "item_id": "6FDFJPTG4YZ499W",
                      "description": "Frete",
                      "quantity": 1,
                      "price_cents": 731
                  }
              ]
          },
          {
              "transaction_id": "D21R8MBBUHD1PG5T",
              "order_id": "55962",
              "status": "paid",
              "status_date": "2018-01-06 05:50:22",
              "due_date": "2018-01-15",
              "value_cents": 10560,
              "discount_cents": 989,
              "value_fee_cents": 199,
              "payer_email": "matheus@paghiper.com",
              "payer_name": "Matheus Pill",
              "payer_cpf_cnpj": "00000000000",
              "payer_phone": "11999999999",
              "create_date": "2018-01-04 17:05:53",
              "paid_date": "2018-01-06 05:50:22",
              "bank_slip": {
                  "digitable_line": "34191.00000 00000.780247 00000.190000 9 74460000007531",
                  "url_slip": "https://www.paghiper.com/checkout/boleto/xxxxx/yyyyyy/99999999",
                  "url_slip_pdf": "https://www.paghiper.com/checkout/boleto/xxxxx/yyyyyy/99999999/pdf"
              },
              "items": [
                  {
                      "item_id": "UJ7JK6KJJ-morango",
                      "description": "Morango (907g) - Conserva",
                      "quantity": 1,
                      "price_cents": 9889
                  },
                  {
                      "item_id": "6FDFJPTG4YZ499W",
                      "description": "Frete",
                      "quantity": 1,
                      "price_cents": 1660
                  }
              ]
          }
      ],
      "http_code": "201"
  }
}
Suggest Edits

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
token Até 128 caracteres Texto Obrigatória Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/
status Até 15 caracteres Texto Opcional Listar as transações de acordo com o seu status atual

Esperado:
status significado
pending aguardando
canceled cancelado
paid aprovado e completo
processing analise
refunded estornado
initial_date   Date Opcional Data inicial do filtro

Exemplo esperado
2018-01-01

Caso não seja enviado esse parâmetro, será utilizado os últimos 90 dias.

Verifique as orientações do parâmetro:
filter_date
final_date   Date Opcional Data inicial do filtro

Exemplo esperado
2018-01-01

Caso não seja enviado esse parâmetro, será utilizado a data atual. 

Verifique as orientações do parâmetro:
filter_date
filter_date   Texto Obrigatório* * Campo obrigatório caso utilize o initial_date e final_date
Este parâmetro tem a função de filtrar a busca de datas por:

• Data em que a transação foi criada
ou
• Data em que a transação foi paga

Esperado:

opções significado
create_date Data da criação
paid_date Data do pagamento
due_date   Date Opcional Data de vencimento do boleto

Exemplo esperado 2018-01-17

Utilizado apenas para listar boletos que irão vencer em uma determinada data.
order_id Até 64 caracteres Texto Opcional 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.
value_cents Até 15 caracteres Numérico Opcional Possibilidade de buscar pelo valor da transação

Valor unitário em centavos
Exemplo:Filtrar transações com o valor de R$ 1.000,00 (mil reais), deverá ser informado: 100000 (total em centavos)
value_cents_filter Até 2 caracteres Texto Opcional Deve ser utilizado apenas em conjunto com o parâmetro: value_cents

O uso desse parâmetro auxiliaria por exemplo a listar todas as transações de valores menores ou iguais ( <= ) á R$ 1000,00 (mil reais).

Esperado:

símbolo significado
= Igual
>= Maior igual
<= Menor igual
> Maior
< Menor
limit Até 3 caracteres Numérico Opcional Limita o número máximo de transações retornadas a no máximo 100 registro.

Esperado:
1 a 100

Esse parâmetro é útil para paginação
page Até 3 caracteres Numérico Opcional necessário quando se deseja realizar paginação dos resultados.

Esperado:
1 a 999
Suggest Edits

Especificações dos campos da mensagem de resposta

 
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 lista de contas foi exibida com sucesso.

verificar item mensagens de retorno

current_page Até 3 caracteres Numérico Número atual da página

Utilizado para paginação de resultados.

total_page Até 3 caracteres Numérico Número máximo de páginas encontradas

Detalhes do bank_account_list
transaction_id 16 Texto Toda transação possui o transaction_id, ele é utilizado para identificar uma transaçã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.
status Até 16 caracteres Texto Retorna o status da transação no momento em que a notificação foi gerada.

Esperado:
status significado
pending aguardando
canceled cancelado
completed completo
paid aprovado
processing analise
refunded estornado
status_date   DATETIME Data da última 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

discount_cents Até 15 caracteres Numérico Desconto total aplicado ao título em centavos

R$ 9,99 será representado por: 999

value_fee_cents Até 15 caracteres Numérico Tarifa da transação em centavos

R$ 2,79 será representado por: 279

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

Telefone: (11) 4063-8785

Exemplo: 1140638785

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 aprovada

Exemplo esperado:
2017-07-14 21:21:02

Se a transação não foi paga, será exibido null.

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 b01e3dcf3367c84cd0f7499e31/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 b01e3dcf3367c84cd0f7499e31/D7VE7WM4T1WZFWEJ/10044871/pdf

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.

http_cod Até 15 caracteres Numérico Valor unitário do item em centavos

Retorna 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 http code
http_cod 3 Numérico Consultar item Códigos de Retorno (Status Protocolo HTTP) e Mensagens de Retorno

Suggest Edits

Códigos de Retorno (Status protocolo HTTP)

 
Protocolo HTTP



Descrição Código Mensagem
Requisição recebida, porém, não pode ser consultada devido as regras de negócio aplicada.
Verificar o item: Mensagens de Retorno
200 Ok
Lista encontrada 201 Success
Conteúdo da mensagem vazio ou mal formatado 400 BAD_REQUEST
Credenciais para acessar o endpoint estão incorretas 401 UNAUTHORIZED
Credenciais para acessar o endpoint estão incorretas 405 UNAUTHORIZED
Tipo de conteúdo da mensagem não suportado
Valores válidos: application/json
415 Unsupported Media Type
Suggest Edits

Mensagens de Retorno

 
Response_message Result HTTP
Code
apiKey não informada ou invalida reject 200
token não informado ou invalido reject 200
limit maior que 100 reject 200
status requirido inválido reject 200
filter_date requirido inválido reject 200
order_id inválido reject 200
value_cents_filter inválido reject 200
initial_date inválida reject 200
final_date inválida reject 200
due_date inválida reject 200
Transações não encontradas reject 200
token ou apiKey inválidos reject 401
Request method must be POST reject 405
Content type must be: application/json reject 405
Received content contained invalid JSON reject 405
lista encontrada success 201
Suggest Edits

Lista de notas fiscais emitidas pela PAGHIPER

 
posthttps://api.paghiper.com/invoice/list/
curl --request POST \
  --url https://api.paghiper.com/invoice/list/
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.paghiper.com/invoice/list/' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.paghiper.com/invoice/list/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.paghiper.com/invoice/list/");

xhr.send(data);
import requests

url = "https://api.paghiper.com/invoice/list/"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

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

token
string
required

Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/

 
{
 "token":"ZKSRNZGN8VW3MWN68UX8DDMDJR578N9772YU2FHABDEX", 
 "apiKey":"apk_12345678-OiCWOKczTjutZazRSfTlVBDpHFxpkdzz"
}
{
    "invoice_list_request": {
        "result": "success",
        "response_message": "lista encontrada",
        "invoice_list": [
            {
              "invoice_id": "22740",
              "invoice_cod": "P7WVZHMPB",
              "invoice_value_cents": 88920,
              "invoice_date": "2018-01-31",
              "invoice_customer": "EMPRESA DE EXEMPLO LTDA ME",
              "invoice_customer_id": "00000000000000",
              "invoice_url": "http://e-gov.betha.com.br/e-nota/visualizarnotaeletronica?link=1517422750027227403377757275263507812472XXXXXXXXXXXX",
              "invoice_description": "Servico de cobranca via boleto bancario e gestao de recebiveis Ref Janeiro 2018 Contrato 2016121613494028.\n Conforme Art. 7o da Lei Complementar 116 de 31 de julho de 2003. A base de calculo do imposto se refere ao valor do servico.\n \n Foram gerados R$ 889.20 em tarifas para o PAGHIPER",
              "invoice_type": "tarifa"
            },
            {
              "invoice_id": "20443",
              "invoice_cod": "3NNQ35VO8",
              "invoice_value_cents": 81567,
              "invoice_date": "2017-12-31",
              "invoice_customer": "EMPRESA DE EXEMPLO LTDA ME",
              "invoice_customer_id": "00000000000000",
              "invoice_url": "http://e-gov.betha.com.br/e-nota/visualizarnotaeletronica?link=151550244113720443545775727543103685872XXXXXXXXXXXX",
              "invoice_description": "Servico de cobranca via boleto bancario e gestao de recebiveis Ref Dezembro 2017 Contrato 2016121613494028.\n Conforme Art. 7o da Lei Complementar 116 de 31 de julho de 2003. A base de calculo do imposto se refere ao valor do servico.\n \n Foram gerados R$ 815,67 em tarifas para o PAGHIPER",
              "invoice_type": "tarifa"
            }
        ],
        "http_code": "201"
    }
}
Suggest Edits

Lista de notas fiscais emitidas pela PAGHIPER

 

A requisição retorna as 6 últimas notas fiscais emitidas pela PAGHIPER, ao qual fazem referencia as tarifas de intermediação.

Endpoint
https://api.paghiper.com/invoice/list/
Protocolo / Tipo de Requisição
HTTPS / POST
Autenticação
Para utilizar o endpoint será necessário possuir credencias apiKey e token.
Esses dados estão disponíveis no painel de credenciais no PagHiper.

Pagina de credenciais: https://www.paghiper.com/painel/credenciais/
Tipo de Conteúdo (JSON)
O header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

"Accept", "application/json"

Importante: Este procedimento é explicado em detalhes no item: 11.
Configurando o Formato das Mensagens.
Suggest Edits

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

 
Campo Tamanho Tipo Descrição
apiKey Até 50 caracteres Texto 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
token Até 128 caracteres Texto Token individual para cada vendedor. Ele é utilizado para validar a solicitação e não deve ser compartilhado com terceiros.

Para obter o token:
https://www.paghiper.com/painel/token/
Suggest Edits

Especificações dos campos da mensagem de resposta

 
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

Detalhes do invoice_list
invoice_id Até 3 caracteres Numérico Número da nota fiscal

Exemplo:
7894

invoice_cod Até 15 caracteres Texto Código de verificação da nota fiscal

Exemplo:
3NNQ35VO8
invoice_value_cents Até 15 caracteres Numérico Valor da nota fiscal em centavos

Exemplo: Nota fiscal com o total de R$ 1.901,95, será informado: 190195 (total em centavos)

invoice_date DATE Data do fato gerador da nota.

Exemplo:
2018-01-31

invoice_customer Até 200 caracteres Texto Nome do lojista ou Razão social de acordo com o tipo de

invoice_customer_id Até 14 caracteres Numérico CPF ou CNPJ do lojista de acordo com o tipo de conta

invoice_url Até 255 caracteres Texto Url de acesso a nota fiscal

invoice_description Texto Descrição da nota fiscal

Exemplo:
“Servico de cobranca via boleto bancário e gestão de recebiveis Ref Janeiro 2018 Contrato 2016121613494028.\n Conforme Art. 7o da Lei Complementar 116 de 31 de julho de 2003. A base de cálculo do imposto se refere ao valor do servico.\n \n Foram gerados R$ 889.20 em tarifas para o PAGHIPER”
invoice_type Até 15 caracteres Texto Referenciara origem da nota fiscal

Esperado:
status significado
tarifa Tarifa de intermediação
saque Tarifa de saque/transferência
Detalhes do http cod
http_cod 3 Numérico Consultar item Códigos de Retorno (Status Protocolo HTTP) e Mensagens de Retorno

Suggest Edits

Códigos de Retorno (Status protocolo HTTP)

 
Protocolo HTTP



Descrição Código Mensagem
Requisição recebida, porém, não pode ser consultada devido as regras de negócio aplicada.
Verificar o item: Mensagens de Retorno
200 Ok
Lista encontrada 201 Success
Conteúdo da mensagem vazio ou mal formatado 400 BAD_REQUEST
Credenciais para acessar o endpoint estão incorretas 401 UNAUTHORIZED
Credenciais para acessar o endpoint estão incorretas 405 UNAUTHORIZED
Tipo de conteúdo da mensagem não suportado
Valores válidos: application/json
415 Unsupported Media Type
Suggest Edits

Mensagens de Retorno

 
Response_message Result HTTP
Code
apiKey não informada ou invalida reject 200
token não informado ou invalido reject 200
não existe nota fiscal para esse usuário reject 200
token ou apiKey inválidos reject 401
Request method must be POST reject 405
Content type must be: application/json reject 405
Received content contained invalid JSON reject 405
lista encontrada success 201
Suggest Edits

Configurando o formato das mensagens (REQUISIÇÃO E RESPOSTA)

 

Para que a loja possa optar pelo formato da mensagem, dentre as opções disponibilizadas pela Plataforma PAGHIPER: JSON, o header “Accept” deverá ser enviado contendo o formato da mensagem desejado.

Exemplos de código em java:

urlConnection.setRequestProperty("Accept","application/json");

Além disso, para definir o tipo de conteúdo da mensagem da requisição, o header


“Content-Type” precisa ser especificado, conforme apresentado a seguir.

urlConnection.setRequestProperty("Content-Type","application/json;UTF-8");