API - Gerar PIX

Gere QR Codes PIX dinâmicos para recebimento de pagamentos em sua aplicação.

Introdução

Esta API permite a geração de QR Codes PIX dinâmicos para recebimento de pagamentos. O QR Code gerado tem validade de 30 minutos e pode ser utilizado em qualquer aplicativo de pagamento que suporte PIX.

Exemplo de Implementação

$apiUrl = 'https://app.jeqcash.com/v3/pix/qrcode'; $postData = [ '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://seudominio.com/callback' ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $apiUrl); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData)); curl_setopt($ch, CURLOPT_HTTPHEADER, [ 'Content-Type: application/x-www-form-urlencoded', ]); $response = curl_exec($ch); curl_close($ch);

Parâmetros

Parâmetro Tipo Descrição
client_id String Identificação única do cliente
client_secret String Chave secreta para autenticação
nome String Nome completo do pagador
cpf String CPF do pagador (apenas números)
valor Decimal Valor da transação (ex: 100.00)
descricao String Descrição do pagamento (máx. 50 caracteres)
urlnoty String URL para receber notificações de pagamento

Respostas da API

Sucesso (200)
{ "transactionId": "4392d1d7e408d3cec04fm1zf3gv7vkq1", "status": "PENDING", "amount": 15, "calendar": { "expiration": 3000, "dueDate": "2024-10-07 04:41:05" }, "debtor": { "name": "Lucas Hernandes", "document": "80091794005" }, "qrcode": "00020126850014br.gov.bcb.pix2563pix.voluti.com.br/qr/v3/at/6ed39bf2-bdc2-42b8-a95b-13d2212146b25204000053039865802BR5925JeqCash PAYMENTS SOLUTIONS LTD6008SALVADOR62070503***63048D9B" }
Erro (401)
{ "statusCode": 401, "message": "Erro de autorização" }

API - Transferência PIX

Realize transferências PIX entre contas de forma programática.

Introdução

Esta API permite realizar transferências PIX para qualquer chave PIX cadastrada no sistema. As transferências são processadas em tempo real quando dentro do horário bancário.

Exemplo de Implementação

$apiUrl = 'https://app.jeqcash.com/v3/pix/payment'; $postData = [ 'client_id' => 'SEU CLIENT ID', 'client_secret' => 'SEU CLIENT SECRET', 'nome' => 'Nome do cliente', 'cpf' => 'Cpf do cliente', 'valor' => 1.00, 'chave_pix' => 'Chave pix Cliente', 'urlnoty' => 'https://seudominio.com/callback' ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $apiUrl); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($postData)); curl_setopt($ch, CURLOPT_HTTPHEADER, [ 'Content-Type: application/x-www-form-urlencoded', ]); $response = curl_exec($ch); curl_close($ch);

Parâmetros

Parâmetro Tipo Descrição
client_id String Identificação única do cliente
client_secret String Chave secreta para autenticação
nome String Nome completo do pagador
cpf String CPF do pagador (apenas números)
valor Decimal Valor da transferência (ex: 1.00)
chave_pix String Chave PIX do destinatário (CPF, email, telefone ou chave aleatória)
urlnoty String URL para receber notificações de transferência

Respostas da API

Sucesso (200)
[{ "statusCode": 200, "message": "Saque PIX processado com sucesso" }]
Erro (400)
{ "statusCode": 400, "message": "Saldo insuficiente para cobrir valor e taxas." }

Webhook - Pagamento Recebido

Receba notificações em tempo real quando um pagamento PIX for confirmado.

Estrutura do Webhook

Quando um pagamento PIX for confirmado, nosso sistema enviará uma requisição POST para o urlnoty informado com os seguintes dados:

{ "requestBody": { "transactionType": "RECEIVEPIX", "transactionId": "c327ce8bee2a18565ec2m1zdu6px2keu", "external_id": "55aefd02e54e785fbb5a80faa19f8802", "amount": 15.00, "paymentType": "PIX", "status": "PAID", "dateApproval": "2024-10-07 16:07:10", "creditParty": { "name": "Lucas Hernandes", "email": "suporte@app.jeqcash.com", "taxId": "999999999" }, "debitParty": { "bank": "JeqCash SOLUCOES DE PAGAMENTOS LTDA", "taxId": "46872831000154" } } }

Campos do Webhook

Campo Tipo Descrição
transactionType String Tipo de transação (RECEIVEPIX para pagamentos recebidos)
transactionId String ID único da transação em nosso sistema
external_id String ID externo (opcional) que você pode usar para referência
amount Decimal Valor do pagamento
status String Status do pagamento (PAID para confirmado)
dateApproval String Data e hora da confirmação do pagamento

Webhook - Transferência Concluída

Receba notificações quando uma transferência PIX for concluída.

Estrutura do Webhook

Quando uma transferência PIX for concluída, nosso sistema enviará uma requisição POST para o urlnoty informado com os seguintes dados:

{ "transactionType": "PAYMENT", "transactionId": "798176179", "external_id": "ebceb2b835598ccad73ce42eb5etrh2m5", "amount": 1, "dateApproval": "2024-12-19 17:10:54", "statusCode": { "statusId": 1, "description": "Pagamento aprovado" } }

Campos do Webhook

Campo Tipo Descrição
transactionType String Tipo de transação (PAYMENT para transferências enviadas)
transactionId String ID único da transação em nosso sistema
external_id String ID externo (opcional) que você pode usar para referência
amount Decimal Valor da transferência
dateApproval String Data e hora da conclusão da transferência
statusCode Object Contém o status e descrição da transferência