@pague-dev/sdk-node 0.1.4 → 0.2.0

package/README.md

@@ -24,6 +24,8 @@ await pdev.pix.create({ amount, description, customer });
 
 // Charges
 await pdev.charges.create({ projectId, name, amount, paymentMethods });
+await pdev.charges.list({ page, limit });
+await pdev.charges.get(id);
 
 // Customers
 await pdev.customers.create({ name, document });

package/dist/index.cjs

@@ -197,8 +197,9 @@ function isValidWebhookEvent(event) {
 	if (typeof obj.data !== "object" || obj.data === null) return false;
 	return [
 		"payment_completed",
-		"payment_failed",
-		"refund_completed"
+		"refund_completed",
+		"withdrawal_completed",
+		"withdrawal_failed"
 	].includes(obj.event);
 }
 /**

package/dist/index.d.cts

@@ -282,7 +282,7 @@ declare class Pdev {
 /**
  * Available webhook event types
  */
-type WebhookEventType = 'payment_completed' | 'payment_failed' | 'refund_completed';
+type WebhookEventType = 'payment_completed' | 'refund_completed' | 'withdrawal_completed' | 'withdrawal_failed';
 /**
  * Base webhook payload structure
  */
@@ -316,25 +316,8 @@ interface PaymentCompletedData {
   status: 'completed';
   /** ISO 8601 timestamp of when payment was completed */
   completedAt: string;
-}
-/**
- * Data payload for payment_failed event
- */
-interface PaymentFailedData {
-  /** 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: 'failed';
-  /** ISO 8601 timestamp of when payment failed */
-  failedAt: string;
-  /** Reason for failure (e.g., "expired", "insufficient_funds") */
-  failureReason: string;
+  /** Your external reference ID (optional) */
+  externalReference?: string;
 }
 /**
  * Data payload for refund_completed event
@@ -346,31 +329,77 @@ interface RefundCompletedData {
   originalTransactionId: string;
   /** Refunded amount */
   amount: number;
-  /** Fees (typically 0 for refunds) */
+  /** Fees charged for the refund */
   feeAmount: number;
+  /** Net amount after fees */
+  netAmount: number;
   /** Currency code (e.g., "BRL") */
   currency: string;
   /** Refund status */
   status: 'completed';
   /** ISO 8601 timestamp of when refund was completed */
-  refundedAt: string;
+  completedAt: string;
 }
 /**
- * Payment completed webhook event
+ * Data payload for withdrawal_completed event
  */
-type PaymentCompletedEvent = WebhookPayload<'payment_completed', PaymentCompletedData>;
+interface WithdrawalCompletedData {
+  /** Withdrawal identifier */
+  withdrawalId: string;
+  /** Withdrawal amount */
+  amount: number;
+  /** Fees charged for the withdrawal */
+  feeAmount: number;
+  /** Net amount transferred (amount - feeAmount) */
+  netAmount: number;
+  /** Currency code (e.g., "BRL") */
+  currency: string;
+  /** Withdrawal status */
+  status: 'completed';
+  /** ISO 8601 timestamp of when withdrawal was completed */
+  completedAt: string;
+}
+/**
+ * Data payload for withdrawal_failed event
+ */
+interface WithdrawalFailedData {
+  /** Withdrawal identifier */
+  withdrawalId: string;
+  /** Withdrawal amount */
+  amount: number;
+  /** Fees that would have been charged */
+  feeAmount: number;
+  /** Net amount that would have been transferred */
+  netAmount: number;
+  /** Currency code (e.g., "BRL") */
+  currency: string;
+  /** Withdrawal status */
+  status: 'failed';
+  /** ISO 8601 timestamp of when withdrawal failed */
+  failedAt: string;
+  /** Reason for failure (e.g., "insufficient_funds", "invalid_account") */
+  failureReason: string;
+}
 /**
- * Payment failed webhook event
+ * Payment completed webhook event
  */
-type PaymentFailedEvent = WebhookPayload<'payment_failed', PaymentFailedData>;
+type PaymentCompletedEvent = WebhookPayload<'payment_completed', PaymentCompletedData>;
 /**
  * Refund completed webhook event
  */
 type RefundCompletedEvent = WebhookPayload<'refund_completed', RefundCompletedData>;
+/**
+ * Withdrawal completed webhook event
+ */
+type WithdrawalCompletedEvent = WebhookPayload<'withdrawal_completed', WithdrawalCompletedData>;
+/**
+ * Withdrawal failed webhook event
+ */
+type WithdrawalFailedEvent = WebhookPayload<'withdrawal_failed', WithdrawalFailedData>;
 /**
  * Union type of all possible webhook events
  */
-type WebhookEvent = PaymentCompletedEvent | PaymentFailedEvent | RefundCompletedEvent;
+type WebhookEvent = PaymentCompletedEvent | RefundCompletedEvent | WithdrawalCompletedEvent | WithdrawalFailedEvent;
 /**
  * Webhook headers sent with each request
  */
@@ -434,4 +463,4 @@ interface WebhookHeaders {
  */
 declare function parseWebhook(payload: string): WebhookEvent | null;
 //#endregion
-export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentFailedData, PaymentFailedEvent, PaymentMethod, Pdev, PixCharge, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, parseWebhook };
+export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentMethod, Pdev, PixCharge, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, parseWebhook };

package/dist/index.d.mts

