Emissão de Pix PAGHIPER

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Valor minimo por Pix R$ 3,00

O Pix só será emitido caso o valor não seja menor que R$ 3,00
O valor do pix considera todos os Itens, desconto e frete.

Por exemplo um pix com 1 (um) produto no valor de R$ 3,00 sem descontos será emitido normalmente.

Entretanto se oferecer desconto de R$ 0,01 o pedido ficaria como R$ 2,99 não sendo possível sua emissão.

<?php
$data = array(
  'apiKey' => 'apk_12345678-OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz',
  'order_id' => '96874', // código interno do lojista para identificar a transacao.
  'payer_email' => '[email protected]',
  'payer_name' => 'poul silva', // nome completo ou razao social
  'payer_cpf_cnpj' => '00000000191', // cpf ou cnpj
  'payer_phone' => '1140638785', // fixou ou móvel
  'notification_url' => 'https://mysite.com/notification/paghiper/',
  'discount_cents' => '1100', // em centavos
  'shipping_price_cents' => '2595', // em centavos
  'shipping_methods' => 'PAC',
  'number_ntfiscal' => '1554123',
  'fixed_description' => true,
  'days_due_date' => '5', // dias para vencimento do Pix
  '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 = "https://pix.paghiper.com/invoice/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 PIX 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;
?>
Body Params
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

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.

string
required

e-mail valido do cliente pagador

string
required

Nome ou Razão social do cliente pagador

string
required

CPF ou CNPJ do pagador de preferencia apenas os números do cpf ou cnpj

int32

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

int32
required

Dias corridos até o vencimento

Exemplo: 4

O número representa diferença de dias entre a data da requisição e a data de vencimento.

A diferença entre as datas:
Data requisição: 2017-07-01
Data do vencimento: 2017-07-05

days_due_date: 4

Por padrão o valor maximo é de 400 dias, caso necessite emitir Pix com prazo superior a 400 dias entre em contato através do e-mail [email protected]

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

int32

Valor total do desconto da compra em centavos

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

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

int32

Valor total do frete em centavos

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

string

Método de entrega

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

string

Id do parceiro

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

int32

Número da nota fiscal Se informado 123456, exibira o número da nota fiscal no Pix junto á caixa de descrição da seguinte forma: “Referente a nota fiscal número: 123456”

boolean

Frase fixa

Frase pré-configurada no painel do PagHiper,
esta frase passa por uma pré analise antes de ser exibida no Pix.

esperado significado true Exibira a frase na caixa de descrição do Pix false Nenhuma frase pré-configurada

string

Frase variável do vendedor

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

A frase variável será exibida no corpo do Pix, no campo onde traz informações sobre os prazos de pagamento do Pix.

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

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

Tamanho máximo de 120 caracteres.

items
array of objects
required
items*
Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json