PApaghiper

Emissão de Pix PAGHIPER

post/invoice/create/

Request

  • Base URL
    https://pix.paghiper.com
  • URL
    https://pix.paghiper.com/invoice/create/
  • Auth
    none required

Request body

apiKeystring required

Campo composto de números, letras, traços e hífen.<br>Sempre começa por <strong>apk_</strong><br><br> Exemplo: apk_48040241-OqCWOKczcjutZaFRSfTlVBDpHFXpkdzz<br> <br> Utilizado para identificar o vendedor

order_idstring required

<strong>Código de referencia da venda</strong><br><br>Define um código para referenciar o pagamento.<br>Útil para vincular o pagamento a um pedido criado pelo sistema do lojista.<br><br>Recomendamos que seja um código único para cada transação.

payer_emailstring required

e-mail valido do cliente pagador

payer_namestring required

Nome ou Razão social do cliente pagador

payer_cpf_cnpjstring required

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

payer_phoneinteger

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

days_due_dateinteger required

<strong>Dias corridos até o vencimento<br><br>Exemplo: 4</strong><br>O número representa diferença de dias entre a data da requisição e a data de vencimento.<br><br>A diferença entre as datas:<br>Data requisição: 2017-07-01<br>Data do vencimento: 2017-07-05<br><br>days_due_date: 4<br><br> 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 comercial@paghiper.com

notification_urlstring

<strong>URL de retorno automático de dados</strong><br>Endereço da página onde o PagHiper enviará o POST com as informações da transação. <br>Note que, este campo tem prioridade sobre a url que estiver configurada no painel PagHiper.<br><br>Qualquer alteração de status de uma transação, será está url que iremos notificar através de um post

discount_centsinteger

<strong>Valor total do desconto da compra em centavos</strong><br><br>Exemplo, em um desconto aplicado de R$ 11,58 reais, deve ser informado: 1158 (total de centavos).<br><br>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_centsinteger

<strong>Valor total do frete em centavos</strong><br><br>Exemplo: o frete custa R$ 15,99, deve ser informado: 1599 (total em centavos)

shipping_methodsstring

<strong>Método de entrega</strong><br><br>Exemplo: SEDEX, SEDEX10, PAC, TRANSPORTADORA, MOTOBOY, RETIRADA NO LOCAL, etc.

partners_idstring

<strong>Id do parceiro</strong><br><br>Útil apenas para integração de plataformas parceiras. Na maioria dos casos, esse campo deve ser ignorado.

number_ntfiscalinteger

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

fixed_descriptionboolean

<strong>Frase fixa</strong><br><br>Frase pré-configurada no painel do PagHiper,<br> esta frase passa por uma pré analise antes de ser exibida no Pix.<br><br><table class="especificacoesmini"> <thead> <tr> <th>esperado</th> <th>significado</th> </tr> </thead> <tbody> <tr> <td>true</td> <td>Exibira a frase na caixa de descrição do Pix</td> </tr> <tr> <td>false</td> <td>Nenhuma frase pré-configurada</td> </tr> </tbody> </table>

seller_descriptionstring

<strong>Frase variável do vendedor</strong><br><br> 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.<br><br> A frase variável será exibida no corpo do Pix, no campo onde traz informações sobre os prazos de pagamento do Pix.<br><br> A frase será exibida no seguinte formato: “<strong>Texto do vendedor</strong>: (conteúdo da frase variável aqui)”<br><br> Obs.: A informação “<strong>Texto do vendedor</strong>” é permanente, não sendo retirada ao acrescentar uma frase variável no Pix.<br><br> Tamanho máximo de 120 caracteres.<br> <br>

Response

201

Example response

{
  "pix_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",
    "pix_code": {
      "qrcode_base64": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAACxElEQVR4Xu2Xy20kMQxExUTE/LPYUKREpK1XMjDyHIw9uLmXEXr6o34GCmSRbLf98/rT3nfe1gc46wOc9QHO+jdgtBace66uX+OYZ7MMmDpGjxWrx+g95ooRbFYCejzyhLTwo8/FgB54SbgIVM//ACByzqUMrfgKXS2gY67UGx3KVu4R3iwE8Od8X++ufn//ywBLPlWgpEuXlUNCz6oCRgsiI6NKWmCcJoSA1QHyhlKl6k3ddkyrl05aHTCwScqkAyJ1Hr3RSCoBapUMhdU1WUVPaqaFgFQSn1ATc6CkT0I3TaUMkKK0V4/S49h5LmWAZ0ly7RQsCVNrfwWqABiERmeblUZGL2W4VgLkiDFC9SplDBaaSSUgBH0SZ5lOWd7JKgA00SSPiSZ5pElla7IQ2HgGTaoaakaSVcB38T4PqGi0R9OQVuQh+S7eCsA9Q4UyCY+6iXKG0iwEhChPtLHNfEMjN/uK5OPA9ERxdPxmuILH5agCYFK0vKObJ43VeCXgoMin1jaN0NRexVsAbL7sGtP0JIuy/ZasAkA3cilxUYBWYBc5dl3Jeh6gXdDKV8e72tdGuJALgaSFUL30MtdQ51+SrATkDh3JeSpjsqvCtS+RzwNO0UIZ1rFb0sILAT0oOkkjccX4sX1P1tOARG6qN0ElVLfyzZWsAmCxKasGv8VXL+VzB6oASDUNeVba0k7ZOPgu3gKgBy4lSuqei0Ju3EchwHc26ZG04IdA/iwLga8QdWpGucK9tJE7ks8DCo2UuXDtE+wj6CXyeYAOZr94tKmOWridVwIsjOqLhzvlfIksAIYVLQZJEJ/BZCFWhcCkhdExNFw3w+SIzFKAQT6UoX6SJfuge1YDgwZCF0+ShZEbl1pApbtJ0OQbR2g6V3XA5hUN3XtU0tFcCNi01njqlrGmqnElVQE/rQ9w1gc46wOc9QvAX+6y+aZjvEg1AAAAAElFTkSuQmCC",
      "emv": "00020101021226770014BR.GOV.BCB.PIX2555api.itau/pix/qr/v1/ce7f9743-6575-485a-86da-a0f56cf136565204000053039865802BR5925PAGHIPER SERV ONLINE EIRE6009SAO PAULO62070503***630409AD",
      "pix_url": "https://pix.paghiper.com/qrcode/180068c7/HF97T5SH2ZQNLF6Z/30039",
      "bacen_url": "https://pix.bcb.gov.br/qr/MDAwMjAxMDEwMjEyMjY3NzAwMTRCUi5HT1YuQkNCLlBJWDI1NTVhcGkuaXRhdS9waXgvcXIvdjEvY2U3Zjk3NDMtNjU3NS00ODVhLTg2ZGEtYTBmNTZjZjEzNjU2NTIwNDAwMDA1MzAzOTg2NTgwMkJSNTkyNVBBR0hJUEVSIFNFUlYgT05MSU5FIEVJUkU2MDA5U0FPIFBBVUxPNjIwNzA1MDMqKio2MzA0MDlBRA=="
    },
    "http_code": "201"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.