Documentação
VizzerPay Integração API
Gerar Pix QRcode
Abaixo está um exemplo de requisição para integrar-se à API da VizzerPay.
Endpoint
https://api.vizzerpay.com/v3/pix/qrcode
Exemplo de Requisição
{
'client_id' => 'seu_client_id',
'client_secret' => 'seu_client_secret',
'nome' => 'Nome do Cliente',
'cpf' => 'CPF do Cliente',
'valor' => 100.00,
'descricao' => 'Descrição do pagamento',
'urlnoty' => 'https://seuservidor.com/webhook'
}
Respostas da API
Abaixo estão exemplos de respostas que a API pode retornar com base no status da requisição.
Requisição bem-sucedida. A operação foi concluída sem erros.
{
{
"status": 200,
"body": {
"statusCode": 200,
"message": "QR Code gerado com sucesso.",
"qrcode": "00020126870014br.gov.bcb.pix2565pix.vizzerpay.com/qr/v3/at/cbe9aea5-ea38-4675-9b1d-1bb9085cea725204000053039865802BR5925NEXUS TECH INTERMEDIACOES6008CRICIUMA62070503***63040DA2",
"reference_code": "391a74417845ac91c1773b9cdc91c1"
}
A requisição enviada contém erros nos parâmetros.
{
"status": "erro",
"mensagem": "Parâmetros inválidos. Verifique a documentação.",
"erros": {
"parametro_faltando": "O campo 'valor' é obrigatório"
}
}
Falha na autenticação. O acesso está ausente ou inválido.
{
"status": "erro",
"mensagem": "Não autorizado. Verifique sua chave de API."
}
Gerar Pagamentos
Abaixo está um exemplo de requisição para integrar-se à API da VizzerPay.
Endpoint
https://api.vizzerpay.com/v3/pix/payment
Exemplo de Requisição
{
'client_id' => 'seu_client_id',
'client_secret' => 'seu_client_secret',
'nome' => 'Nome do Cliente',
'cpf' => 'CPF do Cliente',
'valor' => 100.00,
'type_key' => email, / pode ser usado: ( cpf, cnpj, email, telefone, token )
'chave_pix' => 'Chave pix Cliente',
'descricao' => 'Descrição do pagamento',
'urlnoty' => 'https://seuservidor.com/webhook'
}
Respostas da API
Abaixo estão exemplos de respostas que a API pode retornar com base no status da requisição.
Requisição bem-sucedida. A operação foi concluída sem erros.
{
{
"status": 200,
"requestBody": {
"transactionType": "RECEIVEPIX",
"transactionId": "c327ce8bee2a18565ec2m1zdu6px2keu",
"external_id": "55aefd02e54e785fbb5a80faa19f8802",
"amount": 15.00,
"paymentType": "PIX",
"status": "PAID",
"dateApproval": "2024-10-07 16:07:10",
"creditParty": {
"name": "Henrique silva",
"email": "billiPagamentos@gmail.com",
"taxId": "999999999"
},
"debitParty": {
"bank": "VIZZERPAY SOLUCOES DE PAGAMENTOS LTDA",
"taxId": "46872831000154"
}
A requisição enviada contém erros nos parâmetros.
{
"status": "erro",
"mensagem": "Parâmetros inválidos. Verifique a documentação.",
"erros": {
"parametro_faltando": "O campo 'valor' é obrigatório"
}
}
Falha na autenticação. O acesso está ausente ou inválido.
{
"status": "erro",
"mensagem": "Não autorizado. Verifique sua chave de API."
}
Para consultar o status de uma transação, faça uma requisição GET ou POST para o endpoint abaixo, enviando o reference_code da transação como parâmetro ID.
GET
https://api.vizzerpay.com/libs/consult/transaction_status?id={reference_code}
POST
https://api.vizzerpay.com/libs/consult/transaction_status
Content-Type: application/json
{
"id": "{reference_code}"
}
Respostas da API
Abaixo estão exemplos de respostas que a API pode retornar com base no status da requisição.
Requisição bem-sucedida. A operação foi concluída sem erros.
Nota: 'reference_code' e 'external_id' sempre vão ter o mesmo valor.
Status alternativos: PAID, PENDING, CANCELED.
{ "Bank": "VizzerPay", "data": { "external_id": "123456", "status": "PAID", "amount": "100.00", "confirmed_date": "2025-03-13 12:00:00", "postback_url": "https://seusite.com/webhook" } }
As respostas com Status de transação são enviados automaticamente para o Webhook definido no momento da requisição no campo 'urlnoty'
Respostas da API
Abaixo estão exemplos de respostas que a API pode retornar com base no status da transação.
Será lhe enviado um alerta por meio de um Webhook assim que o pagamento for confirmado pelo nosso sistema, segue abaixo o modelo JSON do payload enviado:
{
"value_cents": 100, // valor em centavos
"reference_code": "842a02b29f42e69c356dc0289fbd3c",
"external_reference": null,
"content": "00020126870014br.gov.bcb.pix2565pix.vizzerpay.com\/qr\/v3\/at\/d78407e6-b6c1-473f-a711-64a9807a1ed55204000053039865802BR5925NEXUS TECH INTERMEDIACOES6008CRICIUMA62070503***63047A1E",
"status": "paid",
"generator_name": null,
"generator_document": null,
"payer_name": "FERNANDO LIMA",
"payer_document": "52140535000140",
"registration_date": "2025-02-26T09:31:54.000-03:00",
"payment_date": "2025-02-26T09:34:59.000-03:00",
"end_to_end": "E18189547202502261234xUd3OxHAfST"
}
Respostas da API
Abaixo estão exemplos de respostas que a API pode retornar com base no status da transação.
Será lhe enviado um alerta por meio de um Webhook assim que o pagamento for confirmado pelo nosso sistema, segue abaixo o modelo JSON do payload enviado:
{
"notification_type": "pix_payment",
"message": {
"value_cents": 1,
"reference_code": "P202306150000039870",
"idempotent_id": "TEST300523-05",
"pix_key": "09354532454",
"pix_key_type": "cpf",
"status": "paid",
"end_to_end": null,
"receiver_name": "FERNANDO LIMA",
"receiver_document": "00000000000",
"registration_date": "2023-06-15T09:49:52.000-03:00",
"payment_date": "2023-06-15T09:49:54.000-03:00",
"cancellation_date": null,
"cancellation_reason": null,
"receipt_url": null
},
"md5": "9b5b3e1e7659d81c406bd40a96c83294"
}