v2.5.0

What's Changed

Features

• withdrawals: add netAmount as alternative to amount on create (e5e73ba)

Full Changelog: v2.4.0...v2.5.0

v2.4.0

What's Changed

Features

• balance-blocks: add pdev.balanceBlocks.list() resource

Full Changelog: v2.3.0...v2.4.0

v2.3.0

Features

• transactions: add transactions.refund(id, options) endpoint for full payment refunds. Refunds are asynchronous — final confirmation arrives via the refund_completed webhook. Also extends TransactionType with adjustment for manual balance adjustment ledger entries.
• pix: CreateStaticQrCodeOptions now accepts expiresIn (seconds, defaults to 24h) and the response exposes expiresAt so callers can render expiry to the payer.
• withdrawals: add externalReference to CreateWithdrawalOptions and the Withdrawal response. Value is forwarded on withdrawal_completed / withdrawal_failed webhooks.
• webhooks: expose PSP-provided identification on event payloads:
  • PaymentCompletedData: e2eId, counterpartName, counterpartDocument
  • WithdrawalCompletedData / WithdrawalFailedData: externalReference, e2eId, counterpartName, counterpartDocument
  • BalanceBlockCreatedData / BalanceBlockApprovedData / BalanceBlockRejectedData: externalReference, e2eId

Docs

• pix: document that customerId and customer are mutually exclusive on CreatePixOptions, and that omitting both produces a static QR code (restricted to PSPs avista and mock).
• webhooks: clarify RefundCompletedData.netAmount semantics — it equals amount (value received by the customer); the refund fee is debited separately from the merchant balance.

Full Changelog: v2.2.0...v2.3.0

v2.2.0

What's New

Webhooks

• New event: balance_block_approved — triggered when a balance block is approved
• New event: balance_block_rejected — triggered when a balance block is rejected
• Added BalanceBlockApprovedData, BalanceBlockRejectedData, BalanceBlockApprovedEvent, BalanceBlockRejectedEvent types

Pix

• Updated createStaticQrCode test payload structure

Full Changelog: v2.1.0...v2.2.0

v2.1.0

What's New

• feat(webhooks): add balance_block_created event type — new webhook event for balance block notifications, including BalanceBlockCreatedData interface and BalanceBlockCreatedEvent type

Full Changelog: v2.0.0...v2.1.0

v2.0.0

Breaking Changes

• RefundCompletedData.completedAt renamed to refundedAt

Features

• Add withdrawal_reversed webhook event type with WithdrawalReversedData interface
• Add environment, feeAmount, netAmount fields to PaymentExpiredData
• Add paymentMethod, externalReference fields to RefundCompletedData

Migration Guide

Update any code referencing RefundCompletedData.completedAt to use refundedAt:

// Before
const completedAt = refundEvent.data.completedAt;

// After
const refundedAt = refundEvent.data.refundedAt;

v1.3.0

What's Changed

Features

• account: Add held balance field to BalanceDetail interface
• webhooks: Add payment_expired event type with PaymentExpiredData interface, validation, and tests

Full Changelog: v1.2.0...v1.3.0

v1.2.0

What's New

Features

• account: Add account info endpoint (GET /account) to retrieve account information

Documentation

• Update README to include webhook signature verification

Full Changelog: v1.1.0...v1.2.0

v1.1.0

What's New

Features

• webhooks: Add verifyWebhookSignature function for HMAC-SHA256 signature verification with timing-safe comparison

Docs

• Update README to include static QR code generation for PIX

Full Changelog: v1.0.0...v1.1.0

v1.0.0

v1.0.0 🎉

Primeiro release major do SDK!

⚠️ Breaking Changes

• pix: Simplificada a interface CreateStaticQrCodeOptions — removida a interface intermediária StaticQrCodeTransaction. Os campos amount, description e externalReference agora ficam diretamente em CreateStaticQrCodeOptions ao invés de aninhados sob transaction.

Antes:

pixClient.createStaticQrCode({
  transaction: { amount: 100, description: 'Test' },
});

Depois:

pixClient.createStaticQrCode({
  amount: 100,
  description: 'Test',
});

Full Changelog

v0.5.0...v1.0.0