@pague-dev/sdk-node 1.1.0 → 1.3.0

package/README.md

@@ -46,7 +46,13 @@ await pdev.withdrawals.create({ amount, bankAccountId });
 await pdev.transactions.get(id);
 
 // Webhooks
-import { parseWebhook } from '@pague-dev/sdk-node';
+import { verifyWebhookSignature, parseWebhook } from '@pague-dev/sdk-node';
+
+const signature = req.headers['x-webhook-signature'] as string;
+if (!verifyWebhookSignature(req.body, signature, 'your_webhook_secret')) {
+  return res.status(401).send('Invalid signature');
+}
+
 const event = parseWebhook(req.body);
 ```
 
@@ -58,7 +64,7 @@ const event = parseWebhook(req.body);
 - **Projects** - Organização por projetos
 - **Withdrawals** - Saques via PIX (avulso ou conta salva)
 - **Transactions** - Consulta de transações
-- **Webhooks** - Notificações em tempo real
+- **Webhooks** - Verificação de assinatura e parsing de eventos
 
 ## Exemplo
 

package/dist/index.cjs

@@ -1,5 +1,17 @@
 let node_crypto = require("node:crypto");
 
+//#region src/account/account.ts
+var Account = class {
+	endpoint = "/account";
+	constructor(pdev) {
+		this.pdev = pdev;
+	}
+	async get() {
+		return this.pdev.get(this.endpoint);
+	}
+};
+
+//#endregion
 //#region src/common/utils/build-pagination-query.ts
 function buildPaginationQuery(options) {
 	const searchParams = new URLSearchParams();
@@ -110,6 +122,7 @@ var Pdev = class {
 	key;
 	baseUrl;
 	headers;
+	account;
 	pix;
 	customers;
 	projects;
@@ -127,6 +140,7 @@ var Pdev = class {
 			"X-API-Key": this.key,
 			"Content-Type": "application/json"
 		});
+		this.account = new Account(this);
 		this.pix = new Pix(this);
 		this.customers = new Customers(this);
 		this.projects = new Projects(this);
@@ -209,6 +223,7 @@ function isValidWebhookEvent(event) {
 	if (typeof obj.data !== "object" || obj.data === null) return false;
 	return [
 		"payment_completed",
+		"payment_expired",
 		"refund_completed",
 		"withdrawal_completed",
 		"withdrawal_failed"

package/dist/index.d.cts

@@ -1,3 +1,36 @@
+//#region src/account/interfaces/account-info.interface.d.ts
+type AccountStatus = 'approved' | 'pending' | 'pending_documents' | 'pending_approval' | 'rejected' | 'suspended';
+type CompanyStatus = 'pending' | 'active' | 'suspended' | 'blocked';
+interface BalanceAmount {
+  amount: number;
+  amountFormatted: number;
+}
+interface AccountDetail {
+  id: string;
+  status: AccountStatus;
+}
+interface CompanyDetail {
+  razaoSocial: string;
+  nomeFantasia?: string;
+  cnpj: string;
+  email: string;
+  phone: string;
+  status: CompanyStatus;
+}
+interface BalanceDetail {
+  available: BalanceAmount;
+  promotional: BalanceAmount;
+  held: BalanceAmount;
+  total: BalanceAmount;
+  currency: string;
+  updatedAt: string;
+}
+interface AccountInfo {
+  account: AccountDetail;
+  company: CompanyDetail | null;
+  balance: BalanceDetail;
+}
+//#endregion
 //#region src/charges/interfaces/charge.interface.d.ts
 type ChargeStatus = 'active' | 'expired' | 'disabled' | 'paid';
 type PaymentMethod = 'pix' | 'credit_card' | 'boleto';
@@ -108,6 +141,14 @@ interface ListCustomersOptions extends PaginationOptions {
 }
 type ListCustomersResponse = Response<PaginatedResponse<Customer>>;
 //#endregion
+//#region src/account/account.d.ts
+declare class Account {
+  private readonly pdev;
+  private readonly endpoint;
+  constructor(pdev: Pdev);
+  get(): Promise<Response<AccountInfo>>;
+}
+//#endregion
 //#region src/common/base-resource.d.ts
 /**
  * Base class for API resources that follow CRUD patterns.
@@ -326,6 +367,7 @@ declare class Pdev {
   readonly key: string;
   private readonly baseUrl;
   private readonly headers;
+  readonly account: Account;
   readonly pix: Pix;
   readonly customers: Customers;
   readonly projects: Projects;
@@ -343,7 +385,7 @@ declare class Pdev {
 /**
  * Available webhook event types
  */
-type WebhookEventType = 'payment_completed' | 'refund_completed' | 'withdrawal_completed' | 'withdrawal_failed';
+type WebhookEventType = 'payment_completed' | 'payment_expired' | 'refund_completed' | 'withdrawal_completed' | 'withdrawal_failed';
 /**
  * Base webhook payload structure
  */
@@ -384,6 +426,27 @@ interface PaymentCompletedData {
   /** Custom metadata passed when creating the payment */
   metadata?: Record<string, unknown>;
 }
+/**
+ * Data payload for payment_expired event
+ */
+interface PaymentExpiredData {
+  /** Transaction identifier */
+  transactionId: string;
+  /** Payment amount */
+  amount: number;
+  /** Currency code (e.g., "BRL") */
+  currency: string;
+  /** Payment method used (e.g., "pix") */
+  paymentMethod: string;
+  /** Payment status */
+  status: 'expired';
+  /** ISO 8601 timestamp of when payment expired */
+  expiredAt: string;
+  /** Your external reference ID (optional) */
+  externalReference?: string;
+  /** Custom metadata passed when creating the payment */
+  metadata?: Record<string, unknown>;
+}
 /**
  * Data payload for refund_completed event
  */
@@ -461,6 +524,10 @@ interface WithdrawalFailedData {
  * Payment completed webhook event
  */
 type PaymentCompletedEvent = WebhookPayload<'payment_completed', PaymentCompletedData>;
+/**
+ * Payment expired webhook event
+ */
+type PaymentExpiredEvent = WebhookPayload<'payment_expired', PaymentExpiredData>;
 /**
  * Refund completed webhook event
  */
@@ -476,7 +543,7 @@ type WithdrawalFailedEvent = WebhookPayload<'withdrawal_failed', WithdrawalFaile
 /**
  * Union type of all possible webhook events
  */
-type WebhookEvent = PaymentCompletedEvent | RefundCompletedEvent | WithdrawalCompletedEvent | WithdrawalFailedEvent;
+type WebhookEvent = PaymentCompletedEvent | PaymentExpiredEvent | RefundCompletedEvent | WithdrawalCompletedEvent | WithdrawalFailedEvent;
 /**
  * Webhook headers sent with each request
  */
@@ -566,4 +633,4 @@ interface WebhookHeaders {
 declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
 declare function parseWebhook(payload: string): WebhookEvent | null;
 //#endregion
-export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, CreateStaticQrCodeOptions, CreateStaticQrCodeResponse, CreateWithdrawalOptions, CreateWithdrawalResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentMethod, Pdev, PixCharge, PixKeyType, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, StaticQrCode, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, Withdrawal, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, WithdrawalStatus, parseWebhook, verifyWebhookSignature };
+export { AccountDetail, AccountInfo, AccountStatus, BalanceAmount, BalanceDetail, Charge, ChargeStatus, CompanyDetail, CompanyStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, CreateStaticQrCodeOptions, CreateStaticQrCodeResponse, CreateWithdrawalOptions, CreateWithdrawalResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentExpiredData, PaymentExpiredEvent, PaymentMethod, Pdev, PixCharge, PixKeyType, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, StaticQrCode, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, Withdrawal, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, WithdrawalStatus, parseWebhook, verifyWebhookSignature };

package/dist/index.d.mts

@@ -1,3 +1,36 @@
+//#region src/account/interfaces/account-info.interface.d.ts
+type AccountStatus = 'approved' | 'pending' | 'pending_documents' | 'pending_approval' | 'rejected' | 'suspended';
+type CompanyStatus = 'pending' | 'active' | 'suspended' | 'blocked';
+interface BalanceAmount {
+  amount: number;
+  amountFormatted: number;
+}
+interface AccountDetail {
+  id: string;
+  status: AccountStatus;
+}
+interface CompanyDetail {
+  razaoSocial: string;
+  nomeFantasia?: string;
+  cnpj: string;
+  email: string;
+  phone: string;
+  status: CompanyStatus;
+}
+interface BalanceDetail {
+  available: BalanceAmount;
+  promotional: BalanceAmount;
+  held: BalanceAmount;
+  total: BalanceAmount;
+  currency: string;
+  updatedAt: string;
+}
+interface AccountInfo {
+  account: AccountDetail;
+  company: CompanyDetail | null;
+  balance: BalanceDetail;
+}
+//#endregion
 //#region src/charges/interfaces/charge.interface.d.ts
 type ChargeStatus = 'active' | 'expired' | 'disabled' | 'paid';
 type PaymentMethod = 'pix' | 'credit_card' | 'boleto';
@@ -108,6 +141,14 @@ interface ListCustomersOptions extends PaginationOptions {
 }
 type ListCustomersResponse = Response<PaginatedResponse<Customer>>;
 //#endregion
+//#region src/account/account.d.ts
+declare class Account {
+  private readonly pdev;
+  private readonly endpoint;
+  constructor(pdev: Pdev);
+  get(): Promise<Response<AccountInfo>>;
+}
+//#endregion
 //#region src/common/base-resource.d.ts
 /**
  * Base class for API resources that follow CRUD patterns.
@@ -326,6 +367,7 @@ declare class Pdev {
   readonly key: string;
   private readonly baseUrl;
   private readonly headers;
+  readonly account: Account;
   readonly pix: Pix;
   readonly customers: Customers;
   readonly projects: Projects;
@@ -343,7 +385,7 @@ declare class Pdev {
 /**
  * Available webhook event types
  */
-type WebhookEventType = 'payment_completed' | 'refund_completed' | 'withdrawal_completed' | 'withdrawal_failed';
+type WebhookEventType = 'payment_completed' | 'payment_expired' | 'refund_completed' | 'withdrawal_completed' | 'withdrawal_failed';
 /**
  * Base webhook payload structure
  */
@@ -384,6 +426,27 @@ interface PaymentCompletedData {
   /** Custom metadata passed when creating the payment */
   metadata?: Record<string, unknown>;
 }
+/**
+ * Data payload for payment_expired event
+ */
+interface PaymentExpiredData {
+  /** Transaction identifier */
+  transactionId: string;
+  /** Payment amount */
+  amount: number;
+  /** Currency code (e.g., "BRL") */
+  currency: string;
+  /** Payment method used (e.g., "pix") */
+  paymentMethod: string;
+  /** Payment status */
+  status: 'expired';
+  /** ISO 8601 timestamp of when payment expired */
+  expiredAt: string;
+  /** Your external reference ID (optional) */
+  externalReference?: string;
+  /** Custom metadata passed when creating the payment */
+  metadata?: Record<string, unknown>;
+}
 /**
  * Data payload for refund_completed event
  */
@@ -461,6 +524,10 @@ interface WithdrawalFailedData {
  * Payment completed webhook event
  */
 type PaymentCompletedEvent = WebhookPayload<'payment_completed', PaymentCompletedData>;
+/**
+ * Payment expired webhook event
+ */
+type PaymentExpiredEvent = WebhookPayload<'payment_expired', PaymentExpiredData>;
 /**
  * Refund completed webhook event
  */
@@ -476,7 +543,7 @@ type WithdrawalFailedEvent = WebhookPayload<'withdrawal_failed', WithdrawalFaile
 /**
  * Union type of all possible webhook events
  */
-type WebhookEvent = PaymentCompletedEvent | RefundCompletedEvent | WithdrawalCompletedEvent | WithdrawalFailedEvent;
+type WebhookEvent = PaymentCompletedEvent | PaymentExpiredEvent | RefundCompletedEvent | WithdrawalCompletedEvent | WithdrawalFailedEvent;
 /**
  * Webhook headers sent with each request
  */
@@ -566,4 +633,4 @@ interface WebhookHeaders {
 declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
 declare function parseWebhook(payload: string): WebhookEvent | null;
 //#endregion
-export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, CreateStaticQrCodeOptions, CreateStaticQrCodeResponse, CreateWithdrawalOptions, CreateWithdrawalResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentMethod, Pdev, PixCharge, PixKeyType, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, StaticQrCode, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, Withdrawal, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, WithdrawalStatus, parseWebhook, verifyWebhookSignature };
+export { AccountDetail, AccountInfo, AccountStatus, BalanceAmount, BalanceDetail, Charge, ChargeStatus, CompanyDetail, CompanyStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, CreateStaticQrCodeOptions, CreateStaticQrCodeResponse, CreateWithdrawalOptions, CreateWithdrawalResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentExpiredData, PaymentExpiredEvent, PaymentMethod, Pdev, PixCharge, PixKeyType, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, StaticQrCode, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, Withdrawal, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, WithdrawalStatus, parseWebhook, verifyWebhookSignature };

package/dist/index.mjs

@@ -1,5 +1,17 @@
 import { createHash, createHmac, timingSafeEqual } from "node:crypto";
 
+//#region src/account/account.ts
+var Account = class {
+	endpoint = "/account";
+	constructor(pdev) {
+		this.pdev = pdev;
+	}
+	async get() {
+		return this.pdev.get(this.endpoint);
+	}
+};
+
+//#endregion
 //#region src/common/utils/build-pagination-query.ts
 function buildPaginationQuery(options) {
 	const searchParams = new URLSearchParams();
@@ -110,6 +122,7 @@ var Pdev = class {
 	key;
 	baseUrl;
 	headers;
+	account;
 	pix;
 	customers;
 	projects;
@@ -127,6 +140,7 @@ var Pdev = class {
 			"X-API-Key": this.key,
 			"Content-Type": "application/json"
 		});
+		this.account = new Account(this);
 		this.pix = new Pix(this);
 		this.customers = new Customers(this);
 		this.projects = new Projects(this);
@@ -209,6 +223,7 @@ function isValidWebhookEvent(event) {
 	if (typeof obj.data !== "object" || obj.data === null) return false;
 	return [
 		"payment_completed",
+		"payment_expired",
 		"refund_completed",
 		"withdrawal_completed",
 		"withdrawal_failed"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pague-dev/sdk-node",
-  "version": "1.1.0",
+  "version": "1.3.0",
   "description": "Node.js SDK for the pague.dev API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",