Este endpoint realiza a geração de um QRCode de pagamento Pix. Para fazê-lo deve ser efetuada a chamada para a API, como especificado abaixo:
A chamada deverá ser feita utilizando o método POST.
https://api.gerapix.digital/v1/pix/qrcodes/
Para consumir este endpoint, é obrigatório incluir no cabeçalho da requisição HTTP um token de autenticação no formato.
Bearer
Este token é único por cliente e permite que a plataforma valide e autorize a requisição.
Na GeraPix, cada cliente possui dois tipos de token: público e secreto. Para esse endpoint, é obrigatório utilizar o token secreto.
Authorization: Bearer SEU_TOKEN_AQUI Content-Type: application/json
Nota: Substitua SEU_TOKEN_SECRETO
pelo seu token secreto, disponível no painel administrativo da GeraPix.
401 Unauthorized
Parâmetro | Tipo | Descrição | Exemplo |
---|---|---|---|
valor
(obrigatório)
|
string | Valor da cobrança em reais. Deve ser informado como número decimal utilizando ponto como separador decimal (formato float com ponto) | 49.90 |
nome
(obrigatório)
|
string
Até 100 caracteres
|
Nome completo do pagador. Deve conter pelo menos nome e sobrenome e ter no máximo 100 caracteres | João Silva |
email
(obrigatório)
|
string
Até 100 caracteres
|
Endereço de e-mail válido do pagador. Deve seguir o formato padrão (ex: usuario@dominio.com) | joao.silva@email.com |
doc_tipo
(obrigatório)
|
string
Até 4 caracteres
|
Tipo de documento do pagador. Deve ser informado como cpf ou cnpj (somente letras minúsculas) | cpf |
doc_numero
(obrigatório)
|
string
Até 14 caracteres
|
Número do documento do pagador. Deve conter apenas números, sem pontos, traços ou barras. Utilize CPF (11 dígitos) ou CNPJ (14 dígitos), de acordo com o doc_tipo | 12345678901 (CPF) ou 12345678000199 (CNPJ) |
callback_url
(obrigatório)
|
string
Até 100 caracteres
|
URL para envio de notificação de pagamento | https://seusite.com/callback |
external_reference
(opcional)
|
string
Até 100 caracteres
|
Identificador externo da cobrança. Pode ser usado para associar o pagamento a um pedido, usuário ou qualquer controle interno do sistema | pedido_12345 |
login_split
(opcional)
|
string
Até 100 caracteres
|
Email do usuário que irá receber o valor do split. Utilizado para identificar a conta destino do repasse | exemplo@email.com |
porcentagem_split
(opcional)
|
string
>Número entre 0 e 100
|
Porcentagem do valor a ser repassado ao usuário informado. Se 0 ou omitido, nada será repassado | 1 |
{
"valor": "49.90",
"nome": "João Silva",
"email": "joao.silva@email.com",
"doc_tipo": "cpf",
"doc_numero": "12345678901",
"callback_url": "https://seusite.com/callback",
"external_reference": "pedido_12345",
"split": [
{
"login_split": "victor.silva@email.com",
"porcentagem_split": "1"
}
]
}
Após a chamada, é retornado um JSON com o status 201 - Created caso o procedimento tenha ocorrido com sucesso.
{
"id_transacao": "91000186601",
"external_reference": "pedido_12345",
"status": "pendente",
"qr_code_base64": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...",
"qr_code": "00020101021126580014br.gov.bcb.pix..."
}
Código | Parâmetro | Motivo | Inválido |
---|---|---|---|
ERR001 | valor | O valor informado está no formato incorreto ou é inferior ao valor mínimo aceito de 10.00 | Exemplo inválido: 49,90 (use ponto como separador decimal) |
ERR002 | nome | Nome deve conter pelo menos o primeiro nome e sobrenome, e não pode ultrapassar 100 caracteres | Exemplo inválido: João (faltando sobrenome) |
ERR003 | O e-mail informado não está no formato válido ou não existe | Exemplo inválido: joao.silva@email (domínio incorreto) | |
ERR004 | doc_tipo | Tipo de documento deve ser "cpf" ou "cnpj", com letras minúsculas | Exemplo inválido: CPF (erro no tipo de documento, deve ser cpf em minúsculo) |
ERR005 | doc_numero | O número do documento deve conter apenas números, sem pontos ou traços. O número deve ser de um CPF (11 dígitos) ou CNPJ (14 dígitos), de acordo com o tipo de documento | Exemplo inválido: 123.456.789-01 (formato incorreto para CPF, deve remover pontos e traços) |
ERR006 | callback_url | A URL fornecida para o callback está em um formato inválido ou não é acessível | Exemplo inválido: https://seusite (URL incompleta) |
ERR007 | external_reference | Se fornecido, o identificador externo deve ser único e estar no formato correto | Exemplo inválido: pedido_12345! (caracteres especiais não permitidos) |
ERR008 | login_split | O e-mail do destinatário do split deve ser válido, se fornecido. | Exemplo inválido: user@@email (e-mail malformado) |
ERR009 | porcentagem_split | A porcentagem do split deve ser um número inteiro entre 0 e 100, se fornecido. | Exemplo inválido: 150 (fora do intervalo permitido) |
ERR010 | split | O array de split deve conter no máximo um objeto. Múltiplos splits não são permitidos. | Exemplo inválido: [{"login_split": "email1@example.com", "Porcentagem_split": "10"}, {"login_split": "email2@example.com", "Porcentagem_split": "20"}] |
Este endpoint realiza o envio de um pagamento via Pix. Para utilizá-lo, deve ser efetuada uma chamada para a API conforme especificado abaixo:
A chamada deverá ser feita utilizando o método POST.
https://api.gerapix.digital/v1/pix/payments/
Para consumir este endpoint, é obrigatório incluir no cabeçalho da requisição HTTP um token de autenticação no formato.
Bearer
Este token é único por cliente e permite que a plataforma valide e autorize a requisição.
Na GeraPix, cada cliente possui dois tipos de token: público e secreto. Para esse endpoint, é obrigatório utilizar o token secreto.
Authorization: Bearer SEU_TOKEN_AQUI Content-Type: application/json
Nota: Substitua SEU_TOKEN_SECRETO
pelo seu token secreto, disponível no painel administrativo da GeraPix.
401 Unauthorized
Parâmetro | Tipo | Descrição | Exemplo |
---|---|---|---|
valor
(obrigatório)
|
string | Valor da cobrança em reais. Deve ser informado como número decimal utilizando ponto como separador decimal (formato float com ponto) | 49.90 |
nome
(obrigatório)
|
string
Até 100 caracteres
|
Nome completo do pagador. Deve conter pelo menos nome e sobrenome e ter no máximo 100 caracteres | João Silva |
doc_tipo
(obrigatório)
|
string
Até 4 caracteres
|
Tipo de documento do pagador. Deve ser informado como cpf ou cnpj (somente letras minúsculas) | cpf |
doc_numero
(obrigatório)
|
string
Até 14 caracteres
|
Número do documento do pagador. Deve conter apenas números, sem pontos, traços ou barras. Utilize CPF (11 dígitos) ou CNPJ (14 dígitos), de acordo com o doc_tipo | 12345678901 (CPF) ou 12345678000199 (CNPJ) |
callback_url
(obrigatório)
|
string
Até 100 caracteres
|
URL para envio de notificação de pagamento | https://seusite.com/callback |
external_reference
(opcional)
|
string
Até 100 caracteres
|
Identificador externo da cobrança. Pode ser usado para associar o pagamento a um pedido, usuário ou qualquer controle interno do sistema | pedido_12345 |
{
"valor": "49.90",
"nome": "João Silva",
"doc_tipo": "cpf",
"doc_numero": "12345678901",
"callback_url": "https://seusite.com/callback",
"external_reference": "pedido_12345"
}
Após a chamada, é retornado um JSON com o status 201 - Created caso o procedimento tenha ocorrido com sucesso.
{
"id_transacao": "91000186601",
"external_reference": "pedido_12345",
"status": "Aprovado"
}
Código | Parâmetro | Motivo | Inválido |
---|---|---|---|
ERR001 | valor | O valor informado está no formato incorreto ou é inferior ao valor mínimo aceito de 10.00 | Exemplo inválido: 49,90 (use ponto como separador decimal) |
ERR002 | valor | Saldo insuficiente para cobrir o valor solicitado, considerando taxas fixa e variável | Exemplo inválido: Valor total (R$52.37) maior que saldo disponível (R$50.00) |
ERR003 | nome | Nome deve conter pelo menos o primeiro nome e sobrenome, e não pode ultrapassar 100 caracteres | Exemplo inválido: João (faltando sobrenome) |
ERR004 | doc_tipo | Tipo de documento deve ser "cpf" ou "cnpj", com letras minúsculas | Exemplo inválido: CPF (erro no tipo de documento, deve ser cpf em minúsculo) |
ERR005 | doc_numero | O número do documento deve conter apenas números, sem pontos ou traços. O número deve ser de um CPF (11 dígitos) ou CNPJ (14 dígitos), de acordo com o tipo de documento | Exemplo inválido: 123.456.789-01 (formato incorreto para CPF, deve remover pontos e traços) |
ERR006 | callback_url | A URL fornecida para o callback está em um formato inválido ou não é acessível | Exemplo inválido: https://seusite (URL incompleta) |
ERR007 | external_reference | Se fornecido, o identificador externo deve ser único e estar no formato correto | Exemplo inválido: pedido_12345! (caracteres especiais não permitidos) |
A GeraPix utiliza este endpoint para enviar notificações automáticas (webhook) ao seu sistema sempre que houver uma atualização no status de uma transação Pix — seja uma cobrança recebida ou um envio de pagamento. A URL de notificação (callback_url) é definida no momento da criação da transação, tanto para cobranças quanto para envios.
A chamada deverá ser feita utilizando o método POST.
Para garantir a segurança, é obrigatório validar o token de autenticação enviado no cabeçalho da requisição no formato:
Bearer
Esse token permite confirmar que a requisição foi realmente enviada pela plataforma GeraPix.
Na GeraPix, cada cliente possui dois tipos de token: público e secreto. Para validação do webhook, deve-se utilizar o token secreto.
Authorization: Bearer SEU_TOKEN_SECRETO Content-Type: application/json
Nota: Substitua SEU_TOKEN_SECRETO
pelo token secreto disponível no painel administrativo da GeraPix.
401 Unauthorized
Parâmetro | Tipo | Descrição | Exemplo |
---|---|---|---|
id_transacao | string | Identificador único da transação Pix gerado pela GeraPix | f3d28968-78ad-488b-9e86-398b0653f845 |
status | string | Status atualizado da transação Pix. Exemplo de valor retornado: Aprovado para confirmação de pagamento ou recebimento. |
Aprovado |
external_reference | string | Referência externa enviada por você ao criar a cobrança | pedido_12345 |
{
"id_transacao": "91000186601",
"status": "Aprovado",
"external_reference": "pedido_12345"
}
application/json
200 OK
para confirmar o recebimento.Código | Descrição | Solução |
---|---|---|
401 | Unauthorized | Verifique se o token de autenticação está correto e ativo |
400 | Bad Request | O corpo da requisição está com estrutura inválida ou faltando campos obrigatórios |
500 | Internal Server Error | Erro interno no servidor que recebeu o webhook. Verifique os logs da sua aplicação |
Timeout | Sem resposta do seu servidor | Certifique-se de que sua URL está acessível publicamente e responde rapidamente (recomenda-se menos de 2 segundos) |