Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Consultar chave, enviar Pix-out e obter comprovante
sk_...), Pix de saída não exige PIN. Valores em centavos.
https://api.upag.dev/v1). Em produção use https://api.upag.io/v1 com sk_live_….curl -X POST https://api.upag.dev/v1/transfers/lookup \
-H "Authorization: Bearer sk_test_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"type": "key",
"value": "55ce1aae-0d2b-4d76-bc77-294d6407349e"
}'
import { Upag } from 'upag';
const upag = new Upag('sk_test_your_api_key');
const lookup = await upag.transfers.lookup({
type: 'key',
value: '55ce1aae-0d2b-4d76-bc77-294d6407349e',
});
name e taxNumber antes de debitar.
curl -X POST https://api.upag.dev/v1/transfers \
-H "Authorization: Bearer sk_test_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"type": "key",
"pixKey": "55ce1aae-0d2b-4d76-bc77-294d6407349e",
"pixKeyType": "random",
"amount": 100,
"description": "Pagamento fornecedor"
}'
const transfer = await upag.transfers.create({
type: 'key',
pixKey: '55ce1aae-0d2b-4d76-bc77-294d6407349e',
pixKeyType: 'random',
amount: 100,
description: 'Pagamento fornecedor',
});
id da resposta. O status evolui até completed.
curl -X POST https://api.upag.dev/v1/transfers/lookup \
-H "Authorization: Bearer sk_test_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"type": "hash",
"value": "00020126580014br.gov.bcb.pix..."
}'
await upag.transfers.lookup({ type: 'hash', value: '00020126580014br.gov.bcb.pix...' });
const transfer = await upag.transfers.create({
type: 'hash',
hash: '00020126580014br.gov.bcb.pix...',
});
amount.
curl "https://api.upag.dev/v1/transfers/770e8400-e29b-41d4-a716-446655440000/receipt?format=image" \
-H "Authorization: Bearer sk_test_your_api_key"
const html = await upag.transfers.receipt('770e8400-e29b-41d4-a716-446655440000', {
format: 'image',
});
curl -X POST https://api.upag.dev/v1/webhooks \
-H "Authorization: Bearer sk_test_your_api_key" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/webhooks/upag",
"events": ["transfer.completed", "transfer.failed"]
}'
await upag.webhooks.create({
url: 'https://example.com/webhooks/upag',
events: ['transfer.completed', 'transfer.failed'],
});
app.post('/webhooks/upag', express.raw({ type: '*/*' }), (req, res) => {
const valid = upag.webhooks.validateSignature(
req.body,
req.headers['x-webhook-signature'],
process.env.UPAG_WEBHOOK_SECRET,
);
if (!valid) return res.sendStatus(401);
const { event, data } = JSON.parse(req.body.toString('utf8'));
if (event === 'transfer.completed') {
console.log('Pix enviado:', data.id, data.amount);
}
res.sendStatus(200);
});