@pague-dev/sdk-node 1.2.0 → 1.3.0

package/dist/index.cjs

@@ -223,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

@@ -20,6 +20,7 @@ interface CompanyDetail {
 interface BalanceDetail {
   available: BalanceAmount;
   promotional: BalanceAmount;
+  held: BalanceAmount;
   total: BalanceAmount;
   currency: string;
   updatedAt: string;
@@ -384,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
  */
@@ -425,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
  */
@@ -502,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
  */
@@ -517,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
  */
@@ -607,4 +633,4 @@ interface WebhookHeaders {
 declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
 declare function parseWebhook(payload: string): WebhookEvent | null;
 //#endregion
-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, 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

@@ -20,6 +20,7 @@ interface CompanyDetail {
 interface BalanceDetail {
   available: BalanceAmount;
   promotional: BalanceAmount;
+  held: BalanceAmount;
   total: BalanceAmount;
   currency: string;
   updatedAt: string;
@@ -384,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
  */
@@ -425,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
  */
@@ -502,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
  */
@@ -517,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
  */
@@ -607,4 +633,4 @@ interface WebhookHeaders {
 declare function verifyWebhookSignature(payload: string, signature: string, secret: string): boolean;
 declare function parseWebhook(payload: string): WebhookEvent | null;
 //#endregion
-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, 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

@@ -223,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.2.0",
+  "version": "1.3.0",
   "description": "Node.js SDK for the pague.dev API",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",