Criar pagamento
Gere uma cobrança Pix com QR Code dinâmico e Pix copia e cola.
Cria um pagamento Pix destinado ao CNPJ ou CPF informado.
POST /payments
Requer autenticação. Envie suas credenciais no header Authorization. Veja Autenticação.
Requisição
POST /payments
Content-Type: application/json
Authorization: Basic <suas_credenciais_em_base64>
{
"cnpj": "75.358.868/0001-67",
"value": "9.99",
"description": "Pagamento pedido #999"
}Parâmetros
Prop
Type
Envie exatamente um identificador de destino: cnpj ou cpf. Por padrão, a cobrança deve ficar entre 0.03 e 5000.00; esses limites podem ser ajustados por cliente pela Paggpix. Valores fora da faixa retornam 400.
O campo external_id permite tornar a criação idempotente. Se uma cobrança já existir para o mesmo external_id, a API retorna a cobrança existente em vez de criar uma duplicada.
Resposta
{
"pix_id": "ba5ce1d5cd58ff77d99b36cee2224e37",
"external_id": "6b912619-f8b5-46f9-b16a-872743f5ed50",
"pix_code": "00020126360014BR.GOV.BCB.PIX0114+55119999999995204000053039865406123.455802BR5908John Doe6009Petrolina62160512PAGAMENTO9996304B9FD",
"qrcode_image": "<base64>",
"value": "9.99",
"receivable_value": "9.50",
"paggpix_fee_percentage": "0.50",
"paggpix_fee_value": "0.50",
"partner_fee_percentage": "0.25",
"partner_fee_value": "0.25",
"customer": {
"account_id": "c719f255-c5cf-4c3d-ae85-bbb5171b0b06",
"customer_id": "c5aeee78-db32-45b1-9c88-cfbb87594730",
"cnpj": "63202882000198",
"cpf": null,
"bank_name": "JP Morgan",
"bank_account_number": "12345-6",
"pix_key": "a6d551de-e75b-4a9c-bb0c-512a5bea5ee5",
"pix_key_type": "RANDOM_KEY"
},
"created": "2024-01-01T00:00:00.000Z",
"expires": "2024-01-02T00:00:00.000Z"
}Pagamentos criados nascem com status ACTIVE, mas o campo status não é retornado nesta resposta. Para consultar o status atual, use Verificar pagamento ou acompanhe os Eventos de webhook.
O campo expires é definido automaticamente pela Paggpix e expira em até 2 horas após a criação do Pix. Para ajustar esse prazo, entre em contato com a Paggpix.
Campos da resposta
Prop
Type
Códigos de status
| Status | Descrição |
|---|---|
| 201 | Pagamento criado |
| 400 | Parâmetros inválidos ou ausentes |
| 401 | Não autenticado |
Exemplos
curl -X POST https://public-api.paggpix.com/payments \
-H "Content-Type: application/json" \
-H "Authorization: Basic <suas_credenciais_em_base64>" \
-d '{
"cnpj": "75.358.868/0001-67",
"value": "9.99",
"description": "Pagamento pedido #999"
}'const axios = require('axios');
const CLIENT_ID = '<seu_client_id>';
const CLIENT_SECRET = '<seu_client_secret>';
const CREDENTIALS = Buffer.from(`${CLIENT_ID}:${CLIENT_SECRET}`).toString('base64');
const BASE_URL = 'https://public-api.paggpix.com';
async function createPayment() {
try {
const { data } = await axios.post(
`${BASE_URL}/payments`,
{
cnpj: '75.358.868/0001-67',
value: '9.99',
description: 'Pagamento pedido #999',
},
{ headers: { Authorization: `Basic ${CREDENTIALS}` } },
);
console.log(`Created payment of ${data.value}. id = ${data.pix_id}, code = ${data.pix_code}`);
} catch (error) {
console.error(error.response ? error.response.data : error.message);
}
}