Verificar pagamento

Retorna o estado mais recente do pagamento registrado pela Paggpix.

GET /payments/:pix_id/verify

Requer autenticação. Envie suas credenciais no header Authorization. Veja Autenticação.

Este é o único endpoint de pagamentos que retorna o campo status.

Requisição

GET /payments/{pix_id}/verify
Authorization: Basic <suas_credenciais_em_base64>

Parâmetros

Prop

Type

Resposta

{
  "status": "DONE",
  "value": "99.99",
  "paggpix_fee_percentage": "0.50",
  "paggpix_fee_value": "0.50",
  "partner_fee_percentage": "0.25",
  "partner_fee_value": "0.25",
  "receivable_value": "98.99",
  "created": "2024-01-01T00:00:00.000Z",
  "paid": "2024-01-01T12:00:00.000Z"
}

Campos da resposta

Prop

Type

O campo paid é retornado apenas quando o pagamento foi concluído.

Códigos de status

Status	Descrição
200	Verificação retornada com sucesso
401	Não autenticado
404	Pagamento não encontrado

Exemplos

curl https://public-api.paggpix.com/payments/{pix_id}/verify \
  -H "Authorization: Basic <suas_credenciais_em_base64>"

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 verifyPayment(pixId) {
  try {
    const { data } = await axios.get(`${BASE_URL}/payments/${pixId}/verify`, {
      headers: { Authorization: `Basic ${CREDENTIALS}` },
    });
    console.log(`Payment verification: status = ${data.status}, value = ${data.value}, created = ${data.created}${data.paid ? `, paid = ${data.paid}` : ''}`);
  } catch (error) {
    console.error(error.response ? error.response.data : error.message);
  }
}