Documentação PIX

Documentação: Gerar PIX

Saiba como utilizar o script para gerar PIX em sua aplicação.

Introdução

Este script permite a geração de um QR Code PIX utilizando um endpoint específico. É ideal para aplicações que precisam de integração com pagamentos via PIX.

Exemplo de Código

<?php $apiUrl = 'https://api.nupix.co/v2/pix/qrcode'; $postData = [ 'client_id' => 'seu_client_id', 'client_secret' => 'seu_client_secret', 'nome' => 'Nome do Cliente', 'reference_id' => 'ID gerado por você', 'cpf' => 'CPF do Cliente', 'valor' => 100.00, 'descricao' => 'Descrição do pagamento', 'urlnoty' => 'https://seuservidor.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); if (curl_errno($ch)) { echo 'Erro cURL: ' . curl_error($ch); } else { echo 'Resposta do servidor: ' . $response; } curl_close($ch); ?>

Parâmetros

Parâmetro Descrição Exemplo
client_id Identificação do cliente na "seu_client_id"
client_secret Chave secreta do cliente na "seu_client_secret"
nome Nome do pagador. "João da Silva"
cpf CPF do pagador. "12345678901"
valor Valor da transação. 100.00
reference_id ID gerado por você. "seu_reference"
descricao Descrição da transação. "Pagamento de serviços"
urlnoty URL para receber notificações de callback. "https://seuservidor.com/callback"

Respostas da API

Exemplo de Resposta 200:
{ "transaction_id": "778c2bdf-426f-439c-b090-13f66532511c", "amount": 100, "fee_amount": 4.29, "net_amount": 95.71, "pix": { "qr_code": "00020126860014br.gov.bcb.pix2564pix.ecomovi.com.br...", "payment_link": "pix.ecomovi.com.br\/qr\/v3\/at\/8fd441ae-ecb1-4fbf-8a79-4dfbbf2a21e2", "expires_at": "2025-04-05T14:08:14.248Z" }, "checkout_url": "https:\/\/pix.cashpag.com\/checkout-page\/v3.html....", "reference_code": "e88da9c1d44bb2039c3000cc621b347m8", "qrcode": "00020126860014br.gov.bcb.pix2564pix.ecomovi.com.br...", "reference_id": "1215478514" }
Exemplo de Resposta 401:
{
"statusCode": 401,
"message": "Erro de autorização"
}

Documentação: Transferência PIX

Saiba como utilizar o script para realizar transferências via PIX em sua aplicação.

Introdução

Este script permite a realização de uma transferência PIX entre contas utilizando um endpoint específico. Ideal para sistemas que necessitam de integração com a API PIX para realizar pagamentos e transferências.

Exemplo de Código

<?php
$apiUrl = 'https://api.nupix.co/v2/pix/payment';

$postData = [
'client_id' => 'juanfigueiredo_4703432954',
'client_secret' => '5969b5a5830625b35407e83bcb247ab7a7364480f522fafb5d8fde0232c95ff1',
'nome' => 'cris',
'cpf' => '11970142332',
'valor' => 1.00,
'chave_pix' => '11970142332',
'urlnoty' => 'https://seuservidor.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);

if (curl_errno($ch)) {
echo 'Erro cURL: ' . curl_error($ch);
} else {
echo 'Resposta do servidor: ' . $response;
}

curl_close($ch);
?>

Parâmetros

Parâmetro Descrição Exemplo
client_id Identificação do cliente na "seu_client_id"
client_secret Chave secreta do cliente na "seu_client_secret"
nome Nome do pagador. "cris"
cpf CPF do pagador. "11970142332"
valor Valor da transferência. 1.00
chave_pix Chave PIX do destinatário. "chave@pix.com"
urlnoty URL para receber notificações de callback. "https://seuservidor.com/callback"

Respostas da API

Exemplo de Resposta 200:
[{"statusCode":200,"message":"Saque PIX processado com sucesso"}]
Exemplo de Resposta 400:
{"statusCode":400,"message":"Saldo insuficiente para cobrir valor e taxas."}

WEBHOOK-Evento de Pagamento

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:
{ "event": "payment.success", "data": { "transaction_id": "d32dcdc8-48d5-4184-84a5-f00bc48e9f60", "amount": 5, "status": "completed", "paid_at": "2025-04-05T19:40:17.557Z", "payer_info": null, "end_to_end_id": null }, "timestamp": "2025-04-05T19:40:17.595Z", "reference_id": "1215478514", } }

WEBHOOK-Evento de Transferência

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:
{ "transactionType": "PAYMENT", "transactionId": "798176179", "external_id": "ebceb2b835598ccad73ce42eb5etrh2m5", "amount": 1, "dateApproval": "2024-12-19 17:10:54", "statusCode": { "statusId": 1, "description": "Pagamento aprovado" } }