Documentação: API Pix

Saiba como integrar nossa API em sua aplicação.

Logo

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://duspay.com.br/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://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 "seu_client_id"
client_secret Chave secreta do cliente "seu_client_secret"
nome Nome do pagador "João da Silva"
cpf CPF do pagador "12345678901"
valor Valor da transação 100.00
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:
{ "status": 200, "body": { "statusCode": 200, "message": "QR Code gerado com sucesso.", "qrcode": "00020126870014br.gov.bcb.pix2565pix.primepag.com.br/qr/v3/at/cbe9aea5-ea38-4675-9b1d-1bb9085cea725204000053039865802BR5925NEXUS TECH INTERMEDIACOES6008CRICIUMA62070503***63040DA2", "reference_code": "391a74417845ac91c1773b9cdc91c1" } }
Exemplo de Resposta 401:
{
"statusCode": 401,
"message": "Erro de autorizaçã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://duspay.com.br/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://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 "seu_client_id"
client_secret Chave secreta do cliente "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."}

Consulta de Status de Transação

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.

Método GET

GET https://duspay.com.br/libs/consult/transaction_status?id={reference_code}

Método POST

POST https://duspay.com.br/libs/consult/transaction_status Content-Type: application/json { "id": "{reference_code}" }

Exemplo de Código PHP

<?php // Método GET $reference_code = "123456"; // Código da transação $url = "https://duspay.com.br/libs/consult/transaction_status?id=" . urlencode($reference_code); $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, $url); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); $response = curl_exec($ch); curl_close($ch); echo $response; // Método POST $postData = [ "id" => $reference_code ]; $ch = curl_init(); curl_setopt($ch, CURLOPT_URL, "https://duspay.com.br/libs/consult/transaction_status"); curl_setopt($ch, CURLOPT_RETURNTRANSFER, true); curl_setopt($ch, CURLOPT_POST, true); curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($postData)); curl_setopt($ch, CURLOPT_HTTPHEADER, [ 'Content-Type: application/json', ]); $response = curl_exec($ch); curl_close($ch); echo $response; ?>

Respostas da API

Exemplo de Resposta - Sucesso (Status PAID):
{ "Bank": "DusPay", "data": { "external_id": "123456", "status": "PAID", "amount": "100.00", "confirmed_date": "2025-03-13 12:00:00", "postback_url": "https://seusite.com/webhook" } }

Nota: Os status possíveis são: PAID, PENDING, CANCELED.

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:
{ "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": "duspay@gmail.com", "taxId": "999999999" }, "debitParty": { "bank": "DusPay SOLUCOES DE PAGAMENTOS LTDA", "taxId": "46872831000154" } } }

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" } }

WEBHOOK-Evento de QR Code Pago

Será lhe enviado um alerta por meio de um Webhook assim que o pagamento for confirmado pelo nosso sistema:
{ "value_cents": 15000, "reference_code": "QRCODE123", "external_reference": "pedido-789", "content": { "item": "produto A" }, "status": "paid", "generator_name": "Loja Exemplo", "generator_document": "12.345.678/0001-90", "payer_name": "Cliente Silva", "payer_document": "123.456.789-00", "registration_date": "2025-05-08T14:00:00", "payment_date": "2025-05-08T14:05:00", "end_to_end": "XYZ987654321" }

WEBHOOK-Evento de Pagamento PIX

Será lhe enviado um alerta por meio de um Webhook assim que o pagamento for confirmado pelo nosso sistema:
{ "value_cents": 5000, "reference_code": "PIXPAY456", "external_reference": "pedido-321", "content": null, "status": "completed", "generator_name": "Cliente Silva", "generator_document": "123.456.789-00", "payer_name": "Loja Exemplo", "payer_document": "12.345.678/0001-90", "registration_date": "2025-05-08T15:00:00", "payment_date": "2025-05-08T15:02:00", "end_to_end": "ABC123XYZ789" }