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

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

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]

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 pix 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 no Pix.
esperado significado
true Exibira a frase na caixa de descrição do pix
false Nenhuma frase pré-configurada


seller_description Até 120 caracteres Texto Opcional Frase variável do vendedor

Texto que ira 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.

Detalhes de items(array)
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, deve ser enviado numero inteiro igual ou maior que 1

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)