@@ -282,7 +282,7 @@ declare class Pdev {
 /**
  * Available webhook event types
  */
-type WebhookEventType = 'payment_completed' | 'payment_failed' | 'refund_completed';
+type WebhookEventType = 'payment_completed' | 'refund_completed' | 'withdrawal_completed' | 'withdrawal_failed';
 /**
  * Base webhook payload structure
  */
@@ -316,25 +316,8 @@ interface PaymentCompletedData {
   status: 'completed';
   /** ISO 8601 timestamp of when payment was completed */
   completedAt: string;
-}
-/**
- * Data payload for payment_failed event
- */
-interface PaymentFailedData {
-  /** 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: 'failed';
-  /** ISO 8601 timestamp of when payment failed */
-  failedAt: string;
-  /** Reason for failure (e.g., "expired", "insufficient_funds") */
-  failureReason: string;
+  /** Your external reference ID (optional) */
+  externalReference?: string;
 }
 /**
  * Data payload for refund_completed event
@@ -346,31 +329,77 @@ interface RefundCompletedData {
   originalTransactionId: string;
   /** Refunded amount */
   amount: number;
-  /** Fees (typically 0 for refunds) */
+  /** Fees charged for the refund */
   feeAmount: number;
+  /** Net amount after fees */
+  netAmount: number;
   /** Currency code (e.g., "BRL") */
   currency: string;
   /** Refund status */
   status: 'completed';
   /** ISO 8601 timestamp of when refund was completed */
-  refundedAt: string;
+  completedAt: string;
 }
 /**
- * Payment completed webhook event
+ * Data payload for withdrawal_completed event
  */
-type PaymentCompletedEvent = WebhookPayload<'payment_completed', PaymentCompletedData>;
+interface WithdrawalCompletedData {
+  /** Withdrawal identifier */
+  withdrawalId: string;
+  /** Withdrawal amount */
+  amount: number;
+  /** Fees charged for the withdrawal */
+  feeAmount: number;
+  /** Net amount transferred (amount - feeAmount) */
+  netAmount: number;
+  /** Currency code (e.g., "BRL") */
+  currency: string;
+  /** Withdrawal status */
+  status: 'completed';
+  /** ISO 8601 timestamp of when withdrawal was completed */
+  completedAt: string;
+}
+/**
+ * Data payload for withdrawal_failed event
+ */
+interface WithdrawalFailedData {
+  /** Withdrawal identifier */
+  withdrawalId: string;
+  /** Withdrawal amount */
+  amount: number;
+  /** Fees that would have been charged */
+  feeAmount: number;
+  /** Net amount that would have been transferred */
+  netAmount: number;
+  /** Currency code (e.g., "BRL") */
+  currency: string;
+  /** Withdrawal status */
+  status: 'failed';
+  /** ISO 8601 timestamp of when withdrawal failed */
+  failedAt: string;
+  /** Reason for failure (e.g., "insufficient_funds", "invalid_account") */
+  failureReason: string;
+}
 /**
- * Payment failed webhook event
+ * Payment completed webhook event
  */
-type PaymentFailedEvent = WebhookPayload<'payment_failed', PaymentFailedData>;
+type PaymentCompletedEvent = WebhookPayload<'payment_completed', PaymentCompletedData>;
 /**
  * Refund completed webhook event
  */
 type RefundCompletedEvent = WebhookPayload<'refund_completed', RefundCompletedData>;
+/**
+ * Withdrawal completed webhook event
+ */
+type WithdrawalCompletedEvent = WebhookPayload<'withdrawal_completed', WithdrawalCompletedData>;
+/**
+ * Withdrawal failed webhook event
+ */
+type WithdrawalFailedEvent = WebhookPayload<'withdrawal_failed', WithdrawalFailedData>;
 /**
  * Union type of all possible webhook events
  */
-type WebhookEvent = PaymentCompletedEvent | PaymentFailedEvent | RefundCompletedEvent;
+type WebhookEvent = PaymentCompletedEvent | RefundCompletedEvent | WithdrawalCompletedEvent | WithdrawalFailedEvent;
 /**
  * Webhook headers sent with each request
  */
@@ -434,4 +463,4 @@ interface WebhookHeaders {
  */
 declare function parseWebhook(payload: string): WebhookEvent | null;
 //#endregion
-export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentFailedData, PaymentFailedEvent, PaymentMethod, Pdev, PixCharge, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, parseWebhook };
+export { Charge, ChargeStatus, CreateChargeOptions, CreateChargeResponse, CreateCustomerOptions, CreateCustomerResponse, CreatePixCustomer, CreatePixOptions, CreatePixResponse, CreateProjectOptions, CreateProjectResponse, Customer, DocumentType, type ErrorResponse, GetChargeResponse, GetTransactionResponse, ListChargesOptions, ListChargesResponse, ListCustomersOptions, ListCustomersResponse, ListProjectsOptions, ListProjectsResponse, NotificationType, type PaginatedResponse, type PaginationOptions, PaymentCompletedData, PaymentCompletedEvent, PaymentMethod, Pdev, PixCharge, PixStatus, Project, RefundCompletedData, RefundCompletedEvent, type Response, SortBy, SortOrder, Transaction, TransactionPaymentMethod, TransactionStatus, TransactionType, WebhookEvent, WebhookEventType, WebhookHeaders, WebhookPayload, WithdrawalCompletedData, WithdrawalCompletedEvent, WithdrawalFailedData, WithdrawalFailedEvent, parseWebhook };

package/dist/index.mjs

@@ -196,8 +196,9 @@ function isValidWebhookEvent(event) {
 	if (typeof obj.data !== "object" || obj.data === null) return false;
 	return [
 		"payment_completed",
-		"payment_failed",
-		"refund_completed"
+		"refund_completed",
+		"withdrawal_completed",
+		"withdrawal_failed"
 	].includes(obj.event);
 }
 /**

package/package.json

